ResetPasswordMfaVoiceChallenge

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran reset-password-mfa-voice-challenge d’Universal Login.

La classe ResetPasswordMfaVoiceChallenge implémente les fonctionnalités de l’écran reset-password-mfa-voice-challenge. Cet écran invite l’utilisateur à saisir le code de vérification transmis par appel vocal dans le cadre de l’étape MFA lors d’un flux de réinitialisation du mot de passe.

​

Constructeurs

Créez une instance du gestionnaire de l’écran ResetPasswordMfaVoiceChallenge :

Example

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

​

Propriétés

branding · BrandingMembers

Fournit la configuration liée à l’image de marque, comme le thème et les paramètres.

client · ClientMembers

Fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran reset-password-mfa-voice-challenge.

organization · OrganizationMembers

Fournit des renseignements sur l’organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’invite actuelle du flux d’authentification.

screen · ScreenMembersOnResetPasswordMfaVoiceChallenge

Contient les détails propres à l’écran reset-password-mfa-voice-challenge, y compris sa configuration et son contexte.

tenant · TenantMembers

Contient des données liées au locataire, comme id et les métadonnées associées.

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran reset-password-mfa-voice-challenge, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant le flux de défi MFA.

user · UserMembers

Contient les détails de l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge';
const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge();
resetPasswordMfaVoiceChallengeManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue souhaité (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque cette option est définie à 'session', la langue sélectionnée est conservée pendant toute la session.

continue · Promise<void>

Cette méthode soumet le code de vérification envoyé par appel vocal pour poursuivre le défi MFA pendant le flux de réinitialisation du mot de passe.

Example

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

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaVoiceChallengeContinueOptions.

code · string · requis

Le code de vérification envoyé à l’utilisateur par appel vocal.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune.

resendCode · Promise<void>

Cette méthode renvoie le code de vérification à l’utilisateur par appel vocal.

Example

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

resendManager · ResendControl

Cette méthode fournit une fonction de renvoi avec gestion du délai d’expiration. Elle retourne un objet ResendControl avec une méthode startResend() qui déclenche le renvoi et impose une période d’attente avant que l’utilisateur puisse renvoyer à nouveau.

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');
  }
});

// Appeler startResend lorsque l’utilisateur clique sur le bouton de renvoi
startResend();

Paramètres de la méthode

Afficher Paramètres

options

StartResendOptions.

timeoutSeconds? · number

La durée de la période d’attente, en secondes, avant que l’utilisateur puisse renvoyer le code à nouveau.

onStatusChange? · OnStatusChangeCallback

Callback invoqué chaque fois que le statut du renvoi change; il retourne le nombre de secondes restantes et indique si la fonction de renvoi est actuellement désactivée.

onTimeout? · () => void

Callback invoqué lorsque la période d’attente expire et que le renvoi redevient possible.

switchToSms · Promise<void>

Cette méthode bascule l’utilisateur vers la vérification par SMS plutôt que vers l’appel vocal.

Example

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

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de sélectionner une autre méthode MFA pour terminer le défi.

Example

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