STstytch
M2M

Create

Changed on

Creates a new M2M Client. On initial client creation, you may pass in a custom client_id or client_secret to import an existing M2M client. If you do not pass in a custom client_id or client_secret, one will be generated automatically. The client_id must be unique among all clients in your project.

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

post/v1/m2m/clients

Request

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

Request body

scopesstring[] required

An array of scopes assigned to the client.

client_idstring

If provided, the ID of the client to create. If not provided, Stytch will generate this value for you. The client_id must be unique within your project.

client_secretstring

If provided, the stored secret of the client to create. If not provided, Stytch will generate this value for you. If provided, the client_secret must be at least 8 characters long and pass entropy requirements.

client_namestring

A human-readable name for the client.

client_descriptionstring

A human-readable description for 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