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

Usage notes

This topic provides an example on how to disable the SCIM credential whose ID is scimcred-004whl0kvfwcypbi****. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.

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 UpdateSCIMServerCredentialStatus

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

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

CredentialId String Yes scimcred-004whl0kvfwcypbi****

The ID of the SCIM credential.

NewStatus String No Disabled

The new status of the SCIM credential. Valid values:

  • Enabled: The SCIM credential is enabled.
  • Disabled: The SCIM credential is disabled.

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.

SCIMServerCredential Object

The information about the SCIM credential.

Status String Disabled

The status of the SCIM credential. Valid values:

  • Enabled: The SCIM credential is enabled.
  • Disabled: The SCIM credential is disabled.
DirectoryId String d-00fc2p61****

The ID of the directory.

CredentialId String scimcred-004whl0kvfwcypbi****

The ID of the SCIM credential.

CreateTime String 2021-11-09T08:12:52Z

The time when the SCIM credential was created.

CredentialType String BearerToken

The type of the SCIM credential.

ExpireTime String 2022-11-09T08:12:52Z

The time when the SCIM credential expires.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateSCIMServerCredentialStatus
&DirectoryId=d-00fc2p61****
&CredentialId=scimcred-004whl0kvfwcypbi****
&NewStatus=Disabled
&<Common request parameters>

Sample success responses

XML format

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

<UpdateSCIMServerCredentialStatusResponse>
    <RequestId>7C086C2F-1C66-57B3-B14E-2C1DA70727CD</RequestId>
    <SCIMServerCredential>
        <Status>Disabled</Status>
        <DirectoryId>d-00fc2p61****</DirectoryId>
        <CredentialId>scimcred-004whl0kvfwcypbi****</CredentialId>
        <CreateTime>2021-11-09T08:12:52Z</CreateTime>
        <CredentialType>BearerToken</CredentialType>
        <ExpireTime>2022-11-09T08:12:52Z</ExpireTime>
    </SCIMServerCredential>
</UpdateSCIMServerCredentialStatusResponse>

JSON format

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

{
  "RequestId" : "7C086C2F-1C66-57B3-B14E-2C1DA70727CD",
  "SCIMServerCredential" : {
    "Status" : "Disabled",
    "DirectoryId" : "d-00fc2p61****",
    "CredentialId" : "scimcred-004whl0kvfwcypbi****",
    "CreateTime" : "2021-11-09T08:12:52Z",
    "CredentialType" : "BearerToken",
    "ExpireTime" : "2022-11-09T08:12:52Z"
  }
}

Error codes

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