Class CustomDomains

Retrieve details on custom domains.

await client.customDomains.list()
Copy

Create a new custom domain.

Note: The custom domain will need to be verified before it will accept requests.

Optional attributes that can be updated:

• custom_client_ip_header
• tls_policy

TLS Policies:

• recommended - for modern usage this includes TLS 1.2 only

await client.customDomains.create({
        domain: "domain",
        type: "auth0_managed_certs"
    })
Copy

Retrieve a custom domain configuration and status.

await client.customDomains.get("id")
Copy

Delete a custom domain and stop serving requests for it.

await client.customDomains.delete("id")
Copy

Update a custom domain.

These are the attributes that can be updated:

• custom_client_ip_header
• tls_policy

Updating CUSTOM_CLIENT_IP_HEADER for a custom domain

To update the custom_client_ip_header for a domain, the body to send should be:

{ "custom_client_ip_header": "cf-connecting-ip" }

Updating TLS_POLICY for a custom domain

To update the tls_policy for a domain, the body to send should be:

{ "tls_policy": "recommended" }

TLS Policies:

• recommended - for modern usage this includes TLS 1.2 only

Some considerations:

• The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
• The compatible TLS policy is no longer supported.

await client.customDomains.update("id")
Copy

Run the test process on a custom domain.

await client.customDomains.test("id")
Copy

Run the verification process on a custom domain.

Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.

For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.

Learn more about verifying custom domains that use Auth0 Managed certificates. Learn more about verifying custom domains that use Self Managed certificates.

await client.customDomains.verify("id")
Copy