Vérification par POST

Exécutez le processus de vérification sur un domaine personnalisé.

Remarque : vérifiez le champ status pour connaître son statut de vérification. Une fois la vérification terminée, le domaine personnalisé peut prendre jusqu’à 10 minutes avant de commencer à accepter des requêtes.

Pour self_managed_certs, lorsque le domaine personnalisé est vérifié pour la première fois, la réponse inclut également cname_api_key, dont vous aurez besoin pour configurer votre proxy. Cette clé doit rester secrète et sert à valider les requêtes du proxy.

En savoir plus sur la vérification des domaines personnalisés qui utilisent des certificats gérés par Auth0. En savoir plus sur la vérification des domaines personnalisés qui utilisent des certificats autogérés.

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

Go

Go

package example

import (
    context "context"

    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>",
        ),
    )
    client.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

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>"
  },
  "cname_api_key": "d4feca...",
  "custom_client_ip_header": "<string>",
  "domain_metadata": {},
  "origin_domain_name": "mycompany_cd_0000000000000001.edge.tenants.auth0.com",
  "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.

Paramètres de chemin

id · string · requis

ID du domaine personnalisé à vérifier.

Réponse

200

application/json

Domaine personnalisé vérifié avec succès.

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 du 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

cname_api_key · string · défaut: d4feca...

En-tête de clé d’API CNAME.

custom_client_ip_header · string | null

En-tête HTTP permettant de récupérer l’adresse IP du client

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

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

Adresse intermédiaire.

tls_policy · string · défaut: recommended

Stratégie de version TLS

verification · object

Paramètres de vérification du Domaine.

Show child attributes