Modifier un domaine personnalisé par id

Mettre à jour un domaine personnalisé.

Voici les attributs qui peuvent être mis à jour :

• custom_client_ip_header
• tls_policy

Mise à jour de CUSTOM_CLIENT_IP_HEADER pour un domaine personnalisé

Pour mettre à jour custom_client_ip_header pour un domaine, le corps de la requête à envoyer doit être :

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

Mise à jour de TLS_POLICY pour un domaine personnalisé

Pour mettre à jour tls_policy pour un domaine, le corps de la requête à envoyer doit être :

{ "tls_policy": "recommended" }

Stratégies TLS :

• recommended - pour une utilisation moderne, cela inclut uniquement TLS 1.2

Points à considérer :

• Les suites de chiffrement et les protocoles TLS disponibles dans chaque stratégie TLS suivent les recommandations du secteur et peuvent être mis à jour à l’occasion.
• La stratégie TLS compatible n’est plus prise en charge.

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": {
    "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.

Paramètres de chemin

id · string · requis

Id du domaine personnalisé à mettre à jour

Corps

application/jsonapplication/x-www-form-urlencoded

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

ID de Relying Party (rpId) à utiliser pour les clés d’accès sur ce domaine personnalisé. Définissez-la sur null pour supprimer le rpId et revenir à l’utilisation du domaine complet.

Maximum string length: 255

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

recommended comprend TLS 1.2

Options disponibles: recommended

Réponse

200

application/json

Domaine personnalisé mis à jour.

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

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 clés d’accès 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