MfaOtpEnrollmentQr

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

La clase MfaOtpEnrollmentQr implementa la funcionalidad de la pantalla mfa-otp-enrollment-qr. Esta pantalla muestra un código QR para que el usuario lo escanee con su aplicación de autenticación durante la inscripción en MFA.

​

Constructores

Cree una instancia del administrador de la pantalla QR de inscripción de MFA OTP:

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

​

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-enrollment-qr.

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

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

untrustedData · UntrustedDataMembers

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

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 MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
mfaOtpEnrollmentQr.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 la sesión.

continue · Promise<void>

Este método envía el código OTP para continuar el proceso de inscripción.

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.continue({ code: '123456' });

Parámetros del método

Mostrar Parámetros

options

MfaOtpEnrollmentQrContinueOptions.

code · string · requerido

El código OTP introducido por el usuario.

getErrors · Error []

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

toggleView · Promise<void>

Este método alterna entre las vistas de código QR y entrada manual.

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.tryAnotherMethod();