STstytch
Clients

Rotatestart

Changed on

Initiate the rotation of an M2M client secret. After this endpoint is called, both the client's client_secret and next_client_secret will be valid. To complete the secret rotation flow, update all usages of client_secret to next_client_secret and call the Rotate Secret EndpointRotate Secret Endpoint to complete the flow.Secret rotation can be cancelled using the Rotate Cancel EndpointRotate Cancel Endpoint.

Important: This is the only time you will be able to view the generated next_client_secret in the API response. Stytch stores a hash of the next_client_secret and cannot recover the value if lost. Be sure to persist the next_client_secret in a secure location. If the next_client_secret is lost, you will need to trigger a secret rotation flow to receive another one.

post/v1/m2m/clients/{client_id}/secrets/rotate/start

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Path parameters

client_idstring required

The ID of the client.

Request body

ApiM2mV1M2mClientsSecretsRotateStartRequest required

Request type

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

Changes