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

列出用户组 - ListGroups

功能介绍

查询指定身份源下的IAM身份中心用户组列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

IdentityCenter:group:list

Read

-

-

-

organizations:delegatedAdministrators:list

URI

GET /v1/identity-stores/{identity_store_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

是

String

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

最小长度：12

最大长度：12

表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

分页标记。

最小长度：24

最大长度：24

limit

否

Integer

每个请求返回的最大结果数。

最小值：1

最大值：100

缺省值：100

display_name

否

String

通过显示名模糊查询用户组信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

最大长度：2048

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

groups

Array of objects

满足查询条件的用户组对象列表。

page_info

Object

包含分页信息的对象。

表5 groups

参数

参数类型

描述

description

String

包含用户组描述的字符串。

最小长度：1

最大长度：1024

display_name

String

包含用户组显示名称的字符串。

最小长度：1

最大长度：1024

external_id

String

外部身份源分配给此资源的标识符

external_ids

Array of objects

包含外部身份提供商颁发给此资源的标识符的对象列表。

数组长度：0-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

更新者。

表6 groups.external_ids

参数

参数类型

描述

id

String

外部身份提供商颁发给此资源的标识符。

最小长度：1

最大长度：256

issuer

String

外部标识符的颁发者。

最小长度：1

最大长度：100

表7 page_info

参数

参数类型

描述

next_marker

String

如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。

current_count

Integer

本页返回条目数量。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

加密的错误信息。

请求示例

查询指定身份源下的IAM身份中心用户组列表。

GET https://{hostname}/v1/identity-stores/{identity_store_id}/groups

响应示例

状态码： 200

Successful

{
  "groups" : [ {
    "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"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题：用户组管理