华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 schemas Array of strings 概要。 documentationUri String 帮助文档链接。 authenticationSchemes Array of objects 认证概要列表。 patch Object 表示服务提供商是否支持部分修改操作,及对部分修改操作的相关配置。 bulk Object 表示服务提供商是否支持批量操作,及对批量操作的相关配置。 filter Object 表示服务提供商是否支持过滤操作,及对过滤操作的相关配置。 changePassword Object 表示服务提供商是否支持修改密码操作,及对修改密码操作的相关配置。 sort Object 表示服务提供商是否支持排序操作,及对排序操作的相关配置。 etag Object 表示服务提供商是否支持电子标签,及对电子标签的相关配置。 表4 authenticationSchemes 参数 参数类型 描述 type String 认证类型,指定鉴权的方式。 name String 认证概要名称。 description String 认证概要的描述信息。 specUri String 规范链接。 documentationUri String 帮助文档链接。 primary Boolean 是否为主要的认证方式。 表5 patch 参数 参数类型 描述 supported Boolean 一个布尔值,表示服务提供商是否支持这种操作。 表6 bulk 参数 参数类型 描述 supported Boolean 一个布尔值,表示服务提供商是否支持这种操作。 maxOperations Integer 一次可操作的最大个数。 maxPayloadSize Integer 最大有效载荷量。 表7 filter 参数 参数类型 描述 supported Boolean 一个布尔值,表示服务提供商是否支持这种操作。 maxResults Integer 最大结果数。 表8 changePassword 参数 参数类型 描述 supported Boolean 一个布尔值,表示服务提供商是否支持这种操作。 表9 sort 参数 参数类型 描述 supported Boolean 一个布尔值,表示服务提供商是否支持这种操作。 表10 etag 参数 参数类型 描述 supported Boolean 一个布尔值,表示服务提供商是否支持这种操作。 状态码: 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 时间戳。
  • 请求示例 更新用户。 PUT https://{hostname}/{tenant_id}/scim/v2/Users/{user_id}{ "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "nickName" : "xxx", "profileUrl" : "xxx", "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "addresses" : [ { "formatted" : "xxx", "streetAddress" : "xxx", "locality" : "xxx", "region" : "xxx", "postalCode" : "123456", "country" : "xxx", "type" : "work", "primary" : true } ], "phoneNumbers" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "userType" : "xxx", "title" : "xxx", "preferredLanguage" : "zh-CN", "locale" : "zh-CN", "timezone" : "xxx", "active" : true, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ]}
  • 响应示例 状态码: 201 Successful { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-16T21:32:55Z" }, "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", "nickName" : "xxx", "title" : "xxx", "userType" : "xxx", "preferredLanguage" : "zh-CN", "locale" : "zh-CN", "timezone" : "xxx", "active" : true, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "addresses" : [ { "formatted" : "xxx", "streetAddress" : "xxx", "locality" : "xxx", "region" : "xxx", "postalCode" : "123456", "country" : "xxx", "type" : "work", "primary" : true } ], "phoneNumbers" : [ { "value" : "xxx", "type" : "work", "primary" : true } ]}
  • 响应参数 状态码: 200 表10 响应Body参数 参数 参数类型 描述 id String 用户的全局唯一标识符(ID)。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名,用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 nickName String 包含用户昵称的字符串。 title String 包含用户头衔的字符串。 userType String 指示用户类型的字符串。 preferredLanguage String 包含用户首选语言的字符串。 locale String 包含用户地理区域或位置的字符串。 timezone String 包含用户时区的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 addresses Array of objects 包含用户地址信息的对象列表。 phoneNumbers Array of objects 包含用户电话号码信息的对象列表。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表11 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表12 name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表13 emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值,表示这是否为用户的主电子邮箱。 表14 addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 streetAddress String 街道。 locality String 地址位置。 region String 区域。 postalCode String 邮政编码。 country String 国家或地区。 type String 表示地址类型的字符串。 primary Boolean 一个布尔值,表示这是否为用户的主地址。 表15 phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 type String 表示电话号码类型的字符串。 primary Boolean 一个布尔值,表示这是否为用户的主电话号码。 表16 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 表17 manager 参数 参数类型 描述 value String 经理。 最小长度:1 最大长度:1024 状态码: 400 表18 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码: 403 表19 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码: 404 表20 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码: 409 表21 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码: 500 表22 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 用户的全局唯一标识符(ID)。 externalId 否 String 外部标识符。 userName 否 String 用户名,用于标识用户的唯一字符串。 name 否 Object 包含用户姓名信息的对象。 displayName 否 String 包含用户显示名称的字符串。 nickName 否 String 包含用户昵称的字符串。 profileUrl 否 String 包含可能与用户关联的URL的字符串。 emails 否 Array of objects 包含用户的电子邮箱信息的对象列表。 addresses 否 Array of objects 包含用户地址信息的对象列表。 phoneNumbers 否 Array of objects 包含用户电话号码信息的对象列表。 userType 否 String 指示用户类型的字符串。 title 否 String 包含用户头衔的字符串。 preferredLanguage 否 String 包含用户首选语言的字符串。 locale 否 String 包含用户地理区域或位置的字符串。 timezone 否 String 包含用户时区的字符串。 active 否 Boolean 表示用户是否启用。 schemas 否 Array of strings 概要。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 否 Object 包含用户工作相关信息的对象。 表4 name 参数 是否必选 参数类型 描述 formatted 否 String 包含要显示的名称的格式化版本的字符串。 familyName 否 String 用户的姓氏。 givenName 否 String 用户的名字。 middleName 否 String 用户的中间名。 honorificPrefix 否 String 用户的尊称前缀。 honorificSuffix 否 String 用户的尊称后缀。 表5 emails 参数 是否必选 参数类型 描述 value 是 String 包含电子邮箱地址的字符串。 type 否 String 表示电子邮箱类型的字符串。 primary 是 Boolean 一个布尔值,表示这是否为用户的主电子邮箱。 表6 addresses 参数 是否必选 参数类型 描述 formatted 否 String 包含要显示的地址的格式化版本的字符串。 streetAddress 否 String 街道。 locality 否 String 地址位置。 region 否 String 区域。 postalCode 否 String 邮政编码。 country 否 String 国家或地区。 type 否 String 表示地址类型的字符串。 primary 否 Boolean 一个布尔值,表示这是否为用户的主地址。 表7 phoneNumbers 参数 是否必选 参数类型 描述 value 否 String 包含电话号码的字符串。 type 否 String 表示电话号码类型的字符串。 primary 否 Boolean 一个布尔值,表示这是否为用户的主电话号码。 表8 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 表9 manager 参数 是否必选 参数类型 描述 value 否 String 经理。 最小长度:1 最大长度:1024
  • URI POST /v1/instances/{instance_id}/permission-sets/{permission_set_id}/detach-managed-role 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM 身份中心实例的全局唯一标识符(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 请求唯一标识。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 agency_credentials Object 分配给用户在指定委托或信任委托下的凭证。 表4 agency_credentials 参数 参数类型 描述 access_key_id String 用于临时安全凭证的标识符。 expiration Long 临时安全凭证到期的日期。 secret_access_key String 用于对请求进行签名的密钥。 session_token String 用于临时凭证的令牌。
  • 响应示例 状态码: 200 Successful { "agency_credentials" : { "access_key_id" : "example-access-key-id", "expiration" : 1684955360, "secret_access_key" : "example-secret-access-key", "session_token" : "string" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 alternate_identifier 是 Object 备用标识符。 表4 alternate_identifier 参数 是否必选 参数类型 描述 external_id 否 Object 外部身份提供商颁发给此资源的标识符。 unique_attribute 否 Object 特定实体唯一的实体属性。 表5 alternate_identifier.external_id 参数 是否必选 参数类型 描述 id 是 String 外部身份提供商颁发给此资源的标识符。 最小长度:1 最大长度:256 issuer 是 String 外部标识符的颁发者。 最小长度:1 最大长度:100 表6 alternate_identifier.unique_attribute 参数 是否必选 参数类型 描述 attribute_path 是 String 属性路径。 最小长度:1 最大长度:255 attribute_value 是 String 属性的值。 最小长度:1 最大长度:255
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 identity_store_id String 身份源的全局唯一标识符(ID)。 最小长度:1 最大长度:36 user_id String 身份源中IAM身份中心用户的全局唯一标识符(ID)。 最小长度:1 最大长度:47 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。
  • 请求示例 根据用户名或外部身份源ID,以精确匹配的方式查询用户ID。 POST https://{hostname}/v1/identity-stores/{identity_store_id}/users/retrieve-user-id{ "alternate_identifier" : { "external_id" : null, "unique_attribute" : { "attribute_path" : "user_name", "attribute_value" : "用户名u1" } }}
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URL 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP,不同服务在不同区域,Endpoint不同,可以从地区和终端节点处获取。例如IAM身份中心服务的Endpoint为identitycenter.myhuaweicloud.com。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“列出实例”API的resource-path为“/v1/instances”。 query-string 查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM身份中心的实例信息,则需使用IAM身份中心的Endpoint(identitycenter.myhuaweicloud.com),并在列出实例的URI部分找到resource-path(/v1/instances),拼接起来如下所示。 1 https://identitycenter.myhuaweicloud.com/v1/instances 为查看方便,每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求消息头 添加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”。 Authorization:请求消息中可带的签名信息,必选,AK/SK认证的详细说明请参见:AK/SK认证。 X-Sdk-Date:请求发送的时间,必选,例如:20221107T020014Z。 Host:表明主机地址,必选,如identitycenter.myhuaweicloud.com。 API支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK认证。 对于列出实例接口,请求如下所示。 GET https://identitycenter.myhuaweicloud.com/v1/instancescontent-type: application/jsonX-Sdk-Date: 20230330T021902Z host: identitycenter.myhuaweicloud.comAuthorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在列出实例的URI部分,您可以看到其请求方法为“GET”,则其请求为: GET https://identitycenter.myhuaweicloud.com/v1/instances
  • 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 请求唯一标识
  • 请求示例 将自定义策略附加到权限集 PUT https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}/custom-role{ "custom_role" : "{\"Version\":\"1.1\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"example:*:*\"]}]}"}
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。
  • 响应示例 状态码: 200 Successful { "account_assignments_creation_status" : [ { "created_date" : 1677175760379, "request_id" : "9238e6aaaaaaaaaaaaaaaaaaaa4cad92", "status" : "IN_PROGRESS" } ], "page_info" : { "next_marker" : null, "current_count" : 1 }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 account_assignments_creation_status Array of objects 操作状态列表。 page_info Object 包含分页信息的对象。 表5 account_assignments_creation_status 参数 参数类型 描述 created_date Long 创建日期。 request_id String 请求唯一标识。 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}/account-assignments/creation-statuses 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM身份中心实例的全局唯一标识符(ID)。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 根据传递的属性值过滤操作状态列表。 枚举值: IN_PROGRESS SUCCEEDED FAILED limit 否 Integer 每个请求返回的最大结果数。 最小值:1 最大值:100 缺省值:100 marker 否 String 分页标记。 最小长度:24 最大长度:24
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 permission_set Object 包含权限集详细信息的对象。 表4 permission_set 参数 参数类型 描述 created_date Long 权限集的创建时间。 description String 权限集的描述。 最小长度:1 最大长度:700 name String 权限集的名称。 最小长度:1 最大长度:32 permission_set_id String 权限集的唯一标识。 relay_state String 用于在联合身份验证过程中重定向应用程序中的用户。 最小长度:1 最大长度:240 session_duration String 应用程序用户会话在ISO-8601标准中有效的时间长度。 最小长度:1 最大长度:100 permission_urn String 权限集的统一资源名称(URN)。 状态码: 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 Successful { "permission_set" : { "created_date" : 1684794344964, "description" : "示例权限集", "name" : "example_0615", "permission_set_id" : "ps-8603aaaaaaaa14bd", "relay_state" : "", "session_duration" : "PT4H", "permission_urn" : "IdentityCenter::system:permissionSet:ps-8603aaaaaaaa14bd" }}
  • 响应示例 状态码: 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 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参数 参数 参数类型 描述 description String 包含组描述的字符串。 最小长度:1 最大长度:1024 display_name String 包含组显示名称的字符串。 最小长度:1 最大长度:1024 external_id String 外部身份源分配给此资源的标识符。 external_ids Array of objects 包含外部身份提供商颁发给此资源的标识符的对象列表。 数组长度:1-10 group_id String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:47 identity_store_id String 身份源的全局唯一标识符(ID)。 最小长度:1 最大长度:36 created_at Long 创建时的时间戳。 created_by String 创建者。 updated_at Long 更新时的时间戳。 updated_by String 更新者。 表4 external_ids 参数 参数类型 描述 id String 外部身份提供商颁发给此资源的标识符。 最小长度:1 最大长度:256 issuer String 外部标识符的颁发者。 最小长度:1 最大长度:100
  • URI GET /v1/identity-stores/{identity_store_id}/groups/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符(ID)。 最小长度:12 最大长度:12 group_id 是 String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:64
共99269条