本產品（
辦公安全平臺/2023-01-20）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
網絡準入
| API | 標題 | API概述 |
|---|---|---|
| ListNacUserCert | 批量查詢用戶入網證書狀態 | 入網用戶列表。 |
| UpdateNacUserCertStatus | 批量修改用戶入網證書狀態 | 批量修改當前阿里云賬號下用戶入網證書狀態。 |
身份源配置管理
| API | 標題 | API概述 |
|---|---|---|
| ListIdpConfigs | 查詢身份源配置信息 | 查詢當前阿里云賬戶身份源配置信息。 |
| GetIdpConfig | 查詢身份源配置詳情 | 查詢當前阿里云賬戶指定的身份源配置詳情信息。 |
| GetActiveIdpConfig | 查詢已啟用的身份源配置 | 查詢當前阿里云賬戶已啟用的身份源配置。 |
| 自定義身份源 | 自定義身份源 | |
| ListIdpDepartments | 查詢自定義身份源部門 | 查詢當前阿里云賬戶自定義身份源部門信息。 |
| CreateIdpDepartment | 創建自定義身份源部門 | 創建當前阿里云賬戶自定義身份源部門。 |
| ListClientUsers | 查詢自定義身份用戶信息 | 查詢當前阿里云賬戶自定義身份源的用戶信息。 |
| UpdateClientUser | 設置自定義身份源指定用戶信息 | 設置當前阿里云賬戶自定義身份源指定用戶的信息。 |
| GetClientUser | 查詢自定義身份源用戶詳情 | 查詢當前阿里云賬戶自定義身份源指定用戶的詳情信息。 |
| DeleteIdpDepartment | 刪除自定義身份源指定部門 | 刪除當前阿里云賬戶自定義身份源指定的部門。 |
| CreateClientUser | 創建自定義身份源用戶 | 創建當前阿里云賬戶自定義身份源用戶。 |
| UpdateIdpDepartment | 修改自定義身份源指定部門 | 刪除當前阿里云賬戶自定義身份源指定的部門。 |
| UpdateClientUserStatus | 設置自定義身份源用戶啟用狀態 | 設置當前阿里云賬戶自定義身份源指定用戶的啟用狀態。 |
| DeleteClientUser | 刪除自定義身份源指定用戶 | 刪除當前阿里云賬戶自定義身份源的指定用戶。 |
| UpdateClientUserPassword | 設置自定義身份源指定用戶的密碼 | 設置當前阿里云賬戶自定義身份源指定用戶的密碼。 |
終端設備管理
| API | 標題 | API概述 |
|---|---|---|
| UpdateUserDevicesStatus | 批量修改用戶終端設備狀態 | 批量修改當前阿里云賬號下終端設備狀態。 |
| ListExcessiveDeviceRegistrationApplications | 批量查詢設備超額注冊申請 | 查詢當前阿里云賬號下用戶終端設備的超額注冊申請列表。 |
| UpdateExcessiveDeviceRegistrationApplicationsStatus | 批量修改設備超額注冊申請狀態 | 批量修改當前阿里云賬號下超額注冊申請狀態。 |
| UpdateUserDevicesSharingStatus | 批量修改用戶終端設備共享狀態 | 批量修改企業用戶的終端設備共享狀態。 |
| ListUserDevices | 批量查詢用戶終端設備 | 查詢當前阿里云賬號下用戶終端設備列表。 |
| ExportUserDevices | 導出用戶終端設備列表 | 導出用戶終端設備列表Excel文件。 |
| GetUserDevice | 查詢用戶終端設備詳情 | 查詢當前阿里云賬號下用戶終端設備詳情。 |
| DeleteUserDevices | 批量刪除用戶終端設備 | 批量刪除用戶終端設備。 |
| ListSoftwareForUserDevice | 批量查詢用戶終端設備安裝軟件 | 查詢當前阿里云賬號下用戶終端設備安裝的軟件列表。 |
設備注冊策略
| API | 標題 | API概述 |
|---|---|---|
| ListRegistrationPolicies | 批量查詢設備注冊策略 | 查詢當前阿里云賬號下設備注冊策略列表。 |
| ListUserGroupsForRegistrationPolicy | 批量查詢設備注冊策略的用戶組 | 查詢當前阿里云賬號下設備注冊策略相關用戶組。 |
| ListRegistrationPoliciesForUserGroup | 批量查詢用戶組的設備注冊策略 | 查詢當前阿里云賬號下用戶組相關的設備注冊策略。 |
| GetRegistrationPolicy | 查詢設備注冊策略詳情 | 查詢當前阿里云賬號下設備注冊策略詳情。 |
| DeleteRegistrationPolicies | 批量刪除設備注冊策略 | 批量刪除當前阿里云賬號下設備注冊策略。 |
| UpdateRegistrationPolicy | 修改設備注冊策略 | 修改當前阿里云賬號下設備注冊策略。 |
| CreateRegistrationPolicy | 創建設備注冊策略 | 創建當前阿里云賬號下設備注冊策略。 |
用戶組
| API | 標題 | API概述 |
|---|---|---|
| ListUserGroups | 批量查詢用戶組 | 批量查詢當前阿里云賬號下所有用戶組的信息。 |
| ListPolicesForUserGroup | 批量查詢用戶組的策略 | 批量查詢當前阿里云賬號下用戶組的策略。 |
| GetUserGroup | 查詢用戶組詳情 | 查詢當前阿里云賬號下的用戶組詳情。 |
| CreateUserGroup | 創建用戶組 | 創建當前阿里云賬號下用戶組。 |
| DeleteUserGroup | 刪除用戶組 | 刪除當前阿里云賬號下用戶組。 |
| UpdateUserGroup | 修改用戶組 | 修改當前阿里云賬號下用戶組。 |
用戶管理
| API | 標題 | API概述 |
|---|---|---|
| ListUserPrivateAccessPolicies | 查詢用戶零信任策略 | 列表查詢用戶零信任策略。 |
| ListUserApplications | 查詢用戶內網應用 | 查詢當前阿里云賬號下登錄用戶的應用權限 |
| ListUsers | 批量查詢用戶 | 查詢當前阿里云賬號下登錄用戶列表。 |
| UpdateUsersStatus | 批量修改用戶狀態 | 批量修改當前阿里云賬號下登錄用戶的狀態。 |
內網訪問應用
| API | 標題 | API概述 |
|---|---|---|
| ListPrivateAccessApplications | 批量查詢內網訪問應用 | 批量查詢當前阿里云賬號下所有內網訪問應用的信息。 |
| ListTagsForPrivateAccessApplication | 批量查詢內網訪問應用的標簽 | 批量查詢當前阿里云賬號下內網訪問應用的標簽。 |
| ListPolicesForPrivateAccessApplication | 批量查詢內網訪問應用的策略 | 批量查詢當前阿里云賬號下內網訪問應用的策略。 |
| GetPrivateAccessApplication | 查詢內網訪問應用詳情 | 查詢當前阿里云賬號下內網訪問應用詳情。 |
| CreatePrivateAccessApplication | 創建內網訪問應用 | 創建當前阿里云賬號下內網訪問應用。 |
| DeletePrivateAccessApplication | 刪除內網訪問應用 | 刪除當前阿里云賬號下內網訪問應用。 |
| UpdatePrivateAccessApplication | 修改內網訪問應用 | 修改當前阿里云賬號下內網訪問應用。 |
Connector
| API | 標題 | API概述 |
|---|---|---|
| ListConnectors | 批量查詢Connector | 批量查詢當前阿里云賬號下Connector實例。 |
| AttachApplication2Connector | 掛載Connector的應用 | 掛載當前阿里云賬號下Connector的內網訪問應用。 |
| DetachApplication2Connector | 卸載Connector的應用 | 卸載當前阿里云賬號下Connector的內網訪問應用。 |
內網訪問標簽
| API | 標題 | API概述 |
|---|---|---|
| ListPrivateAccessTags | 批量查詢內網訪問標簽 | 批量查詢當前阿里云賬號下所有內網訪問標簽的信息。 |
| ListApplicationsForPrivateAccessTag | 批量查詢內網訪問標簽的應用 | 批量查詢當前阿里云賬號下內網訪問標簽的應用。 |
| ListPolicesForPrivateAccessTag | 批量查詢內網訪問標簽的策略 | 批量查詢當前阿里云賬號下內網訪問標簽的策略。 |
| CreatePrivateAccessTag | 創建內網訪問標簽 | 創建當前阿里云賬號下內網訪問標簽。 |
| DeletePrivateAccessTag | 刪除內網訪問標簽 | 刪除當前阿里云賬號下內網訪問標簽。 |
內網訪問策略
| API | 標題 | API概述 |
|---|---|---|
| ListPrivateAccessPolices | 批量查詢內網訪問策略 | 獲取當前阿里云賬號下所有內網訪問策略的信息。 |
| ListUserGroupsForPrivateAccessPolicy | 批量查詢內網訪問策略的用戶組 | 批量查詢當前阿里云賬號下內網訪問策略的用戶組。 |
| ListApplicationsForPrivateAccessPolicy | 批量查詢內網訪問策略的應用 | 批量查詢當前阿里云賬號下內網訪問策略的應用。 |
| ListTagsForPrivateAccessPolicy | 批量查詢內網訪問策略的標簽 | 批量查詢當前阿里云賬號下內網訪問策略的標簽。 |
| GetPrivateAccessPolicy | 查詢內網訪問策略詳情 | 獲取當前阿里云賬號下指定內網訪問策略的詳情信息。 |
| CreatePrivateAccessPolicy | 創建內網訪問策略 | 創建當前阿里云賬號下內網訪問策略。 |
| DeletePrivateAccessPolicy | 刪除內網訪問策略 | 刪除當前阿里云賬號下內網訪問策略。 |
| UpdatePrivateAccessPolicy | 修改內網訪問策略 | 修改當前阿里云賬號下內網訪問策略。 |
全球辦公
| API | 標題 | API概述 |
|---|---|---|
| ListDynamicRoutes | 批量查詢動態路由 | 獲取當前阿里云賬號下所有動態路由的信息。 |
| ListPrivateAccessApplicationsForDynamicRoute | 批量查詢動態路由的應用 | 批量查詢當前阿里云賬號下動態路由的應用。 |
| ListPrivateAccessTagsForDynamicRoute | 批量查詢動態路由的標簽 | 批量查詢當前阿里云賬號下動態路由的標簽。 |
| GetDynamicRoute | 查詢動態路由詳情 | 獲取當前阿里云賬號下指定動態路由的詳情信息。 |
| ListDynamicRouteRegions | 批量查詢動態路由已授權地域 | 批量查詢當前阿里云賬號下查詢SASE的POP集群接入點支持地域。 |
| CreateDynamicRoute | 創建動態路由 | 創建當前阿里云賬號下創建動態路由。 |
| UpdateDynamicRoute | 修改動態路由 | 修改當前阿里云賬號下動態路由。 |
| DeleteDynamicRoute | 刪除動態路由 | 刪除當前阿里云賬號下動態路由。 |
數字水印
| API | 標題 | API概述 |
|---|---|---|
| LookupWmInfoMapping | 查詢水印信息映射關系 | 通過查詢已創建的水印信息映射關系，根據數字格式的水印信息查找得到對應的字符串格式的水印信息。 |
| CreateWmInfoMapping | 創建水印信息映射關系 | 創建一條字符串格式的水印信息到數字格式的水印信息的映射關系。 |
| CreateWmBaseImage | 創建暗水印透明底圖 | 獲取網頁水印、屏幕水印和App水印的暗水印透明底圖。 |
| GetWmExtractTask | 查詢水印提取任務詳情 | 根據創建提取任務時獲取的任務ID，查詢水印提取任務結果。 |
| GetWmEmbedTask | 查詢水印嵌入任務詳情 | 使用創建水印嵌入任務得到的任務ID，查詢嵌入任務結果。 |
| CreateWmExtractTask | 創建水印提取任務 | 創建數字水印提取任務。 |
| CreateWmEmbedTask | 創建水印嵌入任務 | 創建數字水印嵌入任務。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| RevokeUserSession | 吊銷用戶登錄會話 | |
| ListPopTrafficStatistics | 查詢POP點帶寬統計 | 查詢SASE的POP節點帶寬。 |