Tenant Cloud
Management and Audit
Cloud Organization
Identity Center Sub-User Synchronization Management APIs
ListUserSyncProvisionings
1. Interface Description
Interface request domain name: cic.api3.convergecloud.com.
This API is used to query the CAM user synchronization 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: ListUserSyncProvisionings |
| 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. |
| TargetUin | No | Yes | Int64 | UIN of the target account of the TCO. Example: 111111111111 |
| TargetType | No | Yes | String | Type of the synchronized target account of the TCO. ManagerUin: admin account; MemberUin: member account. Example: MemberUin |
| Filter | No | Yes | String | Detection condition. Example: user1 |
| ZoneId | Yes | Yes | String | Space ID. Example: z-2d8shd8*** |
| PrincipalId | No | Yes | String | User synchronization ID. Valid values: When PrincipalType is Group, it is a user group ID (g-). When PrincipalType is User, it is a user ID (u-). Example: u-xuec8dnd |
| 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 |
| MaxResults | No | Yes | Int64 | Maximum number of data entries per page. Value range: 1–100. Default value: 10. Example: 1 |
| PrincipalType | No | Yes | String | Type of the object for CAM user synchronization. Valid values: User: an Identity Center user. Group: an Identity Center user group. Example: User |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| MaxResults | Int64 | Maximum number of data entries per page. Example: 1 |
| IsTruncated | Bool | Whether the returned result is truncated. Valid values: true: truncated; false: not truncated. Example: true |
| UserProvisionings | Array of UserProvisioning | User list of the CAM synchronization. Example:View |
| NextToken | String | Token for querying the next page of returned results. Note: This parameter is displayed only when IsTruncated is true. Example: sjdhdhw |
| TotalCounts | Int64 | Total number of data entries that meet the request parameter conditions. Example: 1 |
| 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 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | |
| FailedOperation.ZoneIdNotExist | |
| InvalidParameter.NextTokenInvalid |