STstytch
M2M

Update

Changed on

Updates an existing M2M Client. You can use this endpoint to activate or deactivate an M2M Client by changing its status. A deactivated M2M Client will not be allowed to perform future token exchange flows until it is reactivated.

Important: Deactivating an M2M Client will not invalidate any existing JWTs issued to the client, only prevent it from receiving new ones. To protect more-sensitive routes, pass a lower max_token_age value whenauthenticating the tokenauthenticating the token.

put/v1/m2m/clients/{client_id}

Request

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

Path parameters

client_idstring required

The ID of the client.

Request body

client_namestring

A human-readable name for the client.

client_descriptionstring

A human-readable description for the client.

status'active' | 'inactive'
scopesstring[]

An array of scopes assigned to the client.

trusted_metadataobject

The trusted_metadata field contains an arbitrary JSON object of application-specific data. See the Metadata reference for complete field behavior details.

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