1. 接口描述
接口请求域名： bhsaas.api3.fincloud.tencent.cn。
查询用户列表
默认接口请求频率限制：20次/秒。
接口更新时间：2022-08-29 14:29:22。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeUsers |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-10-18 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| IdSet | 否 | 否 | Array of Uint64 | 如果IdSet不为空，则忽略其他参数 示例值： |
| Name | 否 | 否 | String | 模糊查询，IdSet、UserName、Phone为空时才生效，对用户名和姓名进行模糊查询 示例值： |
| Offset | 否 | 否 | Uint64 | 分页，偏移位置 示例值： |
| Limit | 否 | 否 | Uint64 | 每页条目数量，默认20, 最大500 示例值： |
| UserName | 否 | 否 | String | 精确查询，IdSet为空时才生效 示例值： |
| Phone | 否 | 否 | String | 精确查询，IdSet、UserName为空时才生效。 大陆手机号直接填写，如果是其他国家、地区号码,按照"国家地区代码 |
| AuthorizedDeviceIdSet | 否 | 否 | Array of Uint64 | 查询具有指定资产ID访问权限的用户 示例值： |
| AuthTypeSet | 否 | 否 | Array of Uint64 | 认证方式，0 - 本地, 1 - LDAP, 2 - OAuth, 不传为全部 示例值： |
| DepartmentId | 否 | 否 | String | 部门ID，用于过滤属于某个部门的用户 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 用户总数 示例值： |
| UserSet | Array of User | 用户列表 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameterValue | 参数取值错误。 |