Stytch · Schema

api_connectedapps_v1_ConnectedApp

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
client_id string The ID of the Connected App client.
client_name string A human-readable name for the client.
client_description string A human-readable description for the client.
status string
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.
client_type string The type of Connected App. Supported values are `first_party`, `first_party_public`, `third_party`, and `third_party_public`.
redirect_urls array Array of redirect URI values for use in OAuth Authorization flows.
access_token_expiry_minutes integer
access_token_template_content string
post_logout_redirect_urls array Array of redirect URI values for use in OIDC Logout flows.
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.
creation_method string
client_secret_last_four string The last four characters of the client secret.
next_client_secret_last_four string The last four characters of the `next_client_secret`. Null if no `next_client_secret` exists.
access_token_custom_audience string
logo_url string The logo URL of the Connected App, if any.
client_id_metadata_url string
View JSON Schema on GitHub

JSON Schema

stytch-api-connectedapps-v1-connectedapp-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_connectedapps_v1_ConnectedApp",
  "title": "api_connectedapps_v1_ConnectedApp",
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string",
      "description": "The ID of the Connected App client."
    },
    "client_name": {
      "type": "string",
      "description": "A human-readable name for the client."
    },
    "client_description": {
      "type": "string",
      "description": "A human-readable description for the client."
    },
    "status": {
      "type": "string"
    },
    "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."
    },
    "client_type": {
      "type": "string",
      "description": "The type of Connected App. Supported values are `first_party`, `first_party_public`, `third_party`, and `third_party_public`."
    },
    "redirect_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of redirect URI values for use in OAuth Authorization flows."
    },
    "access_token_expiry_minutes": {
      "type": "integer",
      "format": "int32"
    },
    "access_token_template_content": {
      "type": "string"
    },
    "post_logout_redirect_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of redirect URI values for use in OIDC Logout flows."
    },
    "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."
    },
    "creation_method": {
      "type": "string"
    },
    "client_secret_last_four": {
      "type": "string",
      "description": "The last four characters of the client secret."
    },
    "next_client_secret_last_four": {
      "type": "string",
      "description": "The last four characters of the `next_client_secret`. Null if no `next_client_secret` exists."
    },
    "access_token_custom_audience": {
      "type": "string"
    },
    "logo_url": {
      "type": "string",
      "description": "The logo URL of the Connected App, if any."
    },
    "client_id_metadata_url": {
      "type": "string"
    }
  },
  "required": [
    "client_id",
    "client_name",
    "client_description",
    "status",
    "full_access_allowed",
    "client_type",
    "redirect_urls",
    "access_token_expiry_minutes",
    "access_token_template_content",
    "post_logout_redirect_urls",
    "bypass_consent_for_offline_access",
    "creation_method"
  ]
}