MfaVoiceEnrollment

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

La clase MfaVoiceEnrollment implementa la funcionalidad de la pantalla mfa-voice-enrollment. Esta pantalla se muestra cuando el usuario debe introducir un número de teléfono para recibir una llamada de voz con un código de verificación y continuar con la inscripción.

​

Constructores

Cree una instancia del administrador de la pantalla de inscripción de MFA Voice:

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.continue({ phone: '[phone]' });

​

Propiedades

branding · BrandingMembers

Proporciona configuración relacionada con la marca, como el tema y los ajustes de marca.

client · ClientMembers

Proporciona configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla mfa-voice-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-voice-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-voice-enrollment, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Gestiona datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante la inscripción en MFA por voz.

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

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
mfaVoiceEnrollment.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.

continue · Promise<void>

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

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.continue({ phone: '[phone]' });

Parámetros del método

Mostrar Parámetros

options

MfaVoiceEnrollmentContinueOptions.

phone · string · requerido

El número de teléfono del usuario para recibir la llamada de voz.

getErrors · Error []

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

selectPhoneCountryCode · Promise<void>

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

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.selectPhoneCountryCode();

tryAnotherMethod · Promise<void>

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

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.tryAnotherMethod();