华为云用户手册

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 client_id 是 String 客户端的唯一标识。 client_secret 是 String 为客户端生成的秘密字符串。客户端将使用此字符串在后续调用中获得服务的身份验证。 code 否 String 从授权服务接收的授权代码。执行授权授予请求以获取对令牌的访问权限时需要此参数。 device_code 否 String 仅在为设备代码授权类型调用此API时使用 grant_type 是 String 请求的授权类型。支持授权码、设备代码、客户端凭证和刷新令牌等授权类型。 枚举值： authorization_code urn:ietf:params:oauth:grant-type:device_code redirect_uri 否 String 将接收授权代码的应用程序的位置。用户授权服务将请求发送到此位置。 refresh_token 否 String 刷新令牌，此令牌可在访问令牌过期后获取新的访问令牌。 scopes 否 Array of strings 客户端定义的作用域列表，表示客户端想要获取的权限。授权后，此列表用于在授予访问令牌时限制权限。

URI DELETE /v1/identity-stores/{identity_store_id}/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符（ID）。 最小长度：12 最大长度：12 user_id 是 String 身份源中IAM身份中心用户的全局唯一标识符（ID）。 最小长度：1 最大长度：64

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。

响应示例 状态码： 200 Successful { "account_assignment_creation_status" : { "created_date" : 0, "failure_reason" : "string", "permission_set_id" : "string", "principal_id" : "string", "principal_type" : "USER", "request_id" : "string", "status" : "IN_PROGRESS", "target_id" : "string", "target_type" : "ACCOUNT" } }

请求示例 使用指定的权限集为指定账号分配对应IAM身份中心用户的访问权限。 POST https://{hostname}/v1/instances/{instance_id}/account-assignments/create { "permission_set_id" : "848805579************03de60620a5", "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "principal_type" : "USER", "target_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "target_type" : "ACCOUNT" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 account_assignment_creation_status Object 描述权限集操作执行状态的对象。 表5 account_assignment_creation_status 参数 参数类型 描述 created_date Long 创建日期。 failure_reason String 失败原因。 permission_set_id String 权限集唯一标识。 principal_id String IAM身份中心中的一个实体身份唯一标识，例如用户或用户组。 principal_type String 操作的实体类型。 枚举值： USER GROUP request_id String 请求唯一标识。 status String 权限集授权状态。 枚举值： IN_PROGRESS FAILED SUCCEEDED target_id String 目标实体的唯一标识。 target_type String 实体类型。 枚举值： ACCOUNT 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 permission_set_id 是 String 权限集唯一标识。 principal_id 是 String IAM身份中心中的一个实体身份唯一标识，例如用户或用户组。 principal_type 是 String 创建绑定的实体类型。 枚举值： USER GROUP target_id 是 String 待绑定的目标实体标识。 target_type 是 String 创建绑定的实体类型。 枚举值： ACCOUNT

请求示例 更新用户组的部分属性。 PATCH https://{hostname}/{tenant_id}/scim/v2/Groups/{group_id} { "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations" : [ { "op" : "replace", "value" : { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "displayName" : "更新显示名称" } }, { "op" : "add", "path" : "members", "value" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" } ] }, { "op" : "replace", "path" : "members", "value" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" }, { "value" : "1bdaa75c-7aaf-3aa2-7aac-6a00aaaa335f" } ] }, { "op" : "remove", "path" : "members", "value" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" }, { "value" : "1bdaa75c-7aaf-3aa2-7aac-6a00aaaa335f" } ] } ] }

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 schemas 否 Array of strings 概要。 Operations 否 Array of objects 要执行的修改操作列表。 表4 Operations 参数 是否必选 参数类型 描述 op 是 String 要执行的修改操作类型。 add：添加属性，replace：替换属性，remove：删除属性。 value 是 Object 要修改的属性值。 path 否 String 要修改的属性路径。只有用户组的以下属性可以修改： displayName，members。

响应示例 状态码： 200 Successful { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "active" : true, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "userType" : "xxx" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 用户的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名，用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 userType String 指示用户类型的字符串。 nickName String 用户昵称。 最小长度：1 最大长度：1024 title String 用户头衔。 最小长度：1 最大长度：1024 preferredLanguage String 用户语言首选项。 最小长度：1 最大长度：1024 locale String 用户的地理区域或位置信息。 最小长度：1 最大长度：1024 timezone String 用户时区。 最小长度：1 最大长度：1024 addresses Array of objects 用户的地址信息列表。 数组长度：1-1 phoneNumbers Array of objects 用户的电话号码信息列表。 数组长度：1-1 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表4 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表5 name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表6 emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表7 users.addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 最小长度：1 最大长度：1024 streetAddress String 街道。 最小长度：1 最大长度：1024 locality String 地址位置。 最小长度：1 最大长度：1024 region String 区域。 最小长度：1 最大长度：1024 postalCode String 邮政编码。 最小长度：1 最大长度：1024 country String 国家/地区。 最小长度：1 最大长度：1024 type String 表示地址类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主地址。 表8 users.phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 最小长度：1 最大长度：1024 type String 表示电话号码类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表9 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 参数类型 描述 costCenter String 成本中心。 最小长度：1 最大长度：1024 department String 部门。 最小长度：1 最大长度：1024 division String 分部。 最小长度：1 最大长度：1024 employeeNumber String 员工编号。 最小长度：1 最大长度：1024 manager Object 经理。 organization String 组织。 最小长度：1 最大长度：1024 表10 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表11 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表14 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 权限集的描述。 最小长度：0 最大长度：1024 relay_state 否 String 用于在联合身份验证过程中重定向应用程序中的用户。 最小长度：0 最大长度：240 session_duration 否 String 应用程序用户会话在ISO-8601标准中有效的时间长度。 最小长度：1 最大长度：100

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

响应示例 状态码： 200 Successful { "account_assignment_creation_status" : { "created_date" : 1677175760379, "failure_reason" : "", "permission_set_id" : "ps-8603aaaaaaaa14bd", "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "principal_type" : "USER", "request_id" : "9238e6aaaaaaaaaaaaaaaaaaaa4cad92", "status" : "IN_PROGRESS", "target_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "target_type" : "ACCOUNT" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 account_assignment_creation_status Object 描述权限集操作执行状态的对象. 表4 account_assignment_creation_status 参数 参数类型 描述 created_date Long 创建日期。 failure_reason String 失败原因。 permission_set_id String 权限集唯一标识 principal_id String IAM身份中心中的一个实体身份唯一标识，例如用户或用户组。 principal_type String 操作的实体类型。 枚举值： USER GROUP request_id String 请求唯一标识。 status String 权限集授权状态。 枚举值： IN_PROGRESS FAILED SUCCEEDED target_id String 目标实体的唯一标识。 target_type String 实体类型。 枚举值： ACCOUNT 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 account_assignments Array of objects 满足查询条件的账号分配列表。 page_info Object 包含分页信息的对象。 表5 account_assignments 参数 参数类型 描述 account_id String 账号的唯一标识。 permission_set_id String 权限集唯一标识。 principal_id String IAM身份中心中的一个实体身份唯一标识，例如用户或用户组。 principal_type String 绑定的实体类型。 枚举值： USER GROUP 表6 page_info 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

URI GET /v1/instances/{instance_id}/account-assignments 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM身份中心实例的全局唯一标识符（ID）。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每个请求返回的最大结果数。 最小值：1 最大值：100 缺省值：100 marker 否 String 分页标记 最小长度：24 最大长度：24 account_id 是 String 账号的唯一身份标识。 permission_set_id 否 String 指定权限集的唯一身份标识。

响应示例 状态码： 200 Successful { "account_assignments" : [ { "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "permission_set_id" : "ps-8603aaaaaaaa14bd", "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "principal_type" : "USER" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }

响应示例 状态码： 200 Successful { "account_assignment_deletion_status" : { "created_date" : 1677175760379, "failure_reason" : "", "permission_set_id" : "ps-8603aaaaaaaa14bd", "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "principal_type" : "USER", "request_id" : "9238e6aaaaaaaaaaaaaaaaaaaa4cad92", "status" : "IN_PROGRESS", "target_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "target_type" : "ACCOUNT" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 account_assignment_deletion_status Object 描述权限集操作执行状态的对象。 表4 account_assignment_deletion_status 参数 参数类型 描述 created_date Long 创建日期。 failure_reason String 失败原因。 permission_set_id String 权限集唯一标识。 principal_id String IAM身份中心中的一个实体身份唯一标识，例如用户或用户组。 principal_type String 操作的实体类型。 枚举值： USER GROUP request_id String 请求唯一标识。 status String 权限集授权状态。 枚举值： IN_PROGRESS FAILED SUCCEEDED target_id String 目标实体的唯一标识。 target_type String 实体类型。 枚举值： ACCOUNT 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_access_control_attribute_configuration Object 已添加到ABAC配置的IAM身份中心身份源属性的列表。 status String ABAC属性配置的状态。 枚举值： ENABLED CREATION_IN_PROGRESS CREATION_FAILED status_reason String 提供有关指定属性的当前状态的更多详细信息。 表4 instance_access_control_attribute_configuration 参数 参数类型 描述 access_control_attributes Array of objects IAM身份中心实例中ABAC配置的属性。 数组长度：0 - 20 表5 access_control_attributes 参数 参数类型 描述 key String 与您的身份源中的身份关联的属性的名称。 最小长度：1 最大长度：128 value Object 用于将指定属性映射到身份源的值。 表6 value 参数 参数类型 描述 source Array of strings 用于将指定属性映射到身份源的值。 最小长度：0 最大长度：255 数组长度：1-1 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

响应示例 状态码： 200 Successful { "instance_access_control_attribute_configuration" : { "access_control_attributes" : [ { "key" : "email", "value" : { "source" : [ "${path:emails[primary eq true].value}" ] } }, { "key" : "displayName", "value" : { "source" : [ "${path:displayName}" ] } } ] }, "status" : "ENABLED", "status_reason" : null }

响应示例 状态码： 200 Successful { "permission_sets_provisioning_status" : [ { "created_date" : 1677175760379, "request_id" : "1c8c7c49238e605a11775963d34cad92", "status" : "IN_PROGRESS" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 permission_sets_provisioning_status Array of objects 权限集授权状态。 page_info Object 包含分页信息的对象。 表5 permission_sets_provisioning_status 参数 参数类型 描述 created_date Long 权限集创建日期。 request_id String 请求唯一标识。 最小长度：36 最大长度：36 status String 权限集授权状态。 枚举值： IN_PROGRESS FAILED SUCCEEDED 表6 page_info 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

URI GET /v1/instances/{instance_id}/permission-sets/provisioning-statuses 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM身份中心实例的全局唯一标识符（ID）。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每个请求返回的最大结果数。 最小值：1 最大值：100 缺省值：100 marker 否 String 分页标记。 最小长度：24 最大长度：24 status 否 String 根据传递的属性值过滤操作状态列表。 枚举值： IN_PROGRESS SUCCEEDED FAILED

请求示例 在指定的权限集中添加自定义身份策略。 PUT https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}/custom-policy { "custom_policy" : "{\"Version\":\"5.0\",\"Statement\":[{\"Effect\":\"Deny\",\"Action\":[\"organizations:ous:delete\"],\"Condition\":{\"StringEquals\":{\"g:ResourceAccount\":[\"0a6d25d23900d45c0faac010e0fb4de0\"]}}}]}" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 custom_policy 是 String 要添加到权限集的自定义身份策略。 最小长度：1 最大长度：131072

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识 状态码： 409 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识

请求示例 根据用户ID和用户组ID列表，查询用户是否为用户组的成员。 POST https://{hostname}/v1/identity-stores/{identity_store_id}/is-member-in-groups { "group_ids" : [ "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a" ], "member_id" : { "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" } }