MfaVoiceChallenge

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

La clase MfaVoiceChallenge implementa la funcionalidad de la pantalla mfa-voice-challenge. Esta pantalla se muestra cuando el usuario necesita introducir un código recibido mediante una llamada de voz para verificar su identidad.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío de voz de MFA:

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.continue({ code: '123456' });

​

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-voice-challenge.

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

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

untrustedData · UntrustedDataMembersOnMfaVoiceChallenge

Gestiona datos no confiables que se pasan al SDK, como la entrada del usuario durante el desafío de voz de 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 MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.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.

continue · Promise<void>

Este método envía el código de verificación por voz para validar el desafío de MFA.

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.continue({
  code: '123456',
  rememberDevice: true,
});

Parámetros del método

Mostrar Parámetros

options

MfaVoiceChallengeContinueOptions.

code · string · requerido

El código de verificación recibido mediante una llamada de voz.

rememberDevice? · boolean

Cuando es true, recuerda el navegador para futuros desafíos de MFA. Solo se aplica si screen.showRememberDevice es true.

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.

pickPhone · Promise<void>

Este método navega a la pantalla donde el usuario puede seleccionar otro número de teléfono.

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.pickPhone();

resendCode · Promise<void>

Este método solicita una nueva llamada de voz con un código de verificación.

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.resendCode();

resendManager · ResendControl

Este método proporciona la funcionalidad de reenvío con un tiempo de espera configurable y gestión de estado.

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
const { startResend } = mfaVoiceChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  },
});

startResend();

Parámetros del método

Mostrar Parámetros

options

StartResendOptions.

onStatusChange? · OnStatusChangeCallback

Función de callback que se invoca cada vez que cambia el estado del reenvío y recibe los segundos restantes y si el reenvío está deshabilitado en ese momento.

onTimeout? · () => void

Función de callback que se invoca cuando vence el tiempo de espera del reenvío y la opción de reenvío vuelve a estar disponible.

timeoutSeconds? · number

El número de segundos antes de que la opción de reenvío esté disponible.

switchToSms · Promise<void>

Este método cambia el método de verificación a SMS.

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.switchToSms();

tryAnotherMethod · Promise<void>

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

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.tryAnotherMethod();