MfaRecoveryCodeEnrollment

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

La classe MfaRecoveryCodeEnrollment implémente la fonctionnalité de l’écran mfa-recovery-code-enrollment. Cet écran s’affiche lorsque l’utilisateur doit s’enrôler avec un code de récupération pour la MFA.

​

Constructeurs

Créez une instance du gestionnaire de l’écran d’enrôlement du code de récupération MFA :

Example

import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';

const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment();
await mfaRecoveryCodeEnrollment.continue({ isCodeCopied: true });

​

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 mfa-recovery-code-enrollment.

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 · ScreenMembersOnMfaRecoveryCodeEnrollment

Contient les détails propres à l’écran mfa-recovery-code-enrollment, 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-recovery-code-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’enrôlement du code de récupération MFA.

user · UserMembers

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 MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';

const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment();
mfaRecoveryCodeEnrollment.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"

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 indique que l’utilisateur a enregistré le code de récupération et poursuit l’enrôlement.

Example

import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';

const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment();
await mfaRecoveryCodeEnrollment.continue({ isCodeCopied: true });

Paramètres de la méthode

Afficher Paramètres

options

MfaRecoveryCodeEnrollmentContinueOptions.

isCodeCopied? · boolean

Indique si l’utilisateur a copié le code de récupération.

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.