Auth0 · Schema

VerifyCustomDomainResponseContent

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).
status	object
type	object
cname_api_key	string	CNAME API key header.
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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VerifyCustomDomainResponseContent",
  "title": "VerifyCustomDomainResponseContent",
  "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
    },
    "status": {
      "$ref": "#/components/schemas/CustomDomainStatusFilterEnum"
    },
    "type": {
      "$ref": "#/components/schemas/CustomDomainTypeEnum"
    },
    "cname_api_key": {
      "type": "string",
      "description": "CNAME API key header.",
      "default": "d4feca..."
    },
    "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"
    }
  }
}