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.
A human-readable name for the client.
A human-readable description for the client.
The type of Connected App. Supported values are first_party, first_party_public, third_party, and third_party_public.
Array of redirect URI values for use in OAuth Authorization flows.
Array of redirect URI values for use in OIDC Logout flows.
Valid for first party clients only. If true, an authorization token granted to this Client can be exchanged for a full Stytch session.
The number of minutes before the access token expires. The default is 60 minutes.
The custom audience for the access token.
The content of the access token custom claims template. The template must be a valid JSON object.
The logo URL of the Connected App, if any.
Valid for first party clients only. If true, the client does not need to request explicit user consent for the offline_access scope.
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.
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.
The Connected App created by this API call.
The ID of the Connected App client.
The type of Connected App. Supported values are first_party, first_party_public, third_party, and third_party_public.
A human-readable description for the client.
A human-readable name for the client.
The last four characters of the client secret.
The last four characters of the next_client_secret. Null if no next_client_secret exists.
Valid for first party clients only. If true, an authorization token granted to this Client can be exchanged for a full Stytch session.
The logo URL of the Connected App, if any.
Array of redirect URI values for use in OAuth Authorization flows.
Array of redirect URI values for use in OIDC Logout flows.
Array of redirect URI values for use in OAuth Authorization flows.
Array of OAuth 2.0 response types that the client may use.
Authentication method used by the client for the token endpoint.
Valid for first party clients only. If true, the client does not need to request explicit user consent for the offline_access scope.
The secret of the Connected App client. Required for confidential clients
const stytch = require('stytch');
const client = new stytch.Client({
project_id: 'PROJECT_ID',
secret: 'SECRET',
});
const params = {
client_type: "first_party",
client_name: "My Sample Client",
client_description: "My sample client for testing out Connected Apps",
redirect_urls: ["https://example.com/callback"],
full_access_allowed: false,
};
client.connectedApp.clients.create(params)
.then(resp => { console.log(resp) })
.catch(err => { console.log(err) });{
"connected_app": {
"client_id": "connected-app-test-d731954d-dab3-4a2b-bdee-07f3ad1be888",
"client_name": "My Connected App",
"client_description": "App for internal tools",
"status": "active",
"client_secret": "s3cr3t_v4lu3",
"client_secret_last_four": "v4lu3",
"next_client_secret_last_four": null,
"full_access_allowed": false,
"client_type": "first_party",
"redirect_urls": ["https://myapp.com/callback"],
"access_token_expiry_minutes": 60,
"access_token_custom_audience": "https://api.myapp.com",
"access_token_template_content": "{}",
"post_logout_redirect_urls": ["https://myapp.com/logout"],
"logo_url": "https://myapp.com/logo.png",
"bypass_consent_for_offline_access": false
}
}{
"status_code": 401,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "unauthorized_credentials",
"error_message": "Unauthorized credentials.",
"error_url": "https://stytch.com/docs/api/errors/401"
}{
"status_code": 429,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "too_many_requests",
"error_message": "Too many requests have been made.",
"error_url": "https://stytch.com/docs/api/errors/429"
}{
"status_code": 500,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "internal_server_error",
"error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
"error_url": "https://stytch.com/docs/api/errors/500"
}