用户管理

可用功能

平台管理 API 公开以下平台功能：

管理场景	身份验证方法
用户管理 — 创建、更新或删除用户或组，并管理组织设置	外部应用程序

基本 URL

针对基本 URL 的所有平台管理 API 调用均使用 HTTP 方法进行。

建议使用 https 协议加密通过 API 调用发送的数据。

备注：

对于 Automation Cloud 和 Automation Suite 部署，所有 Identity Server URL 都包含 /identity_ 段。
对于独立部署，所有 Identity Server URL 都包含 /identity 段。

资源列表

平台管理 API 使您的应用程序可以控制以下资源：

用户管理

审核

GET {BaseURL}/identity/api/AuditQuery/{organizationId} - 检索指定组织 ID 的审核日志。
GET {BaseURL}/identity/api/AuditQuery/{organizationId}/download - 下载指定组织 ID 的审核日志。

组

GET {BaseURL}/identity/api/Group/{partitionGlobalId} - 从指定的分区 ID（组织或租户）检索所有本地组和内置组。
GET {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} - 检索指定分区 ID 中的指定本地组或内置组。
POST {BaseURL}/identity/api/Group - 创建新的本地组。
PUT {BaseURL}/identity/api/Group/{groupId} - 更新本地组信息。
删除 {BaseURL}/identity/api/Group/{partitionGlobalId} - 删除指定分区 ID（组织或租户）中的所有本地组。
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} - 删除指定的本地组。

消息模板

GET {BaseURL}/identity/api/MessageTemplate - 使用提供的筛选器检索消息模板。
GET {BaseURL}/identity/api/MessageTemplate/{templateId} - 检索指定的消息模板。
PUT {BaseURL}/identity/api/MessageTemplate/{templateId} - 更新指定的消息模板。

机器人帐户

GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} - 检索指定分区 ID（组织或租户）中的所有机器人帐户。
GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - 检索指定分区 ID 中的指定机器人帐户。
POST {BaseURL}/identity/api/RobotAccount - 创建新的机器人帐户。
PUT {BaseURL}/identity/api/RobotAccount/{robotAccountId} - 更新指定的机器人帐户信息。
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - 删除指定的机器人帐户。
删除 {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} - 删除指定分区 ID 中的所有机器人帐户。

设置

GET {BaseURL}/identity/api/Setting - 根据特定租户的密钥列表检索应用程序设置。
PUT {BaseURL}/identity/api/Setting - 在特定租户中更新或创建新设置。

用户

GET {BaseURL}/identity/api/User/{userId} - 检索有关指定用户的信息。
POST {BaseURL}/identity/api/User - 创建新用户。此端点是幂等的：尝试覆盖用户会删除现有用户。
POST {BaseURL}/identity/api/User/BulkCreate - 批量创建用户。
POST {BaseURL}/identity/api/User/{userId}/changepassword - 更新指定用户的密码。
PUT {BaseURL}/identity/api/User/{userId} - 更新指定的用户信息。
删除 {BaseURL}/identity/api/User - 删除所有用户。
DELETE {BaseURL}/identity/api/User/{userId} - 删除指定用户。

UserLoginAttempt

GET {BaseURL}/identity/api/User/{userId}/loginAttempts - 检索指定用户的登录尝试。

每个 API 资源的作用域

作用域定义应用程序对平台管理资源的访问权限级别。

例如，如要为应用程序生成身份验证令牌，请传入多个作用域。当您的应用程序调用 API 以访问资源时，系统会根据资源作用域验证令牌。如果资源包含于您在令牌请求时传入的作用域中，则调用成功，并且调用会进一步检查每个端点的用户权限（GET 请求的读取权限和 POST、PUT 或 DELETE 请求的写入权限）。否则，服务器将拒绝调用。

每个端点的权限

权限授予应用程序用户对资源中特定功能的访问权限。每个权限都已与一个作用域链接。应用程序成功访问资源后，服务器将检查经过身份验证的用户是否具有端点相应方法的正确权限。

例如，您可以限制某些用户删除或更新用户组，但他们仍然可以查看这些用户组。

通常，GET 方法需要读取权限，而 POST、PUT 和 DELETE 方法则需要写入权限。

作用域和权限列表

用户管理

下表总结了执行特定操作所需的作用域和权限：

资源	作用域	权限
审核查询	PM.Audit	PM.Audit.Read（用于 GET 请求）
组	PM.Group	PM.Group.Read（用于 GET 请求） PM.Group.Write（用于 POST、PUT 和 DELETE 请求）
消息模板	PM.MessageTemplate	PM.MessageTemplate.Read（用于 GET 请求） PM.MessageTemplate.Write (for PUT requests)
机器人帐户	PM.RobotAccount	PM.RobotAccount.Read（用于 GET 请求） PM.RobotAccount.Write（用于 POST、PUT 和 DELETE 请求）
设置	PM.Setting	PM.Setting.Read（用于 GET 请求） PM.Setting.Write（用于 PUT 请求）
用户	PM.User	PM.User.Read（用于 GET 请求） PM.User.Write（用于 POST、PUT 或 DELETE 请求）
UserLoginAttempt	PM.UserLoginAttempt	PM.UserLoginAttempt.Read（用于 GET 请求）