Tenant Cloud
Management and Audit
Cloud Organization
Identity Center User Group Management APIs
ListGroups
1. Interface Description
Interface request domain name: cic.api3.convergecloud.com.
Query user group list
Default interface request rate limit: 20 times per second.
Interface update time: 2024-12-11 12:17:58.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ListGroups |
| Version | Yes | No | String | Public parameter, The value of this interface: 2021-03-31 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| NextToken | No | Yes | 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. Example: sjdhdhw |
| Filter | No | Yes | String | Filter criterion. Format: , case-insensitive. Currently, supports only GroupName, and supports only eq (Equals) and sw (Start With). For example, Filter = "GroupName sw test" indicates querying all user groups with names starting with test; Filter = "GroupName eq testgroup" indicates querying the user group with the name testgroup. Example: user1 |
| GroupType | No | Yes | String | User group type. Manual: manually created; Synchronized: externally imported. Example: Manual |
| ZoneId | Yes | Yes | String | Space ID. Example: z-2d8shd8*** |
| FilterUsers | No | Yes | Array of String | Filtered user. IsSelected=1 will be returned for the user group associated with this user. Example: user1 |
| SortField | No | Yes | String | Sorting field, which currently only supports CreateTime. The default is the CreateTime field. Example: CreateTime |
| SortType | No | Yes | String | Sorting order. Desc: descending order; Asc: ascending order. It should be set together with SortField. Example: Desc |
| Offset | No | Yes | Int64 | Pagination offset. Do not use it together with NextToken, prioritizing using NextToken. Example: 0 |
| MaxResults | No | Yes | Int64 | Maximum number of data entries per page. Value range: 1–100. Default value: 10. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| MaxResults | Int64 | Maximum number of data entries per page. Example: 1 |
| TotalCounts | Int64 | Total number of data entries that meet the request parameter conditions. Example: 1 |
| IsTruncated | Bool | Whether the returned result is truncated. Valid values: true: truncated; false: not truncated. Example: true |
| NextToken | String | Token for querying the next page of returned results. Note: This parameter is displayed only when IsTruncated is true. Example: sjdhdhw |
| Groups | Array of GroupInfo | User group list. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter.ParamError | |
| FailedOperation.IdentityCenterNotOpen | |
| FailedOperation.ZoneIdNotExist | |
| InvalidParameter.NextTokenInvalid |