MfaPushWelcome

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

La clase MfaPushWelcome implementa la funcionalidad de la pantalla mfa-push-welcome.

​

Constructores

Crea una instancia del administrador de la pantalla de bienvenida de MFA Push:

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

​

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-push-welcome.

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

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

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante la pantalla de bienvenida de MFA push.

user · UserMembers

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

​

Métodos

changeLanguage · Promise<void>

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

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';
const mfaPushWelcome = new MfaPushWelcome();
mfaPushWelcome.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 como 'session', el idioma seleccionado se conserva durante toda la sesión.

enroll · Promise<void>

Este método navega a la pantalla de inscripción.

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

getErrors · Error []

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

pickAuthenticator · Promise<void>

Este método navega a la pantalla de selección de autenticador.

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.pickAuthenticator();