ResetPasswordMfaVoiceChallenge

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

La clase ResetPasswordMfaVoiceChallenge implementa la funcionalidad de la pantalla reset-password-mfa-voice-challenge. Esta pantalla solicita al usuario que introduzca el código de verificación recibido mediante una llamada de voz como parte del paso de MFA durante un flujo de restablecimiento de contraseña.

​

Constructores

Cree una instancia del administrador de la pantalla ResetPasswordMfaVoiceChallenge:

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
await resetPasswordMfaVoiceChallengeManager.continue({ code: '123456' });

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la 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 reset-password-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 · ScreenMembersOnResetPasswordMfaVoiceChallenge

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

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante el flujo de desafío 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 ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
resetPasswordMfaVoiceChallengeManager.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 envía el código de verificación de la llamada de voz para continuar el desafío de MFA durante el flujo de restablecimiento de contraseña.

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
await resetPasswordMfaVoiceChallengeManager.continue({ code: '123456' });

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaVoiceChallengeContinueOptions.

code · string · requerido

El código de verificación enviado al usuario mediante una llamada de voz.

getErrors · Error []

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

resendCode · Promise<void>

Este método reenvía el código de verificación al usuario mediante una llamada de voz.

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
await resetPasswordMfaVoiceChallengeManager.resendCode();

resendManager · ResendControl

Este método proporciona funcionalidad de reenvío con gestión del tiempo de espera. Devuelve un objeto ResendControl con un método startResend() que activa el reenvío y aplica un período de espera antes de que el usuario pueda volver a reenviar el código.

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
const { startResend } = resetPasswordMfaVoiceChallengeManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Llame a startResend cuando el usuario haga clic en el botón de reenvío
startResend();

Parámetros del método

Mostrar Parámetros

options

StartResendOptions.

timeoutSeconds? · number

La duración del período de espera, en segundos, antes de que el usuario pueda volver a reenviar el código.

onStatusChange? · OnStatusChangeCallback

Función de devolución de llamada que se invoca cada vez que cambia el estado del reenvío; devuelve los segundos restantes y si la funcionalidad de reenvío está deshabilitada en ese momento.

onTimeout? · () => void

Función de devolución de llamada que se invoca cuando vence el período de espera y el reenvío vuelve a estar disponible.

switchToSms · Promise<void>

Este método cambia al usuario a la verificación por SMS en lugar de una llamada de voz.

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
await resetPasswordMfaVoiceChallengeManager.switchToSms();

tryAnotherMethod · Promise<void>

Este método permite al usuario seleccionar otro método de MFA para completar el desafío.

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
await resetPasswordMfaVoiceChallengeManager.tryAnotherMethod();