查询用户组详情 - DescribeGroup
功能介绍
根据用户组ID，查询IAM身份中心用户组的详情信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
IdentityCenter:group:describe | Read | - | - | - | organizations:delegatedAdministrators:list |
URI
GET /v1/identity-stores/{identity_store_id}/groups/{group_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
identity_store_id | 是 | String | 身份源的全局唯一标识符（ID）。 最小长度：12 最大长度：12 |
group_id | 是 | String | 身份源中IAM身份中心用户组的全局唯一标识符（ID）。 最小长度：1 最大长度：64 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Security-Token | 否 | String | 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
description | String | 包含组描述的字符串。 最小长度：1 最大长度：1024 |
display_name | String | 包含组显示名称的字符串。 最小长度：1 最大长度：1024 |
external_id | String | 外部身份源分配给此资源的标识符。 |
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 | 更新者。 |
请求示例
根据用户组ID，查询IAM身份中心用户组的详情信息。
GET https://{hostname}/v1/identity-stores/{identity_store_id}/groups/{group_id} 响应示例
状态码： 200
{
"description" : "示例用户组",
"display_name" : "用户组名g1",
"external_ids" : null,
"group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
"identity_store_id" : "d-a00aaaa33f",
"created_at" : 1677175760379,
"created_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
"updated_at" : 1677175760379,
"updated_by" : "5146d03d8aaaaaaaaaaaabbae60620a5"
} 状态码
请参见状态码。
错误码
请参见错误码。
