MfaVoiceChallenge

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

La classe MfaVoiceChallenge implémente la fonctionnalité 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 MFA Voice Challenge :

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 d’image de marque, comme le thème et les paramètres associés.

client · ClientMembers

Fournit des configurations liées à l’application, 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 l’invite en cours 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 locataire, 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 saisies de l’utilisateur lors de la vérification vocale MFA.

user · UserMembers

Renseignements sur 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 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 paramètre régional de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie sur '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 vocale pour valider le défi MFA.

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, le navigateur est mémorisé pour les futurs défis MFA. S’applique uniquement si screen.showRememberDevice est true.

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.

pickPhone · Promise<void>

Cette méthode accède à 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 avec 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 un délai d’expiration et une gestion d’état configurables.

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 est écoulé et que l’option de renvoi devient disponible.

timeoutSeconds? · number

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

switchToSms · Promise<void>

Cette méthode bascule la méthode de vérification vers le 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 d’utiliser une autre méthode de MFA.

Example

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

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