Créer des domaines personnalisés

Crée un nouveau domaine personnalisé.

Remarque : le domaine personnalisé devra être vérifié avant d’accepter des requêtes.

Attributs facultatifs pouvant être mis à jour :

• custom_client_ip_header
• tls_policy

Stratégies TLS :

• recommended - pour un usage moderne, cela inclut uniquement TLS 1.2

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

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.CreateCustomDomainRequestContent{
        Domain: "domain",
        Type: management.CustomDomainProvisioningTypeEnumAuth0ManagedCerts,
    }
    client.CustomDomains.Create(
        context.TODO(),
        request,
    )
}

201

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

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

Nom de domaine.

Required string length: 3 - 255

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9])$

type · enum<string> · requis

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

Options disponibles: auth0_managed_certs, self_managed_certs

custom_client_ip_header · enum<string> | null · défaut: true-client-ip

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

Options disponibles: true-client-ip, cf-connecting-ip, x-forwarded-for, x-azure-clientip,

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

relying_party_identifier · string<hostname>

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

Maximum string length: 255

tls_policy · enum<string> · défaut: recommended

Stratégie TLS du domaine personnalisé. Doit être recommended, qui inclut TLS 1.2.

Options disponibles: recommended

verification_method · enum<string> · défaut: txt

Méthode de vérification du domaine personnalisé. Doit être txt.

Options disponibles: txt

Réponse

201

application/json

Domaine personnalisé créé avec succès (vérification en attente).

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

verification · object · requis

Paramètres de vérification du Domaine.

Show child attributes

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 cliente

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).

relying_party_identifier · string<hostname>

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

tls_policy · string · défaut: recommended

La stratégie de version TLS