Crear dominios personalizados

Crea un nuevo dominio personalizado.

Nota: El dominio personalizado deberá verificarse antes de aceptar solicitudes.

Atributos opcionales que se pueden actualizar:

• custom_client_ip_header
• tls_policy

Políticas de TLS:

• recommended: para uso moderno, esto incluye solo 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"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

domain · string · requerido

Nombre de dominio.

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

Tipo de aprovisionamiento del dominio personalizado. Debe ser auth0_managed_certs o self_managed_certs.

Opciones disponibles: auth0_managed_certs, self_managed_certs

custom_client_ip_header · enum<string> | null · predeterminado: true-client-ip

El encabezado HTTP para obtener la dirección IP del cliente

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

domain_metadata · object

Metadatos del dominio asociados al dominio personalizado, en forma de un objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 10 propiedades de metadatos de dominio.

Show child attributes

relying_party_identifier · string<hostname>

ID de la parte de confianza (rpId) que se usará para claves de acceso en este dominio personalizado. Si no se proporciona, se usará el dominio completo.

Maximum string length: 255

tls_policy · enum<string> · predeterminado: recommended

Política de TLS del dominio personalizado. Debe ser recommended; incluye TLS 1.2.

Opciones disponibles: recommended

verification_method · enum<string> · predeterminado: txt

Método de verificación del dominio personalizado. Debe ser txt.

Opciones disponibles: txt

Respuesta

201

application/json

Dominio personalizado creado correctamente (verificación pendiente).

custom_domain_id · string · predeterminado: cd_0000000000000001 · requerido

ID del dominio personalizado.

domain · string · predeterminado: login.mycompany.com · requerido

Nombre de dominio.

primary · boolean · predeterminado: false · requerido

Indica si este es un dominio principal (true) o no (false).

status · enum<string> · predeterminado: ready · requerido

Estado de la configuración del dominio personalizado. Puede ser failed, pending_verification o ready.

Opciones disponibles: pending_verification, ready, failed

type · enum<string> · predeterminado: self_managed_certs · requerido

Tipo de aprovisionamiento del dominio personalizado. Puede ser auth0_managed_certs o self_managed_certs.

Opciones disponibles: auth0_managed_certs, self_managed_certs

verification · object · requerido

Configuración de verificación del dominio.

Show child attributes

certificate · object

Información del certificado. Este objeto solo es relevante para dominios personalizados con certificados administrados por Auth0.

Show child attributes

custom_client_ip_header · string | null

El encabezado HTTP para obtener la dirección IP del cliente

domain_metadata · object

Metadatos del dominio asociados al dominio personalizado, en forma de un objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 10 propiedades de metadatos de dominio.

Show child attributes

is_default · boolean · predeterminado: false

Indica si este es el dominio personalizado predeterminado (true) o no (false).

relying_party_identifier · string<hostname>

ID de la parte de confianza (rpId) que se usará para claves de acceso en este dominio personalizado. Si no se proporciona, se usará el dominio completo.

tls_policy · string · predeterminado: recommended

La política de versión de TLS