查询用户组成员列表

最近更新时间: 2026-09-17 18:03:49

1. 接口描述

接口请求域名： bhsaas.api3.fincloud.tencent.cn。

查询用户组成员列表

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

接口更新时间：2025-08-29 08:48:57。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeUserGroupMembers
Version 是 否 String 公共参数，本接口取值：2019-10-18
Region 是 否 String 公共参数，地域信息本接口不需要传递此参数。
Id 是 否 Uint64 用户组ID
示例值： 1
Name 否 否 String 用户名或用户姓名，最长64个字符，模糊查询
示例值： zhangsan
Bound 是 否 Bool true - 查询已添加到该用户组的用户，false - 查询未添加到该用户组的用户
示例值： true
Offset 否 否 Uint64 分页偏移位置，默认值为0
示例值： 0
Limit 否 否 Uint64 每页条目数量，默认20, 最大500
示例值： 10
DepartmentId 否 否 String 所属部门ID
示例值： 1.2

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 用户组成员总数
示例值： 2
UserSet Array of User 用户组成员列表
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
UnsupportedOperation 操作不支持。
InvalidParameter 参数错误。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
FailedOperation.DataNotFound 目标数据不存在。

5. 示例

示例1 查询用户组成员列表

输入示例

POST / HTTP/1.1
Host: dasb.platformcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserGroupMembers
<Common Parameters>

{
    "Id": 1,
    "Name": "张三", 
    "Bound": true
}

输出示例

{
    "Response": {
        "TotalCount": 1, 
        "UserSet": [
            {
                "UserName": "xx", 
                "AuthType": 1, 
                "ValidateTo": "2020-09-22T00:00:00+00:00", 
                "RealName": "xx", 
                "ValidateTime": "xx", 
                "Email": "xx", 
                "Phone": "xx", 
                "GroupSet": [
                    {
                        "Department": {
                            "Managers": [
                                "xx"
                            ], 
                            "Id": "xx", 
                            "Name": "xx"
                        }, 
                        "Id": 1, 
                        "Name": "xx"
                    }
                ], 
                "DepartmentId": "xx", 
                "Department": {
                    "Managers": [
                        "xx"
                    ], 
                    "Id": "xx", 
                    "Name": "xx"
                }, 
                "ValidateFrom": "2020-09-22T00:00:00+00:00", 
                "Id": 1
            }
        ], 
        "RequestId": "xx"
    }
}