How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Auth0

Auth0 custom-domains API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Auth0 custom-domains API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Custom Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 9 operations across 5 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

9 operations 5 paths 32 schemas 1 DELETE3 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Contact
Auth0 Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Auth0 custom-domains API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

custom-domains 9
GET
/custom-domains
Get Custom Domains Configurations
get_custom-domains 6 params → 200401403429
POST
/custom-domains
Configure a New Custom Domain
post_custom-domains body → 201400401403409429
GET
/custom-domains/default
Get the Default Domain
get_default → 200401403429
PATCH
/custom-domains/default
Update the Default Custom Domain for the Tenant
patch_default body → 200400403
GET
/custom-domains/{id}
Get Custom Domain Configuration
get_custom-domains_by_id 1 param → 200400401403404429
DELETE
/custom-domains/{id}
Delete Custom Domain Configuration
delete_custom-domains_by_id 1 param → 204400401403429
PATCH
/custom-domains/{id}
Update Custom Domain Configuration
patch_custom-domains_by_id 1 param body → 200400401403429
POST
/custom-domains/{id}/test
Test a Custom Domain
post_test_domain 1 param → 200400401403404409
POST
/custom-domains/{id}/verify
Verify a Custom Domain
post_verify 1 param → 200400401403404429

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are UpdateDefaultCustomDomainResponseContent (13 properties), GetCustomDomainResponseContent (13 properties), GetDefaultCustomDomainResponseContent (13 properties), CustomDomain (13 properties). Each schema is shown below with its type and property counts.

UpdateDefaultCanonicalDomainResponseContent
object
1 property 1 required
GetDefaultCanonicalDomainResponseContent
object
1 property 1 required
DomainCertificateStatusEnum
string
The provisioning status of the certificate.
CreateCustomDomainResponseContent
object
12 properties 6 required
GetCustomDomainResponseContent
object
13 properties 5 required
VerifyCustomDomainResponseContent
object
12 properties 5 required
DomainVerificationMethodNameEnum
string
Domain verification method.
GetDefaultCustomDomainResponseContent
object
13 properties 5 required
ListCustomDomainsPaginatedResponseContent
object
2 properties 1 required
CustomDomainVerificationMethodEnum
string
Custom domain verification method. Must be txt.
DomainMetadata
object
Domain metadata associated with the custom domain, in the form of an object with string values (max 255 chars). Maximum of 10 domain metadata properties allowe…
UpdateCustomDomainRequestContent
object
4 properties
CustomDomainProvisioningTypeEnum
string
Custom domain provisioning type. Must be auth0managedcerts or selfmanagedcerts.
UpdateDefaultDomainResponseContent
CustomDomainCustomClientIpHeaderEnum
string
The HTTP header to fetch the client's IP address
CustomDomain
object
13 properties 5 required
CustomDomainTypeEnum
string
Custom domain provisioning type. Can be auth0managedcerts or selfmanagedcerts.
CustomDomainCustomClientIpHeader
UpdateDefaultCustomDomainResponseContent
object
13 properties 5 required
GetDefaultDomainResponseContent
UpdateCustomDomainResponseContent
object
12 properties 6 required
CustomDomainTlsPolicyEnum
string
Custom domain TLS policy. Must be recommended, includes TLS 1.2.
ListCustomDomainsResponseContent
TestCustomDomainResponseContent
object
2 properties 1 required
DomainVerification
object
Domain verification settings.
4 properties
DomainCertificateAuthorityEnum
string
The Certificate Authority issued the certificate.
SetDefaultCustomDomainRequestContent
object
1 property 1 required
DomainCertificate
object
Certificate information. This object is relevant only for Custom Domains with Auth0-Managed Certificates.
4 properties
CustomDomainStatusFilterEnum
string
Custom domain configuration status. Can be failed, pendingverification, or ready.
DomainVerificationStatusEnum
string
The DNS record verification status. This field is relevant only for Custom Domains with Auth0-Managed Certificates.
CreateCustomDomainRequestContent
object
7 properties 2 required
DomainVerificationMethod
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-custom-domains-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
AE Profile APIs.io
Auth0 My Organization API
AE Profile APIs.io
Auth0 for AI Agents
AE Profile APIs.io
Auth0 actions API
AE Profile APIs.io
Auth0 anomaly API
AE Profile APIs.io
Auth0 Assertions API
AE Profile APIs.io
Auth0 attack-protection API
AE Profile APIs.io
Auth0 Authorization Models API
AE Profile APIs.io
Auth0 Authorize User API
AE Profile APIs.io
Auth0 AuthZenService API
AE Profile APIs.io
Auth0 branding API
AE Profile APIs.io
Auth0 client-grants API
AE Profile APIs.io
#Custom Domains
← Back to A APIs
API Details
ID
auth0:auth0-custom-domains-api
Base URL
https://your-tenant.auth0.com/api/v2
Docs
https://auth0.com/docs/api/management/v2
Provider
Auth0
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=auth0-custom-domains-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/auth0-custom-domains-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Auth0 custom-domains API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.