Stytch · Schema

api_organization_v1_OIDCProviderInfo

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
provider_subject	string	The unique identifier for the User within a given OAuth provider. Also commonly called the `sub` or "Subject field" in OAuth protocols.
id_token	string	The `id_token` returned by the OAuth provider. ID Tokens are JWTs that contain structured information about a user. The exact content of each ID Token varies from provider to provider. ID Tokens are r
access_token	string	The `access_token` that you may use to access the User's data in the provider's API.
access_token_expires_in	integer	The number of seconds until the access token expires.
scopes	array	The OAuth scopes included for a given provider. See each provider's section above to see which scopes are included by default and how to add custom scopes.
connection_id	string	Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
refresh_token	string	The `refresh_token` that you may use to obtain a new `access_token` for the User within the provider's API.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_organization_v1_OIDCProviderInfo",
  "title": "api_organization_v1_OIDCProviderInfo",
  "type": "object",
  "properties": {
    "provider_subject": {
      "type": "string",
      "description": "The unique identifier for the User within a given OAuth provider. Also commonly called the `sub` or \"Subject field\" in OAuth protocols."
    },
    "id_token": {
      "type": "string",
      "description": "The `id_token` returned by the OAuth provider. ID Tokens are JWTs that contain structured information about a user. The exact content of each ID Token varies from provider to provider. ID Tokens are returned from OAuth providers that conform to the [OpenID Connect](https://openid.net/foundation/) specification, which is based on OAuth."
    },
    "access_token": {
      "type": "string",
      "description": "The `access_token` that you may use to access the User's data in the provider's API."
    },
    "access_token_expires_in": {
      "type": "integer",
      "format": "int32",
      "description": "The number of seconds until the access token expires."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The OAuth scopes included for a given provider. See each provider's section above to see which scopes are included by default and how to add custom scopes."
    },
    "connection_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific SSO `connection_id` for a Member."
    },
    "refresh_token": {
      "type": "string",
      "description": "The `refresh_token` that you may use to obtain a new `access_token` for the User within the provider's API."
    }
  },
  "required": [
    "provider_subject",
    "id_token",
    "access_token",
    "access_token_expires_in",
    "scopes",
    "connection_id"
  ]
}