Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.

Usage notes

This topic provides an example on how to query the status of SCIM synchronization within the directory d-00fc2p61****. The returned result shows that SCIM synchronization is in the Enabled state.

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 GetSCIMSynchronizationStatus

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

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

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

Response parameters

Parameter Type Example Description
RequestId String 7C086C2F-1C66-57B3-B14E-2C1DA70727CD

The ID of the request.

SCIMSynchronizationStatus String Enabled

The status of SCIM synchronization. Valid values:

  • Enabled
  • Disabled

Examples

Sample requests

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

Sample success responses

XML format

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

<GetSCIMSynchronizationStatusResponse>
    <RequestId>7C086C2F-1C66-57B3-B14E-2C1DA70727CD</RequestId>
    <SCIMSynchronizationStatus>Enabled</SCIMSynchronizationStatus>
</GetSCIMSynchronizationStatusResponse>

JSON format

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

{
  "RequestId" : "7C086C2F-1C66-57B3-B14E-2C1DA70727CD",
  "SCIMSynchronizationStatus" : "Enabled"
}

Error codes

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