API概览

本产品(办公安全平台/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节点带宽。