MfaPhoneEnrollment

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

La classe MfaPhoneEnrollment implémente les fonctionnalités de l’écran mfa-phone-enrollment. Cet écran permet aux utilisateurs de s’inscrire à la MFA à l’aide d’un numéro de téléphone.

​

Constructeurs

Créez une instance du gestionnaire de l’écran d’inscription MFA par téléphone :

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '[phone]', type: 'sms' });

​

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 mfa-phone-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 en cours dans le flux d’authentification.

screen · ScreenMembers

Contient des détails propres à l’écran mfa-phone-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-phone-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 pendant l’inscription du téléphone à la MFA.

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 MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollment = new MfaPhoneEnrollment();
mfaPhoneEnrollment.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"

Lorsqu’il est défini à 'session', la langue sélectionnée est conservée pendant toute la session.

continueEnrollment · Promise<void>

Cette méthode poursuit le processus d’inscription avec le numéro de téléphone et le type fournis (SMS ou appel vocal).

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '[phone]', type: 'sms' });

Paramètres de la méthode

Afficher Paramètres

options

MfaPhoneEnrollmentContinueOptions.

phone · string · requis

Le numéro de téléphone de l’utilisateur.

type · "sms" | "voice" · requis

Le mode d’envoi du code de vérification.

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.

pickCountryCode · Promise<void>

Cette méthode redirige vers l’écran de sélection de l’indicatif du pays.

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.pickCountryCode();

tryAnotherMethod · Promise<void>

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

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.tryAnotherMethod();