Domain name for API request: organization.tencentcloudapi.com.
This API is used to query the user list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ListUsers. |
Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | Yes | String | Space ID. |
UserStatus | No | String | User status: Enabled, Disabled. |
UserType | No | String | User type. Manual: manually created; Synchronized: externally imported. |
Filter | No | String | Filter criterion, which currently only supports username, email address, userId, and description. |
MaxResults | No | Integer | Maximum number of data entries per page. Value range: 1-100. Default value: 10. |
NextToken | No | String | Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried. |
FilterGroups.N | No | Array of String | Filtered user group. IsSelected=1 will be returned for the sub-user associated with this user group. |
SortField | No | String | Sorting field, which currently only supports CreateTime. The default is the CreateTime field. |
SortType | No | String | Sorting type. Desc: descending order; Asc: ascending order. It should be set along with SortField. |
Parameter Name | Type | Description |
---|---|---|
TotalCounts | Integer | Total number of data entries that meet the request parameter conditions. |
MaxResults | Integer | Maximum number of data entries per page. |
Users | Array of UserInfo | User list. |
NextToken | String | Token for querying the next page of returned results. This parameter is displayed only when IsTruncated is true. |
IsTruncated | Boolean | Whether the returned result is truncated. Valid values: true: truncated; false: not truncated. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the user list.
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListUsers
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.IdentityCenterNotOpen | The CIC service is not enabled. |
FailedOperation.ZoneIdNotExist | The user zoneId of the CIC service does not exist. |
InvalidParameter.NextTokenInvalid | Invalid nextToken. |
InvalidParameter.ParamError | Parameter error. |
この記事はお役に立ちましたか?