查询用户列表

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

1. 接口描述

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

查询用户列表

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

接口更新时间：2023-09-06 01:35:19。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeUsers
Version	是	否	String	公共参数，本接口取值：2019-10-18
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
IdSet	否	否	Array of Uint64	如果IdSet不为空，则忽略其他参数示例值： [1,2]
Name	否	否	String	模糊查询，IdSet、UserName、Phone为空时才生效，对用户名和姓名进行模糊查询示例值： zhangsan
Offset	否	否	Uint64	分页偏移位置，默认值为0 示例值： 0
Limit	否	否	Uint64	每页条目数量，默认20, 最大500 示例值： 10
UserName	否	否	String	精确查询，IdSet为空时才生效示例值： zhangsan
Phone	否	否	String	精确查询，IdSet、UserName为空时才生效。大陆手机号直接填写，如果是其他国家、地区号码,按照"国家地区代码
Email	否	否	String	邮箱，精确查询示例值： 109****@email.com
AuthorizedDeviceIdSet	否	否	Array of Uint64	查询具有指定资产ID访问权限的用户示例值： [1,2]
AuthorizedAppAssetIdSet	否	是	Array of Uint64	查询具有指定应用资产ID访问权限的用户示例值： [1,2]
AuthTypeSet	否	否	Array of Uint64	认证方式，0 - 本地, 1 - LDAP, 2 - OAuth, 不传为全部示例值： [0,1]
DepartmentId	否	否	String	部门ID，用于过滤属于某个部门的用户示例值： 1.2.3
Filters	否	否	Array of Filter	参数过滤数组示例值：查看

3. 输出参数

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

4. 错误码

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

错误码	描述
UnsupportedOperation	操作不支持。
InvalidParameter	参数错误。
InternalError	内部错误。
ResourceNotFound	资源不存在。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 查询用户列表

查询用户列表

输入示例

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

{}

输出示例

{
    "Response": {
        "TotalCount": 1, 
        "UserSet": [
            {
                "UserName": "jassls", 
                "AuthType": 1, 
                "ValidateTo": "2020-09-22T00:00:00+00:00", 
                "RealName": "张宏宇", 
                "ValidateTime": "2020-09-23T00:00:00+00:00", 
                "Email": "xxx@company.com", 
                "Phone": "+86|13500000001", 
                "GroupSet": [
                    {
                        "Department": {
                            "Managers": [
                                "152017423"
                            ], 
                            "Id": "1.2", 
                            "Name": "研发部"
                        }, 
                        "Id": 1, 
                        "Name": "运维组",
                        "Count":1
                    }
                ], 
                "Department": {
                    "Managers": [
                        "152017423"
                    ], 
                    "Id": "1.2", 
                    "Name": "研发部"
                }, 
                "ValidateFrom": "2020-09-22T00:00:00+00:00", 
                "Id": 1
            }
        ], 
        "RequestId": "cf839eee-b651-4ff3-9b49-173f9f55733f"
    }
}

示例2 根据主机查询有访问权限的用户信息

根据主机查询有访问权限的用户信息

输入示例

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

{
  "AuthorizedDeviceIdSet": [63,64,82,100],
  "Name": "zhanghongyu"
}

输出示例

{
    "Response": {
        "TotalCount": 1, 
        "UserSet": [
            {
                "UserName": "jassls", 
                "AuthType": 1, 
                "ValidateTo": "2020-09-22T00:00:00+00:00", 
                "RealName": "张宏宇", 
                "ValidateTime": "2020-09-23T00:00:00+00:00", 
                "Email": "xxx@company.com", 
                "Phone": "+86|13500000001", 
                "GroupSet": [
                    {
                        "Department": {
                            "Managers": [
                                "152017423"
                            ], 
                            "Id": "1.2", 
                            "Name": "研发部"
                        }, 
                        "Id": 1, 
                        "Name": "运维组",
                        "Count":1
                    }
                ], 
                "Department": {
                    "Managers": [
                        "152017423"
                    ], 
                    "Id": "1.2", 
                    "Name": "研发部"
                }, 
                "ValidateFrom": "2020-09-22T00:00:00+00:00", 
                "Id": 1
            }
        ], 
        "RequestId": "cf839eee-b651-4ff3-9b49-173f9f55733f"
    }
}