ResetPasswordMfaSmsChallenge

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

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

​

Constructeurs

Créez une instance du gestionnaire de l’é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 de marque et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, 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 le prompt actuel du flux d’authentification.

screen · ScreenMembersOnResetPasswordMfaSmsChallenge

Contient des 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 tenant, 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

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant le processus de défi AMF.

user · UserMembers

Détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change 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ètre régional de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque défini sur 'session', la langue sélectionnée est conservée pendant toute la durée de la session.

continueMfaSmsChallenge · Promise<void>

Cette méthode soumet le code de vérification par SMS pour poursuivre le défi AMF pendant 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 par SMS saisi par l’utilisateur.

getACall · Promise<void>

Cette méthode fait passer l’utilisateur à la vérification par appel vocal plutôt que par 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 par 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 offre une fonctionnalité de renvoi avec gestion du délai d’attente. Elle retourne 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.

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.

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

Fonction de rappel invoquée lorsque la période d’attente prend fin et que le renvoi redevient possible.

tryAnotherMethod · Promise<void>

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

Example

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