EmailIdentifierChallenge

Décrit toutes les propriétés et méthodes permettant de personnaliser l’écran email-identifier-challenge de Universal Login.

La classe EmailIdentifierChallenge implémente la fonctionnalité de l’écran email-identifier-challenge. Cet écran invite l’utilisateur à saisir un code de vérification envoyé à son adresse courriel afin de confirmer son identité.

​

Constructeurs

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

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' });

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit les configurations liées au client, comme id, name et logoUrl, pour l’écran email-identifier-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 · ScreenMembersOnEmailIdentifierChallenge

Contient des détails propres à l’écran email-identifier-challenge, notamment 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 email-identifier-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 flux de vérification par courriel.

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 EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
emailIdentifierChallengeManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue souhaité (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est enregistrée pour toute la durée de la session.

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.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.resendCode();

resendManager · ResendControl

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

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
const { startResend } = emailIdentifierChallengeManager.resendManager({
  timeoutSeconds: 15,
});
await startResend();

Paramètres de la méthode

Afficher Paramètres

options

StartResendOptions.

timeoutSeconds? · number

La 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 le statut 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.

returnToPrevious · Promise<void>

Cette méthode ramène l’utilisateur à l’écran précédent.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.returnToPrevious();

switchToPassword · Promise<void>

Cette méthode fait passer le flux d’authentification de la vérification par OTP par courriel à l’authentification par mot de passe.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.switchToPassword();

submitEmailChallenge · Promise<void>

Cette méthode soumet le code de vérification par courriel pour terminer la vérification.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' });

Paramètres de la méthode

Afficher Paramètres

options

EmailChallengeOptions.

code · string · requis

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

captcha? · string

Le token de réponse CAPTCHA, si CAPTCHA est activé pour ce tenant.