Stytch · Schema

api_connectedapps_v1_connected_apps_clients_CreateRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
client_type object The type of Connected App. Supported values are `first_party`, `first_party_public`, `third_party`, and `third_party_public`.
client_name string A human-readable name for the client.
client_description string A human-readable description for the client.
redirect_urls array Array of redirect URI values for use in OAuth Authorization flows.
full_access_allowed boolean 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_minutes integer The number of minutes before the access token expires. The default is 60 minutes.
access_token_custom_audience string The custom audience for the access token.
access_token_template_content string The content of the access token custom claims template. The template must be a valid JSON object.
post_logout_redirect_urls array Array of redirect URI values for use in OIDC Logout flows.
logo_url string The logo URL of the Connected App, if any.
bypass_consent_for_offline_access boolean Valid for first party clients only. If true, the client does not need to request explicit user consent for the `offline_access` scope.
View JSON Schema on GitHub

JSON Schema

stytch-api-connectedapps-v1-connected-apps-clients-createrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_connectedapps_v1_connected_apps_clients_CreateRequest",
  "title": "api_connectedapps_v1_connected_apps_clients_CreateRequest",
  "type": "object",
  "properties": {
    "client_type": {
      "$ref": "#/components/schemas/api_connectedapps_v1_CreateRequestClientType",
      "description": "The type of Connected App. Supported values are `first_party`, `first_party_public`, `third_party`, and `third_party_public`."
    },
    "client_name": {
      "type": "string",
      "description": "A human-readable name for the client."
    },
    "client_description": {
      "type": "string",
      "description": "A human-readable description for the client."
    },
    "redirect_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of redirect URI values for use in OAuth Authorization flows."
    },
    "full_access_allowed": {
      "type": "boolean",
      "description": "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_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "The number of minutes before the access token expires. The default is 60 minutes."
    },
    "access_token_custom_audience": {
      "type": "string",
      "description": "The custom audience for the access token."
    },
    "access_token_template_content": {
      "type": "string",
      "description": "The content of the access token custom claims template. The template must be a valid JSON object."
    },
    "post_logout_redirect_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of redirect URI values for use in OIDC Logout flows."
    },
    "logo_url": {
      "type": "string",
      "description": "The logo URL of the Connected App, if any."
    },
    "bypass_consent_for_offline_access": {
      "type": "boolean",
      "description": "Valid for first party clients only. If true, the client does not need to request explicit user consent for the `offline_access` scope."
    }
  },
  "description": "Request type",
  "required": [
    "client_type"
  ]
}