华为云用户手册

请求示例 将自定义策略附加到权限集 PUT https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}/custom-role { "custom_role" : "{\"Version\":\"1.1\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"example:*:*\"]}]}" }

URI PUT /v1/instances/{instance_id}/permission-sets/{permission_set_id}/custom-role 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM Identity Center实例的全局唯一标识符（ID） permission_set_id 是 String 权限集的全局唯一标识符（ID）

响应参数 状态码： 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 请求唯一标识

响应示例 状态码： 200 Successful { "totalResults" : 1, "itemsPerPage" : 10, "startIndex" : "649040aaaaaaaaaaaa3e3050", "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "Resources" : [ { "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参数 参数 参数类型 描述 totalResults Integer 总结果数。 itemsPerPage String 每页的元素个数。 startIndex String 起始索引。 schemas Array of strings 概要。 Resources Array of objects 包含用户信息的列表。 表4 Resources 参数 参数类型 描述 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 包含用户工作相关信息的对象。 表5 Resources.meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表6 Resources.name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表7 Resources.emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表8 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 一个布尔值，表示这是否为用户的主地址。 表9 users.phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 最小长度：1 最大长度：1024 type String 表示电话号码类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表10 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 表11 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表12 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表13 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表14 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表15 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表16 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应示例 状态码： 200 Successful { "account_list" : [ { "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "account_name" : "example-account-name", "email_address" : "email@example.com" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 account_list Array of objects 满足查询条件的账号对象列表。 page_info Object 包含分页信息的对象。 表4 account_list 参数 参数类型 描述 account_id String 分配给用户的账号的全局唯一标识符（ID）。 account_name String 分配给用户的账号的名称。 email_address String 分配给用户的账号的电子邮箱地址。 最小长度：1 最大长度：254 表5 page_info 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 attached_managed_policies Array of objects IAM系统身份策略列表。 page_info Object 包含分页信息的对象。 表5 attached_managed_policies 参数 参数类型 描述 policy_id String IAM系统身份策略唯一标识。 最小长度：20 最大长度：2048 policy_name String IAM系统身份策略名称。 最小长度：1 最大长度：100 表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 请求唯一标识。

响应示例 状态码： 200 Successful { "attached_managed_policies" : [ { "policy_id" : "848805579************03de60620a5", "policy_name" : "sys_example_456" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 attached_managed_roles Array of objects IAM系统策略列表。 page_info Object 包含分页信息的对象。 表5 attached_managed_roles 参数 参数类型 描述 role_id String IAM系统策略唯一标识。 最小长度：20 最大长度：2048 role_name String IAM系统策略名称。 最小长度：1 最大长度：100 表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 请求唯一标识。

响应示例 状态码： 200 Successful { "attached_managed_roles" : [ { "role_id" : "ba5146848aaaaaaaaaaaa03de60620a5", "role_name" : "role_example_456" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }

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

响应示例 状态码： 200 Successful { "totalResults" : 1, "itemsPerPage" : 10, "startIndex" : "649040aaaaaaaaaaaa3e3050", "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "Resources" : [ { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "meta" : { "resourceType" : "Group", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 totalResults Integer 总结果数。 itemsPerPage Integer 每页的元素个数。 startIndex String 起始索引。 schemas Array of strings 概要。 Resources Array of objects 包含用户组信息的列表。 表4 Resources 参数 参数类型 描述 id String 用户组的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 displayName String 包含用户组显示名称的字符串。 members Array of objects 用户组中的成员对象列表。 表5 Resources.meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表6 Resources.members 参数 参数类型 描述 value String 成员的全局唯一标识符（ID）。 $ref String 成员的引用信息。 type String 成员类型，User：用户。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

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

URI DELETE /v1/instances/{instance_id}/permission-sets/{permission_set_id}/custom-policy 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM身份中心实例的全局唯一标识符（ID）。 permission_set_id 是 String 权限集的全局唯一标识符（ID）。

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

响应示例 状态码： 200 Successful { "account_assignment_deletion_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" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 account_assignment_deletion_status Object 描述权限集操作执行状态的对象。 表5 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 表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 请求唯一标识。 状态码： 409 表9 响应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

请求示例 创建用户组。 POST https://{hostname}/{tenant_id}/scim/v2/Groups { "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ], "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ] }

响应示例 状态码： 201 Successful { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "meta" : { "resourceType" : "Group", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ] }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 id String 用户组的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 displayName String 包含用户组显示名称的字符串。 members Array of objects 用户组中的成员对象列表。 表6 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表7 members 参数 参数类型 描述 value String 成员的全局唯一标识符（ID）。 $ref String 成员的引用信息。 type String 成员类型，User：用户。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表11 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 externalId 否 String 外部标识符。 displayName 否 String 包含用户组显示名称的字符串。 members 否 Array of objects 用户组中的成员对象列表。 schemas 否 Array of strings 概要。 表4 members 参数 是否必选 参数类型 描述 value 是 String 成员的全局唯一标识符（ID）。 $ref 否 String 成员的引用信息。 type 否 String 成员类型，User：用户。

URI POST /v1/instances/{resource_type}/{resource_id}/tags/create 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。 枚举值： identitycenter:permissionset（权限集） resource_id 是 String 权限集的唯一标识符（ID）。 最大长度：130

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 用于管理资源的一组键值对。 数组长度：0 - 50 表4 tags 参数 是否必选 参数类型 描述 key 是 String 标签的键。 最小长度：1 最大长度：128 value 是 String 标签的值，可以为空字符串，但不能为null。 最小长度：0 最大长度：255

URI DELETE /v1/instances/{instance_id}/permission-sets/{permission_set_id}/custom-role 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM Identity Center实例的全局唯一标识符（ID） permission_set_id 是 String 权限集的全局唯一标识符（ID）

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