Skip to main content

Prerrequisitos

Para usar correlation_id, debe contar con lo siguiente:
  • Universal Login de Auth0 configurado: El ID de correlación está disponible en los flujos de Universal Login.
  • Una aplicación capaz de generar ID únicos: Su aplicación debe poder generar UUID o ID de transacción. (Ejemplo: txn_12345_xyz, ID de sesión o ID de pedido)
Si correlation_id no está disponible en sus solicitudes de autorización, es posible que esta función no esté habilitada en su inquilino.
Auth0 permite rastrear transacciones de autenticación mediante el ID de correlación. Esta capacidad de seguimiento puede reducir el tiempo de respuesta del soporte y proporcionarle trazabilidad entre varios sistemas después de los eventos de autenticación. El parámetro correlation_id agrega a la URL de autorización un identificador único generado por su aplicación. Este ID se registra automáticamente, lo que le permite rastrear y filtrar eventos en los registros del inquilino de Auth0. El ID de correlación se conserva en los siguientes eventos:
  • Registro
  • Inicio de sesión
  • Inscripción en la autenticación multifactor (MFA) y desafíos
  • Restablecimiento de contraseña
Puede usar el ID de correlación con Universal Login, las plantillas de página de Universal Login, las plantillas de correo electrónico, las plantillas de SMS, las páginas de error personalizadas, Flows y Auth0 Actions.

​
Configurar el ID de correlación

Los valores de correlation_id tienen las siguientes limitaciones:
  • Caracteres permitidos: caracteres alfanuméricos y caracteres especiales que coincidan con /^[-\w.*~@+/:]{1,64}$/.
  • Longitud máxima: 64 caracteres
  • No debe contener ninguna información de identificación personal (PII)
Pase el parámetro correlation_id en el objeto authorizationParams para añadir el ID único a la URL de autorización, como en el siguiente ejemplo: 
const { loginWithRedirect } = useAuth0();
loginWithRedirect({
  authorizationParams: {
    // Agrega "&correlation_id=..." a la URL para rastreo
    correlation_id: "YOUR_CORRELATION_ID"
  }
});

​
Universal Login

Todos los flujos de Universal Login admiten correlation_id. Una vez que pases el valor del ID de correlación al endpoint /authorize, los eventos de autenticación generan registros del inquilino con ese ID de correlación, que puedes usar para hacer seguimiento. Usa el SDK de Management API para recuperar y filtrar eventos recientes a fin de aislar una transacción específica. La siguiente llamada de ejemplo usa el SDK de Management API para recuperar los eventos de autenticación más recientes. Luego, los filtra localmente para aislar un evento específico: 
// 1. Llamar a la Management API (sintaxis de SDK v5)
const { data: logs } = await management.logs.list({
  per_page: 100,
  sort: 'date:-1'
});
// 2. Filtrar el array en el lado del cliente para encontrar tu ID
const transactionEvents = logs.filter(log =>
  log.references?.correlation_id === "YOUR_CORRELATION_ID"
);
console.log(`Found ${transactionEvents.length} events for this transaction.`);

​
Plantilla de la página de inicio de sesión

Si personaliza la experiencia de inicio de sesión con plantillas de página de Universal Login, agregue correlation_id a su plantilla para rastrear eventos de autenticación con un inicio de sesión personalizado. El siguiente ejemplo muestra correlationId: "{{correlation_id}}" agregado a {%- auth0:widget -%}. 
<!-- Ejemplo: Inyectar el ID en un script del lado del cliente -->
<!-- Nota: {{ }} es sintaxis de plantilla Liquid evaluada en el servidor por Auth0, no son marcadores de posición de documentación -->
<script>
  window.addEventListener("load", function () {
    const loginContext = {
      application: "{{application.name}}",
      // Accede al correlation_id directamente mediante sintaxis Liquid
      correlationId: "{{correlation_id}}"
    };

    console.log("Tracking Context:", loginContext);
    // Ahora puedes pasar loginContext.correlationId a tu herramienta de análisis
  });
</script>

​
Plantillas de correo electrónico

Puede incluir correlation_id en Plantillas de correo electrónico para ayudar a rastrear los eventos de autenticación que desencadenan notificaciones por correo electrónico, como restablecimientos de contraseña o correos electrónicos de verificación. El siguiente ejemplo muestra {{correlation_id}} agregado al cuerpo de una plantilla de correo electrónico. 
<p>If you did not initiate this request, please ignore this email.</p>
<p>Tracking reference: {{correlation_id}}</p>

​
Plantillas de SMS

Puede incluir correlation_id en Plantillas de SMS para rastrear los eventos de autenticación que desencadenan notificaciones por SMS, como los desafíos de MFA. En el siguiente ejemplo, se muestra {{correlation_id}} agregado a una plantilla de SMS. 
Your verification code is: {{code}}. Ref: {{correlation_id}}

​
Páginas de error personalizadas

Puede incluir correlation_id en Páginas de error personalizadas para mostrar la referencia de seguimiento directamente en las páginas de error, lo que facilita a los usuarios informar problemas y a su equipo de soporte rastrear la transacción fallida. El siguiente ejemplo muestra {{correlation_id}} añadido a una plantilla de página de error personalizada. 
<h1>{{error | escape}}: {{error_description | escape}}</h1>
<p>Si necesita asistencia, haga referencia a este ID: {{correlation_id}}</p>

​
Auth0 Actions

En Signup and Login Triggers de Auth0 Actions, use el objeto event para registrar eventos en servicios de terceros o enviarlos a API de destino. Los siguientes objetos de evento admiten correlation_id: La Action de ejemplo Post-Login muestra cómo extraer correlation_id del objeto event. 
exports.onExecutePostLogin = async (event, api) => {
  console.log('PostLogin Action Start');
  const correlation_id = event.transaction?.correlation_id;
  // Verificar si existe correlation_id
  if (correlation_id) {
    console.log(`Correlation ID found: ${correlation_id}`);
  } else {
    console.log('No correlation_id found in transaction');
  }
  console.log('PostLogin Action End');
};

​
Formularios

Puede usar ID de correlación en Formularios y Flows. Formularios le permite personalizar el registro y el inicio de sesión con lógica personalizada que cree en Flows. Para usar ID de correlación en Formularios y Flows, use el objeto context en el editor de Flows para agregar la variable de eventos correlacionados {{context.transaction.correlation_id}} a su lógica. Para obtener más información, consulte Variables and helper functions.