MfaSmsEnrollment

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

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

​

Constructores

Cree una instancia del administrador de la pantalla de inscripción en MFA por SMS:

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones de marca, como el tema y otros ajustes de marca.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-sms-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 · ScreenMembersOnMfaSmsEnrollment

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

untrustedData · UntrustedDataMembers

Gestiona datos no confiables que se pasan al SDK, como la entrada del usuario durante la inscripción en MFA por SMS.

user · UserMembers

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 MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
mfaSmsEnrollment.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.

continueEnrollment · Promise<void>

Este método continúa el proceso de inscripción mediante SMS con el número de teléfono proporcionado.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

Parámetros del método

Mostrar Parámetros

options

MfaSmsEnrollmentOptions.

captcha? · string

El código CAPTCHA o la respuesta del proveedor de CAPTCHA. Es obligatorio si tu inquilino de Auth0 tiene Bot Detection habilitado.

phone? · string

El número de teléfono del usuario.

getErrors · Error []

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

pickCountryCode · Promise<void>

Este método lleva a la pantalla donde el usuario puede seleccionar un código de país para su número de teléfono.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.pickCountryCode();

tryAnotherMethod · Promise<void>

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

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.tryAnotherMethod();