MfaOtpChallenge

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

La clase MfaOtpChallenge implementa la funcionalidad de la pantalla mfa-otp-challenge. Esta pantalla se muestra cuando un usuario necesita introducir un código OTP durante MFA.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío OTP de MFA:

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

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

​

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-otp-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 · ScreenMembersOnMfaOtpChallenge

Contiene detalles específicos de la pantalla mfa-otp-challenge, incluida su configuración y contexto.

tenant · TenantMembers

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

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla mfa-otp-challenge, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembersOnMfaOtpChallenge

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

user · UserMembers

Contiene 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 MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';
const mfaOtpChallenge = new MfaOtpChallenge();
mfaOtpChallenge.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 el desafío de OTP con el code proporcionado.

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

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

Parámetros del método

Mostrar Parámetros

options

ContinueOTPOptions.

code · string · requerido

El código OTP introducido por el usuario.

rememberDevice? · boolean

Indica si se debe recordar el navegador.

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.

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.tryAnotherMethod();