Mise à jour par défaut

Définir le domaine personnalisé par défaut pour le locataire.

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

Mettre à jour le domaine personnalisé par défaut du locataire

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/custom-domains/default \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>"
}
'

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

domain · string · requis

Le domaine à définir comme domaine personnalisé par défaut. Il doit s’agir d’un domaine personnalisé vérifié ou du domaine canonique.

Required string length: 3 - 255

Réponse

200

application/json

Domaine personnalisé par défaut défini avec succès.

Option 1

Option 2

custom_domain_id · string · défaut: cd_0000000000000001 · requis

ID du domaine personnalisé.

domain · string · défaut: login.mycompany.com · requis

Nom de domaine.

primary · boolean · défaut: false · requis

Indique s’il s’agit d’un domaine principal (true) ou non (false).

status · enum<string> · défaut: ready · requis

Statut de la configuration du domaine personnalisé. Peut être failed, pending_verification ou ready.

Options disponibles: pending_verification, ready, failed

type · enum<string> · défaut: self_managed_certs · requis

Type de provisionnement du domaine personnalisé. Peut être auth0_managed_certs ou self_managed_certs.

Options disponibles: auth0_managed_certs, self_managed_certs

certificate · object

Informations sur le certificat. Cet objet s’applique uniquement aux Domaines personnalisés avec des certificats gérés par Auth0.

Show child attributes

custom_client_ip_header · string | null

L’en-tête HTTP à utiliser pour récupérer l’adresse IP de l’application

domain_metadata · object

Métadonnées de Domaine associées au domaine personnalisé, sous la forme d’un objet contenant des valeurs de type chaîne (max. 255 caractères). Un maximum de 10 propriétés de métadonnées de domaine est autorisé.

Show child attributes

is_default · boolean · défaut: false

Indique s’il s’agit du domaine personnalisé par défaut (true) ou non (false).

origin_domain_name · string · défaut: mycompany_cd_0000000000000001.edge.tenants.auth0.com

Adresse intermédiaire.

relying_party_identifier · string<hostname>

ID de Relying Party (rpId) à utiliser pour les Passkeys sur ce domaine personnalisé. S’il n’est pas indiqué, le domaine complet sera utilisé.

tls_policy · string · défaut: recommended

La stratégie de version TLS

verification · object

Paramètres de vérification du Domaine.

Show child attributes