MfaOtpEnrollmentCode

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

La clase MfaOtpEnrollmentCode implementa la funcionalidad de la pantalla mfa-otp-enrollment-code. Esta pantalla se muestra cuando el usuario necesita introducir el código OTP recibido durante la inscripción en MFA.

​

Constructores

Cree una instancia del administrador de pantalla del código de inscripción OTP para MFA:

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

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

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

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

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como la entrada del usuario durante la inscripción en MFA con OTP.

user · UserMembers

Contiene 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 MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';
const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
mfaOtpEnrollmentCode.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"

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

continue · Promise<void>

Este método continúa el proceso de inscripción en MFA OTP enviando el código OTP.

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

Parámetros del método

Mostrar Parámetros

options

MfaOtpContinueOptions.

code · string · requerido

El código OTP que introdujo el usuario.

getErrors · Error []

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

toggleView · Promise<void>

Este método alterna entre la vista de código QR y la de entrada manual.

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.toggleView();

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.tryAnotherMethod();