Auth0 · Schema

ConnectionOptionsADFS

Options for the 'adfs' connection

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM
View JSON Schema on GitHub

JSON Schema

auth0-connectionoptionsadfs-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionOptionsADFS",
  "title": "ConnectionOptionsADFS",
  "description": "Options for the 'adfs' connection",
  "additionalProperties": true,
  "allOf": [
    {
      "$ref": "#/components/schemas/ConnectionOptionsCommon"
    },
    {
      "type": "object",
      "properties": {
        "adfs_server": {
          "type": "string",
          "description": "ADFS federation metadata host or XML URL used to discover WS-Fed endpoints and certificates. Errors if adfs_server and fedMetadataXml are both absent.",
          "minLength": 0,
          "maxLength": 2048
        },
        "domain_aliases": {
          "$ref": "#/components/schemas/ConnectionDomainAliases"
        },
        "entityId": {
          "description": "The entity identifier (Issuer) for the ADFS Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "fedMetadataXml": {
          "$ref": "#/components/schemas/ConnectionMetadataXmlADFS"
        },
        "icon_url": {
          "$ref": "#/components/schemas/ConnectionIconUrlADFS"
        },
        "prev_thumbprints": {
          "$ref": "#/components/schemas/ConnectionThumbprints"
        },
        "set_user_root_attributes": {
          "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
        },
        "should_trust_email_verified_connection": {
          "$ref": "#/components/schemas/ConnectionShouldTrustEmailVerifiedConnectionEnum"
        },
        "signInEndpoint": {
          "$ref": "#/components/schemas/ConnectionSignInEndpointADFS"
        },
        "tenant_domain": {
          "$ref": "#/components/schemas/ConnectionTenantDomain"
        },
        "thumbprints": {
          "$ref": "#/components/schemas/ConnectionThumbprints"
        },
        "upstream_params": {
          "$ref": "#/components/schemas/ConnectionUpstreamParamsADFS"
        },
        "user_id_attribute": {
          "description": "Custom ADFS claim to use as the unique user identifier. When provided, this attribute is prepended to the default user_id mapping list with highest priority. Accepts a string (single ADFS claim name).",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        }
      }
    }
  ]
}