STstytch
Connected Apps

Create

Changed on

Creates a new Connected App. If the Connected App client_type is first_party or third_party a client_secret is returned.

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/connected_apps/clients

Request

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

Request body

client_type'first_party' | 'first_party_public' | 'third_party' | 'third_party_public' required
client_namestring

A human-readable name for the client.

client_descriptionstring

A human-readable description for the client.

redirect_urlsstring[]

Array of redirect URI values for use in OAuth Authorization flows.

full_access_allowedboolean

Valid for first party clients only. If true, an authorization token granted to this Client can be exchanged for a full Stytch session.

access_token_expiry_minutesinteger

The number of minutes before the access token expires. The default is 60 minutes.

access_token_custom_audiencestring

The custom audience for the access token.

access_token_template_contentstring

The content of the access token custom claims template. The template must be a valid JSON object.

post_logout_redirect_urlsstring[]

Array of redirect URI values for use in OIDC Logout flows.

logo_urlstring

The logo URL of the Connected App, if any.

bypass_consent_for_offline_accessboolean

Valid for first party clients only. If true, the client does not need to request explicit user consent for the offline_access scope.

id_token_template_contentstring

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