MfaEmailChallenge

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

La clase MfaEmailChallenge implementa la funcionalidad de la pantalla mfa-email-challenge. Esta pantalla se muestra cuando un usuario debe verificar su correo electrónico durante el proceso de MFA.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío por correo electrónico de MFA:

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones de marca, como el tema y los ajustes de marca.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-email-challenge.

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 · ScreenMembersOnMfaEmailChallenge

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

untrustedData · UntrustedDataMembersOnMfaEmailChallenge

Gestiona datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante la verificación por correo electrónico de MFA.

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 MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallenge = new MfaEmailChallenge();
mfaEmailChallenge.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 el desafío por correo electrónico usando el código proporcionado.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

Parámetros del método

Mostrar Parámetros

options

ContinuePayloadOptions.

code · string · requerido

El código introducido por el usuario.

rememberDevice? · boolean

Indica si se debe recordar el dispositivo.

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.

pickEmail · Promise<void>

Este método envía la acción para seleccionar una configuración de correo electrónico diferente, si está disponible.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.pickEmail();

resendCode · Promise<void>

Este método reenvía el código por correo electrónico.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.resendCode();

resendManager · ResendControl

Este método proporciona funcionalidad de reenvío con gestión del tiempo de espera para esta pantalla.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
const { startResend } = mfaEmailChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Reenvío disponible en ${remainingSeconds}s, deshabilitado: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('El reenvío ya está disponible');
  }
});

// Llama a startResend cuando el usuario haga clic en el botón de reenvío
startResend();

Parámetros del método

Mostrar Parámetros

options

StartResendOptions.

timeoutSeconds? · number

La duración del período de espera, en segundos, antes de que el usuario pueda reenviar el código nuevamente.

onStatusChange? · OnStatusChangeCallback

Callback que se invoca cada vez que cambia el estado del reenvío; devuelve los segundos restantes y si la funcionalidad de reenvío está deshabilitada en ese momento.

onTimeout? · () => void

Callback que se invoca cuando expira el período de espera y el reenvío vuelve a estar disponible.

tryAnotherMethod · Promise<void>

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

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.tryAnotherMethod();