Rotate SCIM Directory Bearer Token

POST

Rotates a SCIM directory’s bearer token.

Every SCIM directory has a bearer token that SSOReady uses to authenticate requests sent from your customer’s Identity Provider. These bearer tokens are assigned by SSOReady, and are secret. Newly-created SCIM directories do not have any bearer token at all; you must use this endpoint to get an initial value.

Rotating a SCIM directory bearer token immediately invalidates the previous bearer token, if any. Your customer will need to update their SCIM configuration with the new value to make SCIM syncing work again.

SSOReady only stores the hash of these bearer tokens. If your customer has lost their copy, you must use this endpoint to generate a new one.

Path parameters

idstringRequired
The ID of the SCIM directory whose bearer token to rotate.

Response

This endpoint returns an object.
bearerTokenstringOptional

The new, updated bearer token.

Do not log or store this bearer token. It is an authentication token that your customer should securely input into their Identity Provider.