获取用户列表信息

最近更新时间：2022-02-24 08:07:59

我的收藏

本页目录：

1. 接口描述

接口请求域名： eiam.tencentcloudapi.com 。

获取用户列表信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
本文档展示的是V1签名的参数说明，腾讯云建议您使用安全系数更高的V3签名算法，使用签名方法 v3 时，公共参数需要统一放到 HTTP Header 请求头部中，详情。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListUsers。
Version	是	String	公共参数，本接口取值：2021-04-20。
Region	否	String	公共参数，本接口不需要传递此参数。
SearchCondition	否	UserSearchCriteria	用户属性搜索条件，可查询条件包括：用户名、手机号码，邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间，支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（）结尾表示字段部分匹配、中括号以逗号分隔（[Min，Max]）表示闭区间查询、大括号以逗号分隔（{Min，Max}）表示开区间查询，中括号与大括号可以配合使用（例如：{Min，Max]表示最小值开区间，最大值闭区间查询）。范围匹配支持使用星号（例如{20,]表示查询范围为大于20的所有数据）。范围查询同时支持时间段查询，支持的属性包括创建时间（CreationTime）、上次修改时间（LastUpdateTime），查询的时间格式遵循 ISO 8601 标准，例如：2021-01-13T09:44:07.182+0000。
ExpectedFields.N	否	Array of String	指定期望返回的用户属性，默认返回所有用户内置属性。内置用户属性包括：用户UUID（UserId）、用户昵称（DisplayName）、用户名字（UserName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、用户组（SubjectGroups）机构路径（OrgPath）、备注（Description）、创建时间（CreationTime）、上次修改时间（LastUpdateTime）、上次登录时间（LastLoginTime）。
Sort	否	SortCondition	排序条件集合。可排序的属性支持：用户名字（UserName）、用户昵称（DisplayName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、创建时间（CreationTime）、上次修改时间（LastUpdateTime）、上次登录时间（LastLoginTime）。如果不指定，则默认按照用户昵称（DisplayName）正向排序。
Offset	否	Integer	分页偏移量，默认为0。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。如果不指定以上参数，则表示不进行分页查询，即只返回最多1000个用户。
Limit	否	Integer	分页读取数量，默认为50，最大值为100。 Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。如果不指定以上参数，则表示不进行分页查询，即只返回最多1000个用户。
IncludeTotal	否	Boolean	是否查看搜索结果的总数，默认该选项为false不查看。

3. 输出参数

参数名称	类型	描述
UserList	Array of UserInformation	查询返回的相关用户列表。注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	返回查询用户的总数量，仅当入参IncludeTotal等于true时返回。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListUsers
<公共请求参数>

{
    "SearchCondition": {
        "Keyword": "\"\""
    },
    "ExpectedFields": [
        "UserId",
        "UserName",
        "DisplayName",
        "LastUpdateTime",
        "Status"
    ],
    "Sort": {
        "SortKey": "LastUpdateTime",
        "SortOrder": "ASC"
    },
    "Limit": 2,
    "Offset": 0,
    "IncludeTotal": true
}

输出示例

{
  "Response": {
    "TotalCount": 0,
    "RequestId": "2151788c-45ac-47be-8a6f-5ca114fcfbeb",
    "UserList": []
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ExpectFieldsNotFound	期望返回的用户属性类型不存在。
FailedOperation.OperationError	操作失败。
InvalidParameter.SearchCriteriaIllegal	列表搜索条件不合法。
InvalidParameter.TimeFormatIllegal	时间格式不合法。
InvalidParameter.UserInfoSortKeyIsIllegal	用户信息分页展示的排列属性不合法。
InvalidParameterValue.ParameterIllegal	参数不合法。

上一篇: 修改用户下一篇: 获取用户组列表信息