Tenant Cloud
Management and Audit
Cloud Organization
Identity Center Sub-User Synchronization Management APIs
UpdateUserSyncProvisioning
1. Interface Description
Interface request domain name: cic.api3.convergecloud.com.
This API is used to create sub-user synchronization tasks.
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: UpdateUserSyncProvisioning |
| 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. |
| NewDescription | No | Yes | String | User synchronization description. Example: description |
| NewDuplicationStateful | No | Yes | String | Conflict policy. It indicates the handling policy for existence of a user with the same username when CIC users are synchronized to CAM. Valid values: KeepBoth: Keep both, that is, add the _cic suffix to the CIC user's username and then try to create a CAM user with the username when CIC users are synchronized to CAM and a user with the same username already exists in CAM; TakeOver: Replace, that is, directly replace the existing CAM user with the synchronized CIC user when CIC users are synchronized to CAM and a user with the same username already exists in CAM. . Example: KeepBoth |
| NewDeletionStrategy | No | Yes | String | Deletion policy. It indicates the handling policy for CAM users already synchronized when the CAM user synchronization is deleted. Valid values: Delete: Delete the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted; Keep: Keep the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted. . Example: Delete |
| ZoneId | Yes | Yes | String | Space ID. Example: z-2d8shd8*** |
| UserProvisioningId | Yes | Yes | String | User synchronization ID. Example: up-sjisnw8ois |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| 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 | |
| ResourceNotFound.UserProvisioningNotFound |