Auth0 · Schema

ConnectionOptionsApple

Options for the 'apple' connection

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM
View JSON Schema on GitHub

JSON Schema

auth0-connectionoptionsapple-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionOptionsApple",
  "title": "ConnectionOptionsApple",
  "description": "Options for the 'apple' connection",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/ConnectionOptionsCommon"
    },
    {
      "type": "object",
      "properties": {
        "app_secret": {
          "type": [
            "string",
            "null"
          ],
          "description": "Apple App Secret (must be a PEM)",
          "minLength": 0,
          "maxLength": 5120
        },
        "client_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Apple Services ID",
          "minLength": 0,
          "maxLength": 384
        },
        "email": {
          "type": "boolean",
          "description": "User has the option to obfuscate the email with Apple's relay service"
        },
        "freeform_scopes": {
          "type": "array",
          "description": "Array of freeform scopes",
          "minItems": 0,
          "maxItems": 1024,
          "items": {
            "type": "string",
            "description": "A freeform scope",
            "minLength": 0,
            "maxLength": 2560
          }
        },
        "kid": {
          "type": [
            "string",
            "null"
          ],
          "description": "Apple Key ID",
          "minLength": 0,
          "maxLength": 1536
        },
        "name": {
          "type": "boolean",
          "description": "Whether to request name from Apple"
        },
        "scope": {
          "type": "string",
          "description": "Space separated list of scopes",
          "minLength": 0,
          "maxLength": 91260
        },
        "set_user_root_attributes": {
          "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
        },
        "team_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Apple Team ID",
          "minLength": 0,
          "maxLength": 256
        },
        "upstream_params": {
          "$ref": "#/components/schemas/ConnectionUpstreamParams"
        }
      }
    }
  ],
  "additionalProperties": true
}