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.VerifyAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.customDomains().verify("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->verify(
    'id',
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

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

Post Verify

deprecated

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

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

Pour self_managed_certs, lorsque le domaine personnalisé est vérifié pour la première fois, la réponse inclura également la valeur 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

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.VerifyAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.customDomains().verify("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->verify(
    'id',
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

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

Authorization

string

header

requis

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

Paramètres de chemin

string

requis

ID du domaine personnalisé à vérifier.

Réponse

Le domaine personnalisé a été 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 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

cname_api_key

string

défaut:d4feca...

En-tête de la clé API CNAME.

custom_client_ip_header

string | null

L’en-tête HTTP servant à 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

origin_domain_name

string

défaut:mycompany_cd_0000000000000001.edge.tenants.auth0.com

Adresse intermédiaire.

tls_policy

string

défaut:recommended

La politique de version TLS

verification

object

Paramètres de vérification du domaine.

Show child attributes