MfaSmsList

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

La clase MfaSmsList implementa la funcionalidad de la pantalla mfa-sms-list. Esta pantalla se muestra cuando el usuario necesita seleccionar un número de teléfono inscrito para MFA por SMS.

​

Constructores

Cree una instancia del administrador de la pantalla de lista de SMS para MFA:

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.selectPhoneNumber({ index: 0 });

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la marca, como el tema y la configuración de marca.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-sms-list.

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-sms-list, incluida su configuración y contexto.

tenant · TenantMembers

Contiene datos relacionados con el inquilino, como id y sus metadatos asociados.

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla mfa-sms-list, como los identificadores activos y los estados del flujo.

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como la entrada del usuario durante la selección de la lista de SMS de MFA.

user · UserMembers

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

​

Métodos

backAction · Promise<void>

Este método vuelve a la pantalla anterior.

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.backAction();

changeLanguage · Promise<void>

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

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
mfaSmsList.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 mantiene durante toda la sesión.

getErrors · Error []

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

selectPhoneNumber · Promise<void>

Este método selecciona un número de teléfono de la lista de números inscritos.

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.selectPhoneNumber({ index: 0 });

Parámetros del método

Mostrar Parámetros

options

MfaSmsListOptions.

index · number · requerido

El índice del número de teléfono que se va a seleccionar.