
# 批量查询指定用户组详情 - DescribeGroups
#### 功能介绍
批量查询指定用户组详情。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-identitycenter/iic_04_0028.html)。
| 授权项                                 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项                                     |
|:---|:---|:---|:---|:---|:---|
| IdentityCenter:group:describeGroups | Read | -           | -   | -  | organizations:delegatedAdministrators:list |
   
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IdentityCenter/doc?api=DescribeGroups)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
POST /v1/identity-stores/{identity_store_id}/groups/batch-query
表1路径参数 
| 参数                | 是否必选 | 参数类型   | 描述              |
|:---|:---|:---|:---|
| identity_store_id | 是    | String | 身份源的全局唯一标识符（ID） |
   
#### 请求参数
表2请求Header参数 
| 参数               | 是否必选 | 参数类型   | 描述                                              |
|:---|:---|:---|:---|
| X-Security-Token | 否    | String | 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
   
表3请求Body参数 
| 参数        | 是否必选 | 参数类型             | 描述             |
|:---|:---|:---|:---|
| group_ids | 是    | Array of strings | 用户组唯一标识符（ID）列表 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数     | 参数类型                                                                              | 描述    |
|:---|:---|:---|
| groups | Array of [DescribeGroupResp] objects | 用户组列表 |
   
 表5DescribeGroupResp 
| 参数                | 参数类型                                                                      | 描述                                |
|:---|:---|:---|
| description       | String                                                                    | 包含组描述的字符串                         |
| display_name      | String                                                                    | 包含组显示名称的字符串                       |
| external_id       | String                                                                    | 外部身份源分配给此资源的标识符                   |
| external_ids      | Array of [ExternalIdDto] objects | 包含外部身份提供商颁发给此资源的标识符的对象列表          |
| group_id          | String                                                                    | 身份源中IdentityCenter用户组的全局唯一标识符（ID） |
| identity_store_id | String                                                                    | 身份源的全局唯一标识符（ID）                   |
| created_at        | Long                                                                      | 创建时的时间戳                           |
| created_by        | String                                                                    | 创建者                               |
| updated_at        | Long                                                                      | 更新时的时间戳                           |
| updated_by        | String                                                                    | 更新者                               |
   
 表6ExternalIdDto 
| 参数     | 参数类型   | 描述                |
|:---|:---|:---|
| id     | String | 外部身份提供商颁发给此资源的标识符 |
| issuer | String | 外部标识符的颁发者         |
   
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述     |
|:---|:---|:---|
| error_code | String | 错误码    |
| error_msg  | String | 错误信息   |
| request_id | String | 请求唯一标识 |
   
**状态码：403**
表8响应Body参数 
| 参数                            | 参数类型   | 描述      |
|:---|:---|:---|
| error_code                    | String | 错误码     |
| error_msg                     | String | 错误信息    |
| request_id                    | String | 请求唯一标识  |
| encoded_authorization_message | String | 加密的错误信息 |
   
#### 请求示例
批量查询指定用户组详情
```
POST https://{hostname}/v1/identity-stores/{identity_store_id}/groups/batch-query
{
  "group_ids" : [ "749aa4a2-6774-4fbb-aefa-94c68cf15a81" ]
}
```
#### 响应示例
**状态码：200**
Successful
```
[ {
  "description" : "description",
  "display_name" : "group test",
  "group_id" : "749aa4a2-6774-4fbb-aefa-94c68cxxxx1",
  "identity_store_id" : "d-a23adaxxxx",
  "created_at" : 1753794050369,
  "created_by" : "9ec6f4f5dd28485cbcdd9804c5428331",
  "updated_at" : 1753794050369,
  "updated_by" : "9ec6f4f5dd28485cbcdd9804c5428331"
} ]
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | Successful  |
| 400 | Bad request |
| 403 | Forbidden   |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-identitycenter/ErrorCode.html)。
