ResetPasswordMfaSmsChallenge

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

La classe ResetPasswordMfaSmsChallenge implémente les fonctionnalités de l’écran reset-password-mfa-sms-challenge. Cet écran invite l’utilisateur à saisir le code de vérification envoyé à son téléphone par SMS dans le cadre de l’étape MFA d’un flux de réinitialisation du mot de passe.

​

Constructeurs

Créez une instance du gestionnaire d’écran ResetPasswordMfaSmsChallenge :

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.continueMfaSmsChallenge({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

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

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

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les entrées utilisateur pendant le flux de défi 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 ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
resetPasswordMfaSmsChallengeManager.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"

Lorsque cette option est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

continueMfaSmsChallenge · Promise<void>

Cette méthode soumet le code de vérification SMS pour poursuivre le défi MFA dans le flux de réinitialisation du mot de passe.

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.continueMfaSmsChallenge({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaSmsChallengeOptions.

code · string · requis

Le code de vérification SMS saisi par l’utilisateur.

getACall · Promise<void>

Cette méthode bascule l’utilisateur vers la vérification par appel vocal au lieu du SMS.

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.getACall();

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 SMS au téléphone de l’utilisateur.

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.resendCode();

resendManager · ResendControl

Cette méthode fournit une fonctionnalité de renvoi avec gestion du délai d’expiration. Elle renvoie un objet ResendControl doté d’une méthode startResend() qui déclenche le renvoi et impose une période d’attente avant que l’utilisateur puisse renvoyer le code à nouveau.

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
const { startResend } = resetPasswordMfaSmsChallengeManager.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

Durée de la période d’attente, en secondes, avant que l’utilisateur puisse renvoyer le code à nouveau.

onStatusChange? · OnStatusChangeCallback

Callback invoqué chaque fois que le statut du renvoi change; il renvoie le nombre de secondes restantes et indique si la fonctionnalité de renvoi est actuellement désactivée.

onTimeout? · () => void

Callback invoqué lorsque la période d’attente expire et que le renvoi redevient disponible.

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de sélectionner une autre méthode MFA pour effectuer le défi.

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.tryAnotherMethod();