Auth0 · Schema

Auth0 CustomDomain

JSON Schema for Auth0 CustomDomain entity, extracted from the Auth0 Management API OpenAPI v2.0 spec (component: CustomDomain).

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
custom_domain_id	string	ID of the custom domain.
domain	string	Domain name.
primary	boolean	Whether this is a primary domain (true) or not (false).
is_default	boolean	Whether this is the default custom domain (true) or not (false).
status	object
type	object
origin_domain_name	string	Intermediate address.
verification	object
custom_client_ip_header	stringnull	The HTTP header to fetch the client's IP address
tls_policy	string	The TLS version policy
domain_metadata	object
certificate	object
relying_party_identifier	string	Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/auth0/main/json-schema/auth0-customdomain-schema.json",
  "title": "Auth0 CustomDomain",
  "description": "JSON Schema for Auth0 CustomDomain entity, extracted from the Auth0 Management API OpenAPI v2.0 spec (component: CustomDomain).",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "custom_domain_id",
    "domain",
    "primary",
    "status",
    "type"
  ],
  "properties": {
    "custom_domain_id": {
      "type": "string",
      "description": "ID of the custom domain.",
      "default": "cd_0000000000000001"
    },
    "domain": {
      "type": "string",
      "description": "Domain name.",
      "default": "login.mycompany.com"
    },
    "primary": {
      "type": "boolean",
      "description": "Whether this is a primary domain (true) or not (false).",
      "default": false
    },
    "is_default": {
      "type": "boolean",
      "description": "Whether this is the default custom domain (true) or not (false).",
      "default": false
    },
    "status": {
      "$ref": "#/components/schemas/CustomDomainStatusFilterEnum"
    },
    "type": {
      "$ref": "#/components/schemas/CustomDomainTypeEnum"
    },
    "origin_domain_name": {
      "type": "string",
      "description": "Intermediate address.",
      "default": "mycompany_cd_0000000000000001.edge.tenants.auth0.com"
    },
    "verification": {
      "$ref": "#/components/schemas/DomainVerification"
    },
    "custom_client_ip_header": {
      "type": [
        "string",
        "null"
      ],
      "description": "The HTTP header to fetch the client's IP address"
    },
    "tls_policy": {
      "type": "string",
      "description": "The TLS version policy",
      "default": "recommended"
    },
    "domain_metadata": {
      "$ref": "#/components/schemas/DomainMetadata"
    },
    "certificate": {
      "$ref": "#/components/schemas/DomainCertificate"
    },
    "relying_party_identifier": {
      "type": "string",
      "description": "Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used.",
      "format": "hostname"
    }
  }
}