查询用户组ID - GetGroupId
功能介绍
根据显示名或外部身份源ID，以精确匹配的方式查询用户组ID。显示名和外部身份源ID两种查询方式二选一，不支持同时传入。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
IdentityCenter:group:getGroupId | Read | - | - | - | organizations:delegatedAdministrators:list |
URI
POST /v1/identity-stores/{identity_store_id}/groups/retrieve-group-id
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
identity_store_id | 是 | String | 身份源的全局唯一标识符（ID）。 最小长度：12 最大长度：12 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Security-Token | 否 | String | 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
是 | Object | 备用标识符。 |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
group_id | String | 身份源中IAM身份中心用户组的全局唯一标识符（ID）。 最小长度：1 最大长度：47 |
identity_store_id | String | 身份源的全局唯一标识符（ID）。 最小长度：1 最大长度：36 |
状态码： 400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误信息。 |
request_id | String | 请求ID。 |
状态码： 403
参数 | 参数类型 | 描述 |
|---|---|---|
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}/groups/retrieve-group-id
{
"alternate_identifier" : {
"unique_attribute" : {
"attribute_path" : "display_name",
"attribute_value" : "用户组名g1"
}
}
} 响应示例
状态码： 200
Successful
{
"group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
"identity_store_id" : "d-a00aaaa33f"
} 状态码
请参见状态码。
错误码
请参见错误码。
