MfaPushChallengePush

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

La clase MfaPushChallengePush implementa la funcionalidad de la pantalla mfa-push-challenge-push. Esta pantalla se muestra cuando un usuario debe confirmar una notificación push durante MFA.

​

Constructores

Cree una instancia del administrador de la pantalla MFA Push Challenge Push:

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

​

Propiedades

branding · BrandingMembers

Proporciona configuración relacionada con la marca, como el tema y otros ajustes de marca.

client · ClientMembers

Proporciona configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla mfa-push-challenge-push.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaPushChallengePush

Contiene detalles específicos de la pantalla mfa-push-challenge-push, 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-challenge-push, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembersOnMfaPushChallengePush

Gestiona los datos no confiables que se pasan al SDK, como la entrada del usuario durante el desafío de MFA push.

user · UserMembers

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

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma de visualización de la página de Universal Login.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';
const mfaPushChallengePush = new MfaPushChallengePush();
mfaPushChallengePush.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 mantiene durante toda la sesión.

continue · Promise<void>

Este método continúa con el desafío de notificación push.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

Parámetros del método

Mostrar Parámetros

options

WithRememberOptions.

rememberDevice? · boolean

Indica si se debe recordar el dispositivo.

enterCodeManually · Promise<void>

Este método cambia a la introducción manual del código de verificación.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.enterCodeManually();

getErrors · Error []

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

pollingManager · MfaPushPollingControl

Este método inicia y administra el sondeo de un desafío de MFA push.

Crea una sesión de sondeo que consulta repetidamente el endpoint del desafío de MFA push en el intervalo especificado hasta que el desafío 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 valor devuelto MfaPushPollingControl para iniciar, detener o comprobar 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 MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();

// Inicia el sondeo cada 5 segundos hasta que se apruebe el desafío push
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.continue(),
  onError: (error) => console.error('Error de sondeo:', error),
});

// Más adelante, 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 restablece el límite de tasa antes de reintentarlo.
• Es seguro llamar a startPolling() varias veces; no tiene efecto si ya está en ejecución.

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 interno predeterminado del SDK (normalmente, 5000 ms).

onCompleted()? · () => void

Callback opcional que se ejecuta cuando el desafío de 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 de la respuesta sin procesar).

resendPushNotification · Promise<void>

Este método vuelve a enviar la notificación push.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.resendPushNotification();

Parámetros del método

Mostrar Parámetros

options

WithRememberOptions.

rememberDevice? · boolean

Indica si se debe recordar el dispositivo.

tryAnotherMethod · Promise<void>

Este método permite al usuario intentar otro método de MFA.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.tryAnotherMethod();