ResetPasswordMfaPhoneChallenge

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

La classe ResetPasswordMfaPhoneChallenge implémente les fonctionnalités de l’écran reset-password-mfa-phone-challenge. Cet écran permet à l’utilisateur de demander un code de vérification par SMS ou par appel vocal dans le cadre de l’AMF lors du flux de réinitialisation du mot de passe.

​

Constructeurs

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

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
await resetPasswordMfaPhoneChallengeManager.continue({
  type: 'sms',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran reset-password-mfa-phone-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 dans le flux d’authentification.

screen · ScreenMembersOnResetPasswordMfaPhoneChallenge

Contient des détails propres à l’écran reset-password-mfa-phone-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-phone-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 de l’utilisateur pendant le flux de demande de vérification AMF.

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 ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
resetPasswordMfaPhoneChallengeManager.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 envoie un code de vérification au téléphone de l’utilisateur selon le mode d’envoi sélectionné afin de poursuivre le défi d’AMF pendant le flux de réinitialisation du mot de passe.

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
await resetPasswordMfaPhoneChallengeManager.continue({
  type: 'sms',
});

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaPhoneChallengeContinueOptions.

type · "sms" | "voice" · requis

Le mode d’envoi du code de vérification. Utilisez sms pour l’envoyer par message texte ou voice pour l’envoyer par appel vocal.

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 permet à l’utilisateur de sélectionner une autre méthode d’AMF pour terminer le défi.

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
await resetPasswordMfaPhoneChallengeManager.tryAnotherMethod({
  type: 'sms',
});

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.

type? · "sms" | "voice"

Le mode d’envoi affiché à l’écran actuel. Il est requis par l’API pour traiter correctement le changement de méthode.