POST des domaines personnalisés

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.CreateAsync(
            new CreateCustomDomainRequestContent {
                Domain = "domain",
                Type = CustomDomainProvisioningTypeEnum.Auth0ManagedCerts
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    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
    }
    request := &management.CreateCustomDomainRequestContent{
        Domain: "domain",
        Type: management.CustomDomainProvisioningTypeEnumAuth0ManagedCerts,
    }
    mgmt.CustomDomains.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateCustomDomainRequestContent;
import com.auth0.client.mgmt.types.CustomDomainProvisioningTypeEnum;

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

        client.customDomains().create(
            CreateCustomDomainRequestContent
                .builder()
                .domain("domain")
                .type(CustomDomainProvisioningTypeEnum.AUTH_0_MANAGED_CERTS)
                .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\CreateCustomDomainRequestContent;
use Auth0\SDK\API\Management\Types\CustomDomainProvisioningTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->create(
    new CreateCustomDomainRequestContent([
        'domain' => 'domain',
        'type' => CustomDomainProvisioningTypeEnum::Auth0ManagedCerts->value,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.custom_domains.create(
    domain="domain",
    type="auth0_managed_certs",
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/custom-domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "custom_client_ip_header": "x-forwarded-for",
  "domain_metadata": {},
  "relying_party_identifier": "<string>",
  "tls_policy": "recommended",
  "verification_method": "txt"
}
'

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

POST

https://{tenantDomain}/api/v2

custom-domains

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.CreateAsync(
            new CreateCustomDomainRequestContent {
                Domain = "domain",
                Type = CustomDomainProvisioningTypeEnum.Auth0ManagedCerts
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    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
    }
    request := &management.CreateCustomDomainRequestContent{
        Domain: "domain",
        Type: management.CustomDomainProvisioningTypeEnumAuth0ManagedCerts,
    }
    mgmt.CustomDomains.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateCustomDomainRequestContent;
import com.auth0.client.mgmt.types.CustomDomainProvisioningTypeEnum;

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

        client.customDomains().create(
            CreateCustomDomainRequestContent
                .builder()
                .domain("domain")
                .type(CustomDomainProvisioningTypeEnum.AUTH_0_MANAGED_CERTS)
                .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\CreateCustomDomainRequestContent;
use Auth0\SDK\API\Management\Types\CustomDomainProvisioningTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->create(
    new CreateCustomDomainRequestContent([
        'domain' => 'domain',
        'type' => CustomDomainProvisioningTypeEnum::Auth0ManagedCerts->value,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.custom_domains.create(
    domain="domain",
    type="auth0_managed_certs",
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/custom-domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "custom_client_ip_header": "x-forwarded-for",
  "domain_metadata": {},
  "relying_party_identifier": "<string>",
  "tls_policy": "recommended",
  "verification_method": "txt"
}
'

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

Authorization

string

header

requis

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

Corps

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:x-forwarded-for

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

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

Politique TLS du domaine personnalisé. Doit être recommended et 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

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

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 utilisé pour récupérer l’adresse IP du client

domain_metadata

object

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 politique de version TLS