Enables or disables Cross-domain Identity Management (SCIM) synchronization.

Usage notes

You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:

  • After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
  • After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.

This topic provides an example on how to enable SCIM synchronization within the directory d-00fc2p61****.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SetSCIMSynchronizationStatus

The operation that you want to perform. Set the value to SetSCIMSynchronizationStatus.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

SCIMSynchronizationStatus String No Enabled

The status of SCIM synchronization. Valid values:

  • Enabled
  • Disabled

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=SetSCIMSynchronizationStatus
&DirectoryId=d-00fc2p61****
&SCIMSynchronizationStatus=Enabled
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<SetSCIMSynchronizationStatusResponse>
    <RequestId>3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01</RequestId>
</SetSCIMSynchronizationStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01"
}

Error codes

For a list of error codes, visit the API Error Center.