文档中心>API 中心>访问管理>用户相关接口>查询用户组关联的用户列表

查询用户组关联的用户列表

最近更新时间:2024-12-11 01:14:19

我的收藏

1. 接口描述

接口请求域名: cam.tencentcloudapi.com 。

查询用户组关联的用户列表

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListUsersForGroup。
Version String 公共参数,本接口取值:2019-01-16。
Region String 公共参数,本接口不需要传递此参数。
GroupId Integer 用户组 ID。
示例值:300001
Page Integer 页码。默认为1。
示例值:1
Rp Integer 每页数量。默认为20。
示例值:20

3. 输出参数

参数名称 类型 描述
TotalNum Integer 用户组关联的用户总数。
示例值:1
UserInfo Array of GroupMemberInfo 子用户信息。
示例值:[{"Uid": 1001408,"Uin": 100000545998,"Name": "IT","PhoneNum": "","CountryCode": "86","PhoneFlag": 0,"Email": "","EmailFlag": 0,"UserType": 3,"CreateTime": "2018-04-24 15:36:26","IsReceiverOwner": 0}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询用户组关联的用户列表

输入示例

https://cam.tencentcloudapi.com/?Action=ListUsersForGroup
&GroupId=2020
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalNum": 1,
        "UserInfo": [
            {
                "Uid": 1001408,
                "Uin": 100000545998,
                "Name": "group1",
                "PhoneNum": "188****8888",
                "CountryCode": "86",
                "PhoneFlag": 0,
                "Email": "user1***@tencent.com",
                "EmailFlag": 0,
                "UserType": 3,
                "CreateTime": "2018-04-24 15:36:26",
                "IsReceiverOwner": 0
            }
        ],
        "RequestId": "576e68f4-49cf-451b-b717-a584cb68910a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
ResourceNotFound.GroupNotExist 用户组不存在。