Creates a Cross-domain Identity Management (SCIM) credential.

Usage notes

SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.

This topic provides an example on how to create a SCIM credential 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 CreateSCIMServerCredential

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

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 2D2E5180-7ACF-57FF-A56C-26A49ABEBFF7

The ID of the request.

SCIMServerCredential Object

The information about the SCIM credential.

Status String Enabled

The status of the SCIM credential. The value is fixed as Enabled, which indicates that the SCIM credential is enabled.

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.

CredentialSecret String 8aAJCtpbyPJ8saXeYDgyw****

The SCIM credential.

Note The SCIM credential is returned only when it is created. After the SCIM credential is created, you cannot query it. Keep the SCIM credential confidential.

Examples

Sample requests

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

Sample success responses

XML format

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

<CreateSCIMServerCredentialResponse>
    <RequestId>2D2E5180-7ACF-57FF-A56C-26A49ABEBFF7</RequestId>
    <SCIMServerCredential>
        <Status>Enabled</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>
        <CredentialSecret>8aAJCtpbyPJ8saXeYDgyw****</CredentialSecret>
    </SCIMServerCredential>
</CreateSCIMServerCredentialResponse>

JSON format

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

{
  "RequestId" : "2D2E5180-7ACF-57FF-A56C-26A49ABEBFF7",
  "SCIMServerCredential" : {
    "Status" : "Enabled",
    "DirectoryId" : "d-00fc2p61****",
    "CredentialId" : "scimcred-004whl0kvfwcypbi****",
    "CreateTime" : "2021-11-09T08:12:52Z",
    "CredentialType" : "BearerToken",
    "ExpireTime" : "2022-11-09T08:12:52Z",
    "CredentialSecret" : "8aAJCtpbyPJ8saXeYDgyw****"
  }
}

Error codes

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