MfaVoiceChallenge

Décrit toutes les propriétés et méthodes permettant de personnaliser l’écran mfa-voice-challenge d’Universal Login.

La classe MfaVoiceChallenge implémente les fonctionnalités de l’écran mfa-voice-challenge. Cet écran s’affiche lorsque l’utilisateur doit saisir un code reçu par appel vocal pour vérifier son identité.

​

Constructeurs

Créez une instance du gestionnaire de l’écran de défi vocal AMF :

Example

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

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

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème de l’image de marque et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran 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 actuel dans le flux d’authentification.

screen · ScreenMembersOnMfaVoiceChallenge

Contient des détails propres à l’écran 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 mfa-voice-challenge, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembersOnMfaVoiceChallenge

Gère les données non fiables transmises au SDK, comme les entrées utilisateur pendant la vérification vocale par AMF.

user · UserMembers

Détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Example

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

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsque défini à 'session', la langue sélectionnée est enregistrée pour toute la durée de la session.

continue · Promise<void>

Cette méthode soumet le code de vérification reçu par appel vocal pour valider le défi AMF.

Example

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

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

Paramètres de la méthode

Afficher Paramètres

options

MfaVoiceChallengeContinueOptions.

code · string · requis

Le code de vérification reçu par appel vocal.

rememberDevice? · boolean

Lorsque true, mémorise le navigateur pour les prochains défis AMF. S’applique uniquement si screen.showRememberDevice est true.

getErrors · Error []

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

pickPhone · Promise<void>

Cette méthode mène à l’écran où l’utilisateur peut sélectionner un autre numéro de téléphone.

Example

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

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

resendCode · Promise<void>

Cette méthode demande un nouvel appel vocal contenant un code de vérification.

Example

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

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

resendManager · ResendControl

Cette méthode fournit une fonctionnalité de renvoi avec une gestion configurable du délai d’expiration et de l’état.

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();

Paramètres de la méthode

Afficher Paramètres

options

StartResendOptions.

onStatusChange? · OnStatusChangeCallback

Fonction de rappel invoquée chaque fois que l’état du renvoi change; elle reçoit le nombre de secondes restantes et indique si le renvoi est actuellement désactivé.

onTimeout? · () => void

Fonction de rappel invoquée lorsque le délai d’expiration du renvoi prend fin et que l’option de renvoi redevient disponible.

timeoutSeconds? · number

Le nombre de secondes avant que l’option de renvoi devienne disponible.

switchToSms · Promise<void>

Cette méthode fait passer la méthode de vérification à SMS.

Example

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

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

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de passer à une autre méthode d’AMF.

Example

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

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