EmailIdentifierChallenge

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

La classe EmailIdentifierChallenge implémente les fonctionnalités de l’écran email-identifier-challenge. Cet écran invite l’utilisateur à saisir un code de vérification envoyé à son adresse de 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 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, 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 l’invite active dans le flux d’authentification.

screen · ScreenMembersOnEmailIdentifierChallenge

Contient les détails propres à l’écran email-identifier-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 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"

Lorsque défini à 'session', la langue sélectionnée est conservée pendant toute 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 de courriel de l’utilisateur.

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 fonction 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 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 l’état du renvoi change; elle retourne le nombre de secondes restantes et indique si la fonction 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();

submitEmailChallenge · Promise<void>

Cette méthode soumet le code de vérification envoyé 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 de courriel de l’utilisateur.

captcha? · string

Le jeton de réponse CAPTCHA, si CAPTCHA est activé pour ce locataire.