MfaPushEnrollmentQr

Describe todas las propiedades y los métodos disponibles para personalizar la pantalla mfa-push-enrollment-qr de Universal Login.

La clase MfaPushEnrollmentQr implementa la funcionalidad de la pantalla mfa-push-enrollment-qr.

​

Constructores

Cree una instancia del administrador de la pantalla de inscripción con código QR de MFA Push:

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la marca, como el tema y otros ajustes de marca.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-push-enrollment-qr.

organization · OrganizationMembers

Proporciona información sobre la Organización del usuario, como id y name.

prompt · PromptMembers

Contiene datos sobre la pantalla actual del flujo de autenticación.

screen · ScreenMembersOnMfaPushEnrollmentQr

Contiene detalles específicos de la pantalla mfa-push-enrollment-qr, incluida su configuración y contexto.

tenant · TenantMembers

Contiene datos relacionados con el inquilino, como id y los metadatos asociados.

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla mfa-push-enrollment-qr, como los identificadores activos y los estados del flujo.

untrustedData · UntrustedDataMembers

Gestiona datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante la inscripción en MFA push.

user · UserMembers

Detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma que se muestra en la página de Universal Login.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
mfaPushEnrollmentQr.changeLanguage({
  language: 'fr',
});

Parámetros del método

Mostrar Parámetros

options

LanguageChangeOptions.

language · string · requerido

El código de configuración regional del idioma deseado (por ejemplo, 'en', 'fr', 'es').

persist? · "session"

Cuando se establece en 'session', el idioma seleccionado se conserva durante toda la sesión.

continue · Promise<void>

Este método continúa con la inscripción en las notificaciones push.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.continue();

Parámetros del método

Mostrar Parámetros

options

MfaPushEnrollmentQrWithRememberOptions.

rememberDevice? · boolean

Indica si se debe recordar el dispositivo.

getErrors · Error []

Este método recupera la lista de errores de la transacción desde el contexto, o una lista vacía si no hay ninguno.

pickAuthenticator · Promise<void>

Este método navega a la pantalla de selección del autenticador.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

pollingManager · MfaPushPollingControl

Este método inicia y administra el sondeo para una inscripción en MFA push.

Crea una sesión de sondeo que consulta repetidamente el endpoint de inscripción en MFA push en el intervalo especificado hasta que la inscripción se apruebe o se produzca un error. Cuando se cumple la condición de aprobación, se invoca el callback onCompleted proporcionado y el sondeo se detiene automáticamente.

Utilice el MfaPushPollingControl devuelto para iniciar, detener o consultar el estado del proceso de sondeo en cualquier momento.

Devuelve una instancia de MfaPushPollingControl que expone:

• startPolling() — Inicia o reanuda el sondeo.
• stopPolling() — Cancela el sondeo de inmediato.
• isRunning() — Indica si el sondeo está activo en ese momento.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();

// Inicia el sondeo cada 5 segundos hasta que se apruebe la inscripción de push
const control = mfaPushEnrollmentQr.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushEnrollmentQr.continue(),
  onError: (error) => console.error('Error de sondeo:', error),
});

// Más tarde, cancela el sondeo si es necesario
control.stopPolling();

Observaciones

• Las respuestas HTTP 429 (límite de tasa) se gestionan internamente: el sondeo espera automáticamente hasta que se restablezca el límite antes de volver a intentarlo.
• Puede llamar a startPolling() varias veces sin problema; no tiene efecto si ya se está ejecutando.

Parámetros del método

Mostrar Parámetros

options

MfaPollingOptions.

intervalMs? · number

Intervalo opcional, en milisegundos, entre solicitudes de sondeo consecutivas. Si se omite, se usa el intervalo predeterminado interno del SDK (normalmente 5000 ms).

onCompleted()? · () => void

Callback opcional que se ejecuta cuando la inscripción en MFA push se aprueba correctamente y el sondeo finaliza. Se llama exactamente una vez, tras lo cual el sondeo se detiene automáticamente.

onError()? · (error) => void

Callback opcional que se invoca si se produce un error durante el sondeo. Recibe un objeto ULError que contiene status (código de estado HTTP) y responseText (cuerpo sin procesar de la respuesta).