Saltar al contenido principal
Cuando tenga varios dominios personalizados configurados para su inquilino de Auth0, puede designar uno como el dominio personalizado predeterminado. El dominio predeterminado simplifica la configuración y garantiza una experiencia de usuario uniforme cuando no se especifica explícitamente un dominio personalizado.

¿Qué es un dominio personalizado predeterminado?

El dominio personalizado predeterminado es el dominio personalizado que Auth0 usa automáticamente para:
  • Comunicaciones por correo electrónico y teléfono: enviar correos electrónicos de restablecimiento de contraseña, enlaces de verificación de correo electrónico y otras notificaciones generadas por Auth0 cuando no se especifica un dominio personalizado concreto. Esto incluye los casos en que se envían notificaciones durante la autenticación.
  • Llamadas a la Management API: gestionar solicitudes a la API que activan notificaciones sin el encabezado auth0-custom-domain
Puede configurar el dominio canónico de su inquilino (YOUR_TENANT.auth0.com o YOUR_TENANT.REGION.auth0.com) como dominio personalizado predeterminado. Siempre habrá un dominio personalizado predeterminado configurado para su inquilino.

Beneficios de configurar un dominio predeterminado

Configurar un dominio personalizado predeterminado ofrece varias ventajas:
  • Configuración simplificada: Reduce la necesidad de especificar dominios personalizados en cada llamada a la Management API o en cada configuración
  • Marca coherente: Garantiza que los usuarios siempre vean su marca, incluso cuando no se especifique un dominio concreto
  • Encabezado auth0-custom-domain opcional: Hace que el encabezado de dominio personalizado sea opcional en las solicitudes de la Management API
  • Comportamiento de respaldo: Proporciona valores predeterminados adecuados para implementaciones con varias marcas o varios inquilinos
  • Migración más sencilla: Simplifica la transición de un único dominio personalizado a varios dominios personalizados

Configurar un dominio predeterminado

Puede establecer un dominio personalizado predeterminado a través del Auth0 Dashboard o de la Management API.

Uso del Auth0 Dashboard

Para establecer un dominio personalizado predeterminado en el Auth0 Dashboard:
  1. Ve a Auth0 Dashboard > Marca > Dominios personalizados
  2. Busca en la lista el dominio personalizado verificado que quieres establecer como predeterminado
  3. Haz clic en el botón Establecer como predeterminado para ese dominio
  4. Confirma la acción en el cuadro de diálogo que aparece
El dominio ahora mostrará una insignia de “Predeterminado” en la lista de dominios personalizados.
Solo se pueden establecer como predeterminados los dominios personalizados verificados. Asegúrate de que tu dominio personalizado esté completamente verificado y activo antes de designarlo como predeterminado.

Uso de la Management API

Para configurar un dominio personalizado predeterminado mediante la Management API, use el endpoint PATCH /api/v2/custom-domains/default:

Quitar la designación predeterminada de un dominio

Para quitar la designación predeterminada de un dominio personalizado:
  1. Configure otro dominio personalizado como predeterminado (solo un dominio puede ser el predeterminado a la vez), o
  2. Use la Management API para establecer is_default: false en el dominio predeterminado actual
Si no se configura ningún dominio personalizado como predeterminado, Auth0 usará el dominio canónico de su inquilino.

Cómo se utiliza el dominio predeterminado

Notificaciones por correo electrónico

Cuando Auth0 envía notificaciones por correo electrónico (restablecimiento de contraseña, verificación del correo electrónico y correos de bienvenida), se utiliza el dominio predeterminado para los links y las personalizaciones de estas notificaciones. Puede personalizar las plantillas de correo electrónico para usar la información del dominio personalizado en la dirección “From”, la línea de asunto y el cuerpo del correo electrónico.

Endpoints de Management API que activan notificaciones

El dominio personalizado predeterminado se usa específicamente para los endpoints de Management API que activan notificaciones por correo electrónico o por teléfono. El encabezado auth0-custom-domain pasa a ser opcional para estos endpoints cuando tienes configurado un dominio predeterminado. Endpoints que activan notificaciones por correo electrónico:
  • POST /api/v2/tickets/password-change - Envía un correo electrónico de restablecimiento de contraseña
  • POST /api/v2/tickets/email-verification - Envía un correo electrónico de verificación
  • POST /api/v2/jobs/verification-email - Envía un correo electrónico de verificación a uno o varios usuarios
  • POST /api/v2/users - Puede activar un correo electrónico de bienvenida si está configurado
  • PATCH /api/v2/users/{id} - Puede activar un correo electrónico de verificación cuando se actualiza el correo electrónico
Endpoints que activan notificaciones por teléfono:
  • POST /api/v2/users/{id}/phone/verification - Envía un código de verificación por SMS
Ejemplo: Cuando no proporcionas el encabezado auth0-custom-domain para estos endpoints de notificación, Auth0 usa automáticamente el dominio personalizado predeterminado para los enlaces y las personalizaciones del correo electrónico o del SMS. Puedes reemplazarlo en cada solicitud incluyendo el encabezado auth0-custom-domain.

Uso del dominio predeterminado con Actions

Use Actions para implementar lógica basada en el dominio personalizado:
exports.onExecutePostLogin = async (event, api) => {
  const domain = event.custom_domain?.domain;

  // Almacenar el dominio de inicio de sesión en los metadatos del usuario
  if (domain) {
    api.user.setAppMetadata('login_domain', domain);
  }
};
Para obtener más información sobre cómo usar información de dominios personalizados en Actions, consulta Integración de Actions con varios dominios personalizados.

Prácticas recomendadas

Al configurar un dominio personalizado predeterminado, tenga en cuenta estas prácticas recomendadas:
  • Elija un dominio estable: Seleccione un dominio que no cambie con frecuencia como dominio predeterminado
  • Verifique antes de establecerlo: Asegúrese de que el dominio esté completamente verificado y operativo antes de establecerlo como predeterminado
  • Documente la decisión: Registre por qué se eligió un dominio determinado como predeterminado para futuras consultas
  • Pruebe los flujos de correo electrónico: Después de establecer un dominio predeterminado, pruebe los flujos de restablecimiento de contraseña y verificación de correo electrónico
  • Supervise los emisores de tokens: Verifique que los tokens incluyan la reclamación iss esperada después de establecer un dominio predeterminado
  • Planifique escenarios de múltiples marcas: Si presta servicio a varias marcas, elija un dominio genérico o administrativo como predeterminado
  • Actualice las integraciones: Informe a su equipo sobre el dominio predeterminado para garantizar una configuración correcta de las integraciones

Más información