MfaPhoneEnrollment

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

La clase MfaPhoneEnrollment implementa la funcionalidad de la pantalla mfa-phone-enrollment. Esta pantalla permite a los usuarios inscribirse en MFA con un número de teléfono.

​

Constructores

Cree una instancia del administrador de la pantalla de inscripción de teléfono para MFA:

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '[phone]', type: 'sms' });

​

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

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-phone-enrollment, 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-phone-enrollment, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables pasados al SDK, como la entrada del usuario durante la inscripción del teléfono 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 visualización de la página de Universal Login.

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollment = new MfaPhoneEnrollment();
mfaPhoneEnrollment.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 toda la sesión.

continueEnrollment · Promise<void>

Este método continúa el proceso de inscripción con el número de teléfono y el tipo proporcionados (SMS o voz).

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '[phone]', type: 'sms' });

Parámetros del método

Mostrar Parámetros

options

MfaPhoneEnrollmentContinueOptions.

phone · string · requerido

El número de teléfono del usuario.

type · "sms" | "voice" · requerido

El método de entrega del código de verificación.

getErrors · Error []

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

pickCountryCode · Promise<void>

Este método navega a la pantalla de selección del código de país.

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.pickCountryCode();

tryAnotherMethod · Promise<void>

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

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.tryAnotherMethod();