Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to create sub-user synchronization tasks.
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: UpdateUserSyncProvisioning. |
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. |
UserProvisioningId | Yes | String | User synchronization ID. |
NewDescription | No | String | User synchronization description. |
NewDuplicationStateful | No | 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. |
NewDeletionStrategy | No | 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. |
Parameter Name | Type | Description |
---|---|---|
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 modify the CAM user synchronization.
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateUserSyncProvisioning
<Common request parameters>
{
"ZoneId": "z-susn8xnsis",
"UserProvisioningId": "up-xusjdjsss",
"NewDescription": "this is cam user sync",
"NewDuplicationStateful": "KeepBoth",
"NewDeletionStrategy": "Delete"
}
{
"Response": {
"RequestId": "e297543a-80de-4039-83c8-9d324545"
}
}
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. |
ResourceNotFound.UserProvisioningNotFound | The user synchronization does not exist. |
Was this page helpful?