MfaRecoveryCodeChallenge

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

La clase MfaRecoveryCodeChallenge implementa la funcionalidad de la pantalla mfa-recovery-code-challenge. Esta pantalla se muestra cuando el usuario debe introducir un código de recuperación para iniciar sesión.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío del código de recuperación de MFA:

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' });

​

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-recovery-code-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 · ScreenMembers

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

untrustedData · UntrustedDataMembers

Gestiona datos no confiables que se pasan al SDK, como la entrada del usuario durante la verificación del código de recuperación de MFA.

user · UserMembers

Incluye los detalles del usuario activo, como 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 MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
mfaRecoveryCodeChallenge.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 código de recuperación proporcionado.

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' });

Parámetros del método

Mostrar Parámetros

options

MfaRecoveryCodeChallengeContinueOptions.

code · string · requerido

El código de recuperación introducido por el usuario.

getErrors · Error []

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

tryAnotherMethod · Promise<void>

Este método navega a la pantalla donde el usuario puede elegir otro método de MFA.

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.tryAnotherMethod();