文档首页/ IAM 身份中心/ API参考/ API/ 用户组管理/ 查询用户组ID
更新时间：2024-04-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用户组ID

功能介绍

根据显示名或外部身份源ID，以精确匹配的方式查询用户组ID。显示名和外部身份源ID两种查询方式二选一，不支持同时传入。

URI

POST /v1/identity-stores/{identity_store_id}/groups/retrieve-group-id

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

是

String

身份源的全局唯一标识符（ID）。

最小长度：12

最大长度：12

请求参数

表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参数

参数

参数类型

描述

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

鉴权信息。

请求示例

根据显示名或外部身份源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

Successful

{
  "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "identity_store_id" : "d-a00aaaa33f"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 用户组管理