1. 接口描述
接口请求域名： organization.tencentcloudapi.com 。
查询用户列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListUsers。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-31。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 空间 ID。 示例值：z-00fc2p61**** |
| UserStatus | 否 | String | 用户状态 Enabled：启用， Disabled：禁用。 示例值：Enabled |
| UserType | 否 | String | 用户类型 Manual：手动创建，Synchronized：外部导入。 示例值：Manual |
| Filter | 否 | String | 过滤条件。 目前仅支持用户名，邮箱，用户userId，描述 示例值：test |
| MaxResults | 否 | Integer | 每页的最大数据条数。 取值范围：1~100。 默认值：10。 示例值：10 |
| NextToken | 否 | String | 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。 示例值：OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI= |
| FilterGroups.N | 否 | Array of String | 筛选的用户组，该用户组关联的子用户会返回IsSelected=1 示例值：["g-sjwidjssd", "g-djsiendidmd"] |
| SortField | 否 | String | 排序的字段，目前只支持CreateTime，默认是CreateTime字段 示例值：CreateTime |
| SortType | 否 | String | 排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置 示例值：Desc |
| Offset | 否 | Integer | 翻页offset. 不要与NextToken同时使用，优先使用NextToken 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCounts | Integer | 符合请求参数条件的数据总条数。 示例值：20 |
| MaxResults | Integer | 每页的最大数据条数。 示例值：10 |
| Users | Array of UserInfo | 用户列表。 示例值：[{"UserName": "test", "FirstName": "test", "LastName": "test", "DisplayName": "test", "Description": "this is user", "Email": "test@example", "UserStatus": "Enabled", "UserType": "Manual", "UserId": "u-2s334e3***", "CreateTime": "2024-03-12 12:12:12", "UpdateTime": "2024-03-12 12:12:12"}] |
| NextToken | String | 查询返回结果下一页的令牌。只有IsTruncated为true时，才显示该参数。 示例值：OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI |
| IsTruncated | Boolean | 返回结果是否被截断。取值： true：已截断。 false：未截断。 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户列表
查询用户列表
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListUsers
<公共请求参数>
{
"ZoneId": "z-2sw22w3"
}输出示例
{
"Response": {
"TotalCounts": 50,
"MaxResults": 20,
"Users": [
{
"UserName": "test",
"FirstName": "test",
"LastName": "test",
"DisplayName": "test",
"Description": "this is user",
"Email": "test@example",
"UserStatus": "Enabled",
"UserType": "Manual",
"UserId": "u-2s334e3***",
"CreateTime": "2024-03-12 12:12:12",
"UpdateTime": "2024-03-12 12:12:12"
}
],
"NextToken": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=",
"IsTruncated": true,
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
| FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
| InvalidParameter.NextTokenInvalid | 无效的nextToken |
| InvalidParameter.ParamError | 参数错误。 |
