MfaLoginOptions

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

La clase MfaLoginOptions implementa la funcionalidad de la pantalla mfa-login-options. Esta pantalla permite a los usuarios seleccionar qué factor de MFA quieren usar para iniciar sesión.

​

Constructores

Cree una instancia del administrador de la pantalla de opciones de inicio de sesión MFA:

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

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

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la 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-login-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 · ScreenMembersOnMfaLoginOptions

Contiene detalles específicos de la pantalla mfa-login-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-login-options, 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 selección de opciones de inicio de sesión con MFA.

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 MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';
const mfaLoginOptions = new MfaLoginOptions();
mfaLoginOptions.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 inicio de sesión con el factor de MFA seleccionado.

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

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

Parámetros del método

Mostrar Parámetros

options

LoginEnrollOptions.

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "email" | "recovery-code" | "webauthn-roaming" | "webauthn-platform" | "duo" · requerido

La acción que indica qué factor se debe inscribir. Una de “push-notification”, “otp”, “sms”, “phone”, “voice”, “email”, “recovery-code”, “webauthn-roaming”, “webauthn-platform” o “duo”.

getErrors · Error []

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

returnToPrevious · Promise<void>

Este método regresa a la pantalla anterior.

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.returnToPrevious();