MfaVoiceEnrollment

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

La classe MfaVoiceEnrollment implémente les fonctionnalités de l’écran mfa-voice-enrollment. Cet écran s’affiche lorsque l’utilisateur doit saisir un numéro de téléphone pour recevoir un appel vocal contenant un code de vérification afin de poursuivre l’inscription.

​

Constructeurs

Créez une instance du gestionnaire de l’écran d’inscription vocale MFA :

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.continue({ phone: '[phone]' });

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

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 dans le flux d’authentification.

screen · ScreenMembers

Contient des détails propres à l’écran mfa-voice-enrollment, 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-enrollment, 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 lors de l’inscription vocale à la 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 MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
mfaVoiceEnrollment.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’il est défini sur 'session', la langue sélectionnée est conservée pendant toute la durée de la session.

continue · Promise<void>

Cette méthode poursuit le processus d’inscription vocale à l’aide du numéro de téléphone fourni.

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.continue({ phone: '[phone]' });

Paramètres de la méthode

Afficher Paramètres

options

MfaVoiceEnrollmentContinueOptions.

phone · string · requis

Le numéro de téléphone de l’utilisateur qui recevra l’appel vocal.

getErrors · Error []

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

selectPhoneCountryCode · Promise<void>

Cette méthode ouvre l’écran où l’utilisateur peut sélectionner l’indicatif de pays pour son numéro de téléphone.

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.selectPhoneCountryCode();

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur d’essayer une autre méthode de MFA.

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.tryAnotherMethod();