All Products
Search
Document Center

CloudSSO:CreateSCIMServerCredential

Last Updated:Mar 28, 2024

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

Operation description

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****.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cloudsso:CreateSCIMServerCredentialWrite
  • SCIMServerCredential
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/scim-credential/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2D2E5180-7ACF-57FF-A56C-26A49ABEBFF7
SCIMServerCredentialobject

The information about the SCIM credential.

Statusstring

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

Enabled
DirectoryIdstring

The ID of the directory.

d-00fc2p61****
CredentialIdstring

The ID of the SCIM credential.

scimcred-004whl0kvfwcypbi****
CreateTimestring

The time when the SCIM credential was created.

2021-11-09T08:12:52Z
CredentialTypestring

The type of the SCIM credential.

BearerToken
ExpireTimestring

The time when the SCIM credential expires.

2022-11-09T08:12:52Z
CredentialSecretstring

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.
8aAJCtpbyPJ8saXeYDgyw****

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.