Queries Cross-domain Identity Management (SCIM) credentials.
Usage notes
This topic provides an example on how to query the SCIM credentials within the d-00fc2p61****
directory.
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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListSCIMServerCredentials |
The operation that you want to perform. Set the value to ListSCIMServerCredentials. |
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 | FE4B7037-C315-5DD5-826E-57A87950BCD1 |
The ID of the request. |
TotalCounts | Integer | 1 |
The total number of entries returned. |
SCIMServerCredentials | Array of SCIMServerCredential |
The SCIM credentials. |
|
Status | String | Enabled |
The status of the SCIM credential. Valid values:
|
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=ListSCIMServerCredentials
&DirectoryId=d-00fc2p61****
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListSCIMServerCredentialsResponse>
<RequestId>FE4B7037-C315-5DD5-826E-57A87950BCD1</RequestId>
<TotalCounts>1</TotalCounts>
<SCIMServerCredentials>
<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>
</SCIMServerCredential>
</SCIMServerCredentials>
</ListSCIMServerCredentialsResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "FE4B7037-C315-5DD5-826E-57A87950BCD1",
"TotalCounts" : 1,
"SCIMServerCredentials" : [ {
"Status" : "Enabled",
"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.