MfaRecoveryCodeChallenge

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

La classe MfaRecoveryCodeChallenge implémente les fonctionnalités de l’écran mfa-recovery-code-challenge. Cet écran s’affiche lorsque l’utilisateur doit saisir un code de récupération pour se connecter.

​

Constructeurs

Créez une instance du gestionnaire de l’écran AMF Recovery Code Challenge :

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' });

​

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 associés.

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran mfa-recovery-code-challenge.

organization · OrganizationMembers

Fournit des renseignements sur l’Organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’étape actuelle du flux d’authentification.

screen · ScreenMembers

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

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant l’étape de code de récupération AMF.

user · UserMembers

Détails 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 de connexion Universal Login.

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
mfaRecoveryCodeChallenge.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 enregistrée pour la durée de la session.

continue · Promise<void>

Cette méthode poursuit le flux à l’aide du code de récupération fourni.

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' });

Paramètres de la méthode

Afficher Paramètres

options

MfaRecoveryCodeChallengeContinueOptions.

code · string · requis

Le code de récupération saisi par l’utilisateur.

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.

tryAnotherMethod · Promise<void>

Cette méthode mène à l’écran où l’utilisateur peut choisir une autre méthode d’AMF.

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.tryAnotherMethod();