华为云用户手册

  • 响应示例 状态码: 200 { "group_memberships" : [ { "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "identity_store_id" : "d-a00aaaa33f", "member_id" : { "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" }, "membership_id" : "2b0aa970-7aa4-3aaf-0aae-7a2eaaaae3a5" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
  • URI GET /v1/identity-stores/{identity_store_id}/group-memberships 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符(ID)。 最小长度:12 最大长度:12 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每个请求返回的最大结果数。 最小值:1 最大值:100 缺省值:100 marker 否 String 分页标记。 最小长度:24 最大长度:24 group_id 是 String 身份源中 IAM 身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 group_memberships Array of objects 满足查询条件的关联关系对象列表。 page_info Object 包含分页信息的对象。 表5 group_memberships 参数 参数类型 描述 group_id String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:47 identity_store_id String 身份源的全局唯一标识符(ID)。 最小长度:1 最大长度:36 member_id Object 包含组成员标识符的对象。 membership_id String 身份源中用户和组关联关系的全局唯一标识符(ID)。 最小长度:1 最大长度:47 表6 group_memberships.member_id 参数 参数类型 描述 user_id String 身份源中IAM身份中心用户的全局唯一标识符(ID)。 最小长度:1 最大长度:47 表7 page_info 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 account_ids Array of strings 账号ID列表。 page_info Object 包含分页信息的对象。 表5 page_info 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。
  • URI GET /v1/instances/{instance_id}/permission-sets/{permission_set_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String IAM身份中心实例的全局唯一标识符(ID)。 permission_set_id 是 String 权限集的全局唯一标识符(ID)。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每个请求返回的最大结果数。 最小值:1 最大值:100 缺省值:100 marker 否 String 分页标记。 最小长度:24 最大长度:24 provisioning_status 否 String 权限集分配状态。 枚举值: LATEST_PERMISSION_SET_PROVISIONED LATEST_PERMISSION_SET_NOT_PROVISIONED
  • 响应示例 状态码: 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 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 表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_deletion_status" : [ { "created_date" : 1677175760379, "request_id" : "9238e6aaaaaaaaaaaaaaaaaaaa4cad92", "status" : "IN_PROGRESS" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
  • URI GET /v1/instances/{instance_id}/account-assignments/deletion-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 表4 响应Body参数 参数 参数类型 描述 account_assignments_deletion_status Array of objects 操作状态列表。 page_info Object 包含分页信息的对象。 表5 account_assignments_deletion_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 请求唯一标识。
  • 响应示例 状态码: 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参数 参数 参数类型 描述 agency_list Array of objects 满足查询条件的委托或信任委托对象列表。 page_info Object 包含分页信息的对象。 表4 agency_list 参数 参数类型 描述 account_id String 分配给用户的账号的全局唯一标识符(ID)。 agency_name String 分配给用户的委托或信任委托的名称。 permission_set_name String 权限集名称。 agency_urn String 委托或信任委托的统一资源名称(URN)。 description String 描述信息。 表5 page_info 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。
  • 响应示例 状态码: 200 Successful { "agency_list" : [ { "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "agency_name" : "example-agency-name", "permission_set_name" : "example-permission-set-name", "agency_urn" : "example-agency-urn", "description" : "example agency" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 results Array of objects 成员是否在用户组内的结果列表。 数组长度:1-100 表6 results 参数 参数类型 描述 group_id String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:47 member_id Object 包含组成员标识符的对象。 membership_exists Boolean 一个布尔值,表示用户是否在组中。 表7 results.member_id 参数 参数类型 描述 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 鉴权信息。 状态码: 404 表10 响应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}/is-member-in-groups { "group_ids" : [ "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a" ], "member_id" : { "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" } }
  • 响应示例 状态码: 200 Successful { "results" : [ { "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "member_id" : { "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" }, "membership_exists" : true } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 group_ids 是 Array of strings 用户组标识符列表。 最小长度:1 最大长度:47 数组长度:1-100 member_id 是 Object 包含组成员标识符的对象。 表4 member_id 参数 是否必选 参数类型 描述 user_id 是 String 身份源中IAM身份中心用户的全局唯一标识符(ID)。 最小长度:1 最大长度:47
  • 请求参数 表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" } } }
  • 请求示例 根据用户ID和用户组ID,查询对应的关联关系ID。 POST https://{hostname}/v1/identity-stores/{identity_store_id}/group-memberships/retrieve-group-membership-id { "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "member_id" : { "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 identity_store_id String 身份源的全局唯一标识符(ID)。 membership_id String 身份源中用户和组关联关系的全局唯一标识符(ID)。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码: 403 表7 响应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参数 参数 是否必选 参数类型 描述 group_id 是 String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:47 member_id 是 Object 包含组成员标识符的对象 表4 member_id 参数 是否必选 参数类型 描述 user_id 是 String 身份源中IAM身份中心用户的全局唯一标识符(ID)。 最小长度:1 最大长度:47
  • 请求示例 根据显示名或外部身份源ID,以精确匹配的方式查询用户组ID。 POST https://{hostname}/v1/identity-stores/{identity_store_id}/groups/retrieve-group-id { "alternate_identifier" : { "external_id" : null, "unique_attribute" : { "attribute_path" : "display_name", "attribute_value" : "用户组名g1" } } }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 group_id String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:47 identity_store_id String 身份源的全局唯一标识符(ID)。 最小长度:1 最大长度:36 状态码: 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 鉴权信息。
共100000条