Auth0

Auth0 Custom Domains API

The custom-domains API from Auth0 — 5 operation(s) for custom-domains.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /custom-domains List custom domains · Get Custom Domains Configurations #
Ask an LLM
“Which custom domains are configured for my tenant?”
“Can I search my custom domains by name or sort them?”
Tell an agent
List all my custom domains.
Search my custom domains matching {q}.
POST /custom-domains Add a new custom domain · Configure a New Custom Domain #
Ask an LLM
“How do I serve my login page from my own domain like login.example.com?”
“Can I choose between an Auth0-managed and a self-managed certificate for a new domain?”
Tell an agent
Add custom domain {domain} with certificate type {type}.
Register {domain} as a {type} custom domain using TLS policy {tls_policy}.
GET /custom-domains/default Get the tenant's default domain · Get the Default Domain #
Ask an LLM
“Which domain is the default for my tenant right now?”
“Is one of my custom domains set as the default?”
Tell an agent
Show me my tenant's default domain.
Tell me which custom domain is currently the default.
PATCH /custom-domains/default Set the default custom domain · Update the Default Custom Domain for the Tenant #
Ask an LLM
“How do I make one of my custom domains the default for emails and links?”
“Can I change the tenant's default domain?”
Tell an agent
Make {domain} the default custom domain.
Set the tenant default domain to {domain}.
GET /custom-domains/{id} Get a custom domain's configuration and status · Get Custom Domain Configuration #
Ask an LLM
“Has my custom domain finished verification yet?”
“What DNS records does a specific custom domain need?”
Tell an agent
Show me custom domain {id}.
Check the verification status of custom domain {id}.
DELETE /custom-domains/{id} Delete a custom domain · Delete Custom Domain Configuration #
Ask an LLM
“How do I stop serving login from a custom domain?”
“What happens to requests when I delete a custom domain?”
Tell an agent destructive · confirm first
Delete custom domain {id}.
Remove custom domain {id} and stop serving requests on it.
PATCH /custom-domains/{id} Update a custom domain's TLS or client IP header · Update Custom Domain Configuration #
Ask an LLM
“Can I change the TLS policy on an existing custom domain?”
“How do I set the header my proxy uses to pass the real client IP?”
Tell an agent
Set the TLS policy of custom domain {id} to {tls_policy}.
Use {custom_client_ip_header} as the client IP header on domain {id}.
POST /custom-domains/{id}/test Test a custom domain · Test a Custom Domain #
Ask an LLM
“Is there a way to run a test against my custom domain to see if it is serving correctly?”
“Can I check a verified custom domain is actually working?”
Tell an agent
Run the test process on custom domain {id}.
Test whether custom domain {id} is serving requests.
POST /custom-domains/{id}/verify Verify a custom domain's DNS · Verify a Custom Domain #
Ask an LLM
“I added the DNS record; how do I trigger verification of my custom domain?”
“How long after verification does a custom domain start accepting requests?”
Tell an agent
Verify custom domain {id}.
Run DNS verification for custom domain {id} now.

Documentation

📖
Documentation
https://auth0.com/docs/api/management/v2
📖
APIReference
https://auth0.com/docs/api/management/v2
📖
GettingStarted
https://auth0.com/docs/get-started
📖
Authentication
https://auth0.com/docs/secure/tokens
📖
Documentation
https://auth0.com/docs/api/authentication
📖
APIReference
https://auth0.com/docs/api/authentication
📖
Documentation
https://docs.fga.dev

Specifications

⚙
OpenAPI
https://artifacts.apis.io/auth0/openapi/auth0-custom-domains-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/auth0/asyncapi/auth0-log-streams-and-actions-asyncapi.yml

Other Resources

🔗
OpenAPISource
https://auth0.com/docs/api/management/openapi.json
🔗
SpectralRules
https://artifacts.apis.io/auth0/rules/auth0-management-rules.yml
🔗
SpectralRules
https://artifacts.apis.io/auth0/rules/auth0-authentication-rules.yml
🔗
SpectralRules
https://artifacts.apis.io/auth0/rules/auth0-fga-rules.yml
🔗
Project
https://openfga.dev
🔗
Repository
https://github.com/openfga/openfga

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/auth0:auth0-custom-domains-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

auth0-custom-domains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Auth0 Custom Domains API
  version: '2.0'
  contact:
    name: Auth0 Support
    url: https://support.auth0.com
  termsOfService: https://auth0.com/web-terms/
  description: 'Operations tagged custom-domains across 2 of this provider''s published API definitions: auth0-management-api-openapi.yml, auth0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenantDomain}/api/v2
  variables:
    tenantDomain:
      default: '{TENANT}.auth0.com'
      description: Auth0 Tenant Domain
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (52 KB total) ---
# Full source: https://artifacts.apis.io/auth0/openapi/auth0-custom-domains-api-openapi.yml