Mettre à jour le domaine personnalisé par défaut

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.CustomDomains.SetDefaultAsync(
            new SetDefaultCustomDomainRequestContent {
                Domain = "domain"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.SetDefaultCustomDomainRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.customDomains().setDefault(
            SetDefaultCustomDomainRequestContent
                .builder()
                .domain("domain")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\CustomDomains\Requests\SetDefaultCustomDomainRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->setDefault(
    new SetDefaultCustomDomainRequestContent([
        'domain' => 'domain',
    ]),
);

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

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: '<string>'})
};

fetch('https://{tenantDomain}/api/v2/custom-domains/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/custom-domains/default"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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"
      }
    ]
  }
}

PATCH

https://{tenantDomain}/api/v2

custom-domains

default

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.CustomDomains.SetDefaultAsync(
            new SetDefaultCustomDomainRequestContent {
                Domain = "domain"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.SetDefaultCustomDomainRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.customDomains().setDefault(
            SetDefaultCustomDomainRequestContent
                .builder()
                .domain("domain")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\CustomDomains\Requests\SetDefaultCustomDomainRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->setDefault(
    new SetDefaultCustomDomainRequestContent([
        'domain' => 'domain',
    ]),
);

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

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: '<string>'})
};

fetch('https://{tenantDomain}/api/v2/custom-domains/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/custom-domains/default"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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

Authorization

string

header

requis

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

Corps

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

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

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

domain_metadata

object

Métadonnées de domaine associées au domaine personnalisé, sous la forme d’un objet avec 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 la partie de confiance (rpId) à utiliser pour les clés d’accès sur ce domaine personnalisé. S’il n’est pas indiqué, le domaine complet sera utilisé.

tls_policy

string

défaut:recommended

La politique de version TLS

verification

object

Paramètres de vérification du domaine.

Show child attributes