本产品（
办公安全平台/2023-01-20）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
身份源配置管理
| API | 标题 | API概述 |
|---|---|---|
| ListIdpConfigs | 查询身份源配置信息 | 查询当前阿里云账户身份源配置信息。 |
| GetIdpConfig | 查询身份源配置详情 | 查询当前阿里云账户指定的身份源配置详情信息。 |
| GetActiveIdpConfig | 查询已启用的身份源配置 | 查询当前阿里云账户已启用的身份源配置。 |
| 自定义身份源 | 自定义身份源 | |
| ListIdpDepartments | 查询自定义身份源部门 | 查询当前阿里云账户自定义身份源部门信息。 |
| CreateIdpDepartment | 创建自定义身份源部门 | 创建当前阿里云账户自定义身份源部门。 |
| ListClientUsers | 查询自定义身份用户信息 | 查询当前阿里云账户自定义身份源的用户信息。 |
| UpdateClientUser | 设置自定义身份源指定用户信息 | 设置当前阿里云账户自定义身份源指定用户的信息。 |
| GetClientUser | 查询自定义身份源用户详情 | 查询当前阿里云账户自定义身份源指定用户的详情信息。 |
| DeleteIdpDepartment | 删除自定义身份源指定部门 | 删除当前阿里云账户自定义身份源指定的部门。 |
| CreateClientUser | 创建自定义身份源用户 | 创建当前阿里云账户自定义身份源用户。 |
| UpdateIdpDepartment | 修改自定义身份源指定部门 | 删除当前阿里云账户自定义身份源指定的部门。 |
| UpdateClientUserStatus | 设置自定义身份源用户启用状态 | 设置当前阿里云账户自定义身份源指定用户的启用状态。 |
| DeleteClientUser | 删除自定义身份源指定用户 | 删除当前阿里云账户自定义身份源的指定用户。 |
| UpdateClientUserPassword | 设置自定义身份源指定用户的密码 | 设置当前阿里云账户自定义身份源指定用户的密码。 |
终端设备管理
| API | 标题 | API概述 |
|---|---|---|
| UpdateUserDevicesStatus | 批量修改用户终端设备状态 | 批量修改当前阿里云账号下终端设备状态。 |
| ListExcessiveDeviceRegistrationApplications | 批量查询设备超额注册申请 | 查询当前阿里云账号下用户终端设备的超额注册申请列表。 |
| UpdateExcessiveDeviceRegistrationApplicationsStatus | 批量修改设备超额注册申请状态 | 批量修改当前阿里云账号下超额注册申请状态。 |
| UpdateUserDevicesSharingStatus | 批量修改用户终端设备共享状态 | |
| ListUserDevices | 批量查询用户终端设备 | 查询当前阿里云账号下用户终端设备列表。 |
| GetUserDevice | 查询用户终端设备详情 | 查询当前阿里云账号下用户终端设备详情。 |
| ListSoftwareForUserDevice | 批量查询用户终端设备安装软件 | 查询当前阿里云账号下用户终端设备安装的软件列表。 |
设备注册策略
| API | 标题 | API概述 |
|---|---|---|
| ListRegistrationPolicies | 批量查询设备注册策略 | 查询当前阿里云账号下设备注册策略列表。 |
| ListUserGroupsForRegistrationPolicy | 批量查询设备注册策略的用户组 | 查询当前阿里云账号下设备注册策略相关用户组。 |
| ListRegistrationPoliciesForUserGroup | 批量查询用户组的设备注册策略 | 查询当前阿里云账号下用户组相关的设备注册策略。 |
| GetRegistrationPolicy | 查询设备注册策略详情 | 查询当前阿里云账号下设备注册策略详情。 |
| DeleteRegistrationPolicies | 批量删除设备注册策略 | 批量删除当前阿里云账号下设备注册策略。 |
| UpdateRegistrationPolicy | 修改设备注册策略 | 修改当前阿里云账号下设备注册策略。 |
| CreateRegistrationPolicy | 创建设备注册策略 | 创建当前阿里云账号下设备注册策略。 |
用户组
| API | 标题 | API概述 |
|---|---|---|
| ListUserGroups | 批量查询用户组 | 批量查询当前阿里云账号下所有用户组的信息。 |
| ListPolicesForUserGroup | 批量查询用户组的策略 | 批量查询当前阿里云账号下用户组的策略。 |
| GetUserGroup | 查询用户组详情 | 查询当前阿里云账号下的用户组详情。 |
| CreateUserGroup | 创建用户组 | 创建当前阿里云账号下用户组。 |
| DeleteUserGroup | 删除用户组 | 删除当前阿里云账号下用户组。 |
| UpdateUserGroup | 修改用户组 | 修改当前阿里云账号下用户组。 |
用户管理
| API | 标题 | API概述 |
|---|---|---|
| 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概述 |
|---|---|---|
| ListPopTrafficStatistics | 查询POP点带宽统计 | 查询SASE的POP节点带宽。 |