ResetPasswordMfaEmailChallenge

Décrit toutes les propriétés et méthodes offertes pour personnaliser l’écran reset-password-mfa-email-challenge dans Universal Login.

La classe ResetPasswordMfaEmailChallenge implémente la fonctionnalité de l’écran reset-password-mfa-email-challenge. Cet écran invite l’utilisateur à saisir le code de vérification envoyé à son adresse courriel dans le cadre de l’étape MFA d’un flux de réinitialisation du mot de passe.

​

Constructeurs

Créez une instance du gestionnaire de l’écran ResetPasswordMfaEmailChallenge :

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.continue({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et ses paramètres.

client · ClientMembers

Fournit des configurations liées à l’application, telles que id, name et logoUrl, pour l’écran reset-password-mfa-email-challenge.

organization · OrganizationMembers

Fournit des informations 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 · ScreenMembersOnResetPasswordMfaEmailChallenge

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

untrustedData · UntrustedDataMembers

Contient les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant le flux de défi 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 ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
resetPasswordMfaEmailChallengeManager.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’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 envoyé par courriel afin de poursuivre le défi MFA pendant le processus de réinitialisation du mot de passe.

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.continue({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

ContinueOptions.

code · string · requis

Le code de vérification envoyé à l’adresse courriel de l’utilisateur.

rememberDevice? · boolean

Indique s’il faut mémoriser l’appareil pour les prochains défis MFA.

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.

resendCode · Promise<void>

Cette méthode renvoie le code de vérification à l’adresse courriel de l’utilisateur.

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.resendCode();

resendManager · ResendControl

Cette méthode fournit une fonctionnalité de renvoi avec gestion du délai d’attente pour l’écran reset-password-mfa-email-challenge.

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
const { startResend } = resetPasswordMfaEmailChallengeManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Appelez startResend lorsque l’utilisateur clique sur le bouton de renvoi
startResend();

Paramètres de la méthode

Afficher Paramètres

options

StartResendOptions.

timeoutSeconds? · number

Le nombre de secondes à attendre avant d’autoriser l’utilisateur à renvoyer le code.

onStatusChange? · OnStatusChangeCallback

Fonction de rappel invoquée chaque fois que l’état du renvoi change; elle renvoie le nombre de secondes restantes et indique si la fonctionnalité de renvoi est actuellement désactivée.

onTimeout? · void

Fonction de rappel déclenchée lorsque le délai d’attente expire et que le bouton de renvoi devient disponible.

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de choisir une autre méthode MFA pour compléter le défi.

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.tryAnotherMethod();