Update custom domain configuration

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.

PATCH https://{tenantDomain}/api/v2/custom-domains/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateCustomDomainRequestContent{}
    client.CustomDomains.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "custom_domain_id": "cd_0000000000000001",
  "domain": "login.mycompany.com",
  "primary": false,
  "status": "ready",
  "type": "self_managed_certs",
  "verification": {
    "methods": [
      {
        "name": "txt",
        "record": "auth0-domain-verification=...",
        "domain": "_cf-custom-hostname.login.mycompany.com"
      }
    ],
    "error_msg": "<string>",
    "last_verified_at": "<string>"
  },
  "is_default": false,
  "custom_client_ip_header": "<string>",
  "tls_policy": "recommended",
  "domain_metadata": {},
  "certificate": {
    "error_msg": "<string>",
    "renews_before": "<string>"
  },
  "relying_party_identifier": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The id of the custom domain to update

Body

application/jsonapplication/x-www-form-urlencoded

tls_policy · enum<string> · default: recommended

recommended includes TLS 1.2

Available options: recommended

custom_client_ip_header · enum<string> | null · default: true-client-ip

The HTTP header to fetch the client's IP address

Available options: true-client-ip, cf-connecting-ip, x-forwarded-for, x-azure-clientip,

domain_metadata · 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 allowed.

Show child attributes

relying_party_identifier · string<hostname> | null

Relying Party ID (rpId) to be used for Passkeys on this custom domain. Set to null to remove the rpId and fall back to using the full domain.

Maximum string length: 255

Response

200

application/json

Custom domain updated.

custom_domain_id · string · default: cd_0000000000000001 · required

ID of the custom domain.

domain · string · default: login.mycompany.com · required

Domain name.

primary · boolean · default: false · required

Whether this is a primary domain (true) or not (false).

status · enum<string> · default: ready · required

Custom domain configuration status. Can be failed, pending_verification, or ready.

Available options: pending_verification, ready, failed

type · enum<string> · default: self_managed_certs · required

Custom domain provisioning type. Can be auth0_managed_certs or self_managed_certs.

Available options: auth0_managed_certs, self_managed_certs

verification · object · required

Domain verification settings.

Show child attributes

is_default · boolean · default: false

Whether this is the default custom domain (true) or not (false).

custom_client_ip_header · string | null

The HTTP header to fetch the client's IP address

tls_policy · string · default: recommended

The TLS version policy

domain_metadata · 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 allowed.

Show child attributes

certificate · object

Certificate information. This object is relevant only for Custom Domains with Auth0-Managed Certificates.

Show child attributes

relying_party_identifier · string<hostname>

Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used.