Auth0 · Schema

ConnectionOptionsOAuth2

Options for the 'oauth2' connection

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM
View JSON Schema on GitHub

JSON Schema

auth0-connectionoptionsoauth2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionOptionsOAuth2",
  "title": "ConnectionOptionsOAuth2",
  "description": "Options for the 'oauth2' connection",
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "authParams": {
          "$ref": "#/components/schemas/ConnectionAuthParamsOAuth2"
        },
        "authParamsMap": {
          "$ref": "#/components/schemas/ConnectionAuthParamsMap"
        },
        "authorizationURL": {
          "$ref": "#/components/schemas/ConnectionAuthorizationEndpointOAuth2"
        },
        "client_id": {
          "$ref": "#/components/schemas/ConnectionClientIdOAuth2"
        },
        "client_secret": {
          "$ref": "#/components/schemas/ConnectionClientSecretOAuth2"
        },
        "customHeaders": {
          "$ref": "#/components/schemas/ConnectionCustomHeadersOAuth2"
        },
        "fieldsMap": {
          "$ref": "#/components/schemas/ConnectionFieldsMap"
        },
        "icon_url": {
          "$ref": "#/components/schemas/ConnectionIconUrl"
        },
        "logoutUrl": {
          "$ref": "#/components/schemas/ConnectionEndSessionEndpointOAuth2"
        },
        "pkce_enabled": {
          "type": "boolean",
          "description": "When true, enables Proof Key for Code Exchange (PKCE) for the authorization code flow. PKCE provides additional security by preventing authorization code interception attacks."
        },
        "scope": {
          "$ref": "#/components/schemas/ConnectionScopeOAuth2"
        },
        "scripts": {
          "$ref": "#/components/schemas/ConnectionScriptsOAuth2"
        },
        "set_user_root_attributes": {
          "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
        },
        "tokenURL": {
          "$ref": "#/components/schemas/ConnectionTokenEndpointOAuth2"
        },
        "upstream_params": {
          "$ref": "#/components/schemas/ConnectionUpstreamParams"
        },
        "useOauthSpecScope": {
          "type": "boolean",
          "description": "When true, uses space-delimited scopes (per OAuth 2.0 spec) instead of comma-delimited when calling the identity provider's authorization endpoint. Only relevant when using the connection_scope parameter. See https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp#pass-scopes-to-authorize-endpoint"
        }
      }
    },
    {
      "$ref": "#/components/schemas/ConnectionOptionsCommon"
    }
  ],
  "additionalProperties": true
}