ResetPasswordMfaVoiceChallenge

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

La classe ResetPasswordMfaVoiceChallenge implémente la fonctionnalité de l’écran reset-password-mfa-voice-challenge. Cet écran invite l’utilisateur à saisir le code de vérification envoyé par appel vocal à l’étape d’AMF du processus de réinitialisation du mot de passe.

​

Constructeurs

Créez une instance du gestionnaire d’é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 des configurations liées à l’image de marque, comme le thème d’image de marque et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, 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 le prompt en cours dans le flux d’authentification.

screen · ScreenMembersOnResetPasswordMfaVoiceChallenge

Contient des 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 tenant, 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 entrées de l’utilisateur pendant le flux de vérification AMF.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris 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 paramètres régionaux de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est enregistrée pour la durée de la session.

continue · Promise<void>

Cette méthode soumet le code de vérification par appel vocal pour poursuivre le défi d’AMF pendant le processus 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 transmis à l’utilisateur par appel vocal.

getErrors · Error []

Cette méthode récupère dans le contexte le tableau des erreurs de transaction, 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 offre une fonctionnalité de renvoi avec gestion du délai d’expiration. Elle retourne un objet ResendControl doté d’une méthode startResend() qui déclenche le renvoi et impose une période d’attente avant que l’utilisateur puisse renvoyer le code.

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.

onStatusChange? · OnStatusChangeCallback

Fonction de rappel appelée chaque fois que le statut du renvoi change; elle retourne le nombre de secondes restantes et indique si la fonctionnalité de renvoi est actuellement désactivée.

onTimeout? · () => void

Fonction de rappel appelée lorsque la période d’attente expire et que le renvoi redevient disponible.

switchToSms · Promise<void>

Cette méthode fait passer l’utilisateur à la vérification par SMS plutôt qu’à 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 choisir une autre méthode d’AMF 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();