华为云用户手册

  • 响应参数 状态码: 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_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" } }
  • 响应参数 状态码: 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 鉴权信息。
  • 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 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识
  • URI POST /v1/instances/{resource_type}/{resource_id}/tags/delete 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。 枚举值: identitycenter:permissionset(权限集) resource_id 是 String 权限集的唯一标识符(ID)。 最大长度:130
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 用于管理资源的一组键值对。 数组长度:1 - 20 表4 tags 参数 是否必选 参数类型 描述 key 是 String 标签的键。 最小长度:1 最大长度:128 value 否 String 标签的值,可以为空字符串,但不能为null。 最小长度:0 最大长度:255
  • 响应参数 状态码: 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 请求唯一标识。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。
  • 响应参数 状态码: 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 鉴权信息。
  • URI DELETE /v1/identity-stores/{identity_store_id}/group-memberships/{membership_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符(ID)。 最小长度:12 最大长度:12 membership_id 是 String 身份源中用户和组关联关系的全局唯一标识符(ID)。 最小长度:1 最大长度:64
  • URI DELETE /v1/identity-stores/{identity_store_id}/groups/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符(ID)。 最小长度:12 最大长度:12 group_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 鉴权信息。
  • 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 请求唯一标识
  • 响应参数 状态码: 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
  • 请求示例 在指定的身份源中创建一个IAM身份中心用户。 POST https://{hostname}/v1/identity-stores/{identity_store_id}/users { "user_name" : "用户名u1", "display_name" : "用户显示名", "emails" : [ { "primary" : true, "type" : "Work", "value" : "email@example.com" } ], "name" : { "family_name" : "姓氏", "given_name" : "名字" }, "password_mode" : "OTP" }
  • 响应参数 状态码: 201 表10 响应Body参数 参数 参数类型 描述 identity_store_id String 身份源的全局唯一标识符(ID)。 最小长度:1 最大长度:36 user_id String 身份源中IAM身份中心用户的全局唯一标识符(ID)。 最小长度:1 最大长度:47 password String 用于初始化密码的一次性密码。 状态码: 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码: 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码: 409 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 addresses 否 Array of objects 用户的地址信息列表。 数组长度:1-1 display_name 是 String 用户的显示名称。 最小长度:1 最大长度:1024 emails 是 Array of objects 用户的电子邮箱信息列表。 数组长度:1-1 locale 否 String 用户的地理区域或位置信息。 最小长度:1 最大长度:1024 name 是 Object 包含用户姓名信息的对象。 nickname 否 String 用户昵称。 最小长度:1 最大长度:1024 phone_numbers 否 Array of objects 用户的电话号码信息列表。 数组长度:1-1 preferred_language 否 String 用户语言首选项。 最小长度:1 最大长度:1024 profile_url 否 String 与用户关联的URL。 最小长度:1 最大长度:1024 timezone 否 String 用户时区。 最小长度:1 最大长度:1024 title 否 String 用户头衔。 最小长度:1 最大长度:1024 user_name 是 String 用户名,用于标识用户的唯一字符串。 最小长度:2 最大长度:128 user_type 否 String 用户类型。 最小长度:1 最大长度:1024 password_mode 是 String 初始化密码方式,一次性密码/邮箱。 枚举值: OTP EMAIL enterprise 否 Object 包含用户工作相关信息的对象。 表4 addresses 参数 是否必选 参数类型 描述 country 否 String 国家/地区。 最小长度:1 最大长度:1024 formatted 否 String 包含要显示的地址的格式化版本的字符串。 最小长度:1 最大长度:1024 locality 否 String 地址位置。 最小长度:1 最大长度:1024 postal_code 否 String 邮政编码。 最小长度:1 最大长度:1024 primary 否 Boolean 一个布尔值,表示这是否为用户的主地址。 region 否 String 区域。 最小长度:1 最大长度:1024 street_address 否 String 街道。 最小长度:1 最大长度:1024 type 否 String 表示地址类型的字符串。 最小长度:1 最大长度:1024 表5 emails 参数 是否必选 参数类型 描述 primary 是 Boolean 一个布尔值,表示这是否为用户的主电子邮箱。 type 是 String 表示电子邮箱类型的字符串。 最小长度:1 最大长度:1024 value 是 String 包含电子邮箱地址的字符串。 最小长度:1 最大长度:1024 verification_status 否 String 电子邮箱地址的验证状态。 枚举值: NOT_VERIFIED VERIFIED 表6 name 参数 是否必选 参数类型 描述 family_name 是 String 用户的姓氏。 最小长度:1 最大长度:1024 formatted 否 String 包含要显示的名称的格式化版本的字符串。 最小长度:1 最大长度:1024 given_name 是 String 用户的名字。 最小长度:1 最大长度:1024 honorific_prefix 否 String 用户的尊称前缀。 最小长度:1 最大长度:1024 honorific_suffix 否 String 用户的尊称后缀。 最小长度:1 最大长度:1024 middle_name 否 String 用户的中间名。 最小长度:1 最大长度:1024 表7 phone_numbers 参数 是否必选 参数类型 描述 primary 否 Boolean 一个布尔值,表示这是否为用户的主电话号码。 type 否 String 表示电话号码类型的字符串。 最小长度:1 最大长度:1024 value 否 String 包含电话号码的字符串。 最小长度:1 最大长度:1024 表8 enterprise 参数 是否必选 参数类型 描述 cost_center 否 String 成本中心。 最小长度:1 最大长度:1024 department 否 String 部门。 最小长度:1 最大长度:1024 division 否 String 分部。 最小长度:1 最大长度:1024 employee_number 否 String 员工编号。 最小长度:1 最大长度:1024 manager 否 Object 经理。 organization 否 String 组织。 最小长度:1 最大长度:1024 表9 manager 参数 是否必选 参数类型 描述 value 否 String 经理。 最小长度:1 最大长度:1024
  • 请求示例 创建访问令牌。 POST https://{hostname}/v1/tokens { "client_id" : "example_client_id", "client_secret" : "example_client_secret", "code" : "1234567890123456", "device_code" : null, "grant_type" : "authorization_code", "redirect_uri" : "https://example-redirect.example.com/redirect/url", "refresh_token" : null, "scopes" : [ "openid" ] }
  • 响应示例 状态码: 200 Successful { "token_info" : { "access_token" : "example_access_token", "expires_in" : 1684955360, "id_token" : "example_access_token", "refresh_token" : null, "token_type" : "Bearer" } }
  • 请求参数 表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 客户端定义的作用域列表,表示客户端想要获取的权限。授权后,此列表用于在授予访问令牌时限制权限。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 token_info Object 包含令牌信息的对象。 表3 token_info 参数 参数类型 描述 access_token String 用于访问分配给用户的IAM身份中心资源的不透明令牌。 expires_in Integer 访问令牌的过期时间(以秒为单位)。 id_token String 用于表明用户身份的不透明令牌。 refresh_token String 刷新令牌,此令牌可在访问令牌过期后获取新的访问令牌。 token_type String 用于通知客户端返回的令牌是访问令牌,目前为BearerToken。
  • 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 请求唯一标识
共100000条