Auth

Rotate API Client Secret

Replaces the client secret for the specified API client credentials.

This method can be used to rotate a secret for the API credentials specified in the request body. To replace the client secret for the access key passed in the Authorization header, you can also use Rotate Current API Client Secret.

Once replaced, the old client secret can't be used to authenticate or obtain new tokens. However, access tokens that were issued before the rotation remain valid until they expire. This means there is an effective grace period of up to 12 hours where previously issued access tokens continue to work, even though the client secret used to obtain them has been rotated.

post/v1/api-credentials/{clientId}/rotate

Request

  • Base URL: https://%7Baccount-domain%7D.console.eon.io/api
  • URL: https://%7Baccount-domain%7D.console.eon.io/api/v1/api-credentials/{clientId}/rotate
  • Auth: HTTP bearer

Path parameters

clientIdstring required

API client ID.

Response

Client secret rotated.

clientIdstring required

API client ID.

clientSecretstring required

API client secret.

Changes

No recorded changes to this operation across all 1 revision of this API.