Verificar (POST)

Ejecute el proceso de verificación en un dominio personalizado.

Nota: Revise el campo status para consultar su estado de verificación. Una vez completada la verificación, pueden transcurrir hasta 10 minutos antes de que el dominio personalizado empiece a aceptar solicitudes.

Para self_managed_certs, cuando el dominio personalizado se verifique por primera vez, la respuesta también incluirá cname_api_key, que necesitará para configurar su proxy. Esta clave debe mantenerse en secreto y se usa para validar las solicitudes del proxy.

Más información sobre cómo verificar dominios personalizados que usan certificados administrados por Auth0. Más información sobre cómo verificar dominios personalizados que usan certificados autogestionados.

POST https://{tenantDomain}/api/v2/custom-domains/{id}/verify

Go

Go

package example

import (
    context "context"

    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>",
        ),
    )
    client.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

200

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

id · string · requerido

ID del dominio personalizado que se va a verificar.

Respuesta

200

application/json

El dominio personalizado se verificó correctamente.

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

certificate · object

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

Show child attributes

cname_api_key · string · predeterminado: d4feca...

Encabezado de API Key de CNAME.

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

origin_domain_name · string · predeterminado: mycompany_cd_0000000000000001.edge.tenants.auth0.com

Dirección intermedia.

tls_policy · string · predeterminado: recommended

La política de versión de TLS

verification · object

Configuración de verificación del dominio.

Show child attributes