查询用户组中的用户列表

最近更新时间: 2026-10-12 00:11:06

1. 接口描述

接口请求域名： cic.api3.fincloud.tencent.com。

查询用户组中的用户列表

默认接口请求频率限制：20次/秒。

接口更新时间：2024-12-11 12:17:58。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：ListGroupMembers
Version	是	否	String	公共参数，本接口取值：2021-03-31
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
UserType	否	是	String	用户类型 Manual：手动创建，Synchronized：外部导入。示例值： Manual
ZoneId	是	是	String	空间 ID。示例值： z-2d8shd8***
GroupId	是	是	String	用户组ID。示例值： g-sd8sh8sdno***
NextToken	否	是	String	查询返回结果下一页的令牌。首次调用 API 不需要NextToken。当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。示例值： sjdhdhw
MaxResults	否	是	Int64	每页的最大数据条数。取值范围：1~100。默认值：10。示例值： 1

3. 输出参数

参数名称	类型	描述
NextToken	String	查询返回结果下一页的令牌。说明只有IsTruncated为true时，才显示该参数。示例值： sjdhdhw
TotalCounts	Int64	符合请求参数条件的数据总条数。示例值： 1
MaxResults	Int64	每页的最大数据条数。示例值： 1
IsTruncated	Bool	返回结果是否被截断。取值： true：已截断。 false：未截断。示例值： true
GroupMembers	Array of GroupMembers	用户组的用户列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.IdentityCenterNotOpen
FailedOperation.ZoneIdNotExist
InvalidParameter.GroupNotExist

5. 示例

示例1 查询用户组中的用户列表

输入示例

{
  "ZoneId": "z-ds932j9m3",
  "GroupId": "g29sn2389e",
  "NextToken": "",
  "MaxResults": 10
}

输出示例

{
  "Response": {
    "NextToken": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=",
    "TotalCounts": 20,
    "MaxResults": 10,
    "IsTruncated": true,
    "GroupMembers": [
      {
        "UserName": "test",
        "DisplayName": "test",
        "Description": "this is test user",
        "Email": "1234***@XXX.com",
        "UserStatus": "Enabled",
        "UserType": "Manual",
        "UserId": "u-d032med3",
        "JoinTime": "2024-01-01 12:12:12"
      }
    ],
    "RequestId": "e297543a-80de-4039-83c8-9d324545"
  }
}