MfaBeginEnrollOptions

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

La clase MfaBeginEnrollOptions implementa la funcionalidad de la pantalla mfa-begin-enroll-options. Esta pantalla gestiona la selección y la inscripción de factores de MFA.

​

Constructores

Crea una instancia del administrador de la pantalla MFA Begin Enroll Options:

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.enroll({
  action: 'push-notification'
});

​

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-begin-enroll-options.

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-begin-enroll-options, 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-begin-enroll-options, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Contiene datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante la inscripción en MFA.

user · UserMembers

Detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma de la página de Universal Login.

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
mfaBeginEnrollOptions.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.

enroll · Promise<void>

Este método continúa el proceso de inscripción con el factor seleccionado.

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';

const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.enroll({
  action: 'push-notification'
});

Parámetros del método

Mostrar Parámetros

options

MfaEnrollOptions.

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "webauthn-roaming" · requerido

La acción que indica qué factor se va a inscribir. Uno de “push-notification”, “otp”, “sms”, “phone”, “voice” o “webauthn-roaming”.

getErrors · Error []

Este método obtiene el array de errores de la transacción desde el contexto, o un array vacío si no hay ninguno.