LoginEmailVerification

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran login-email-verification d’Universal Login.

La classe LoginEmailVerification implémente les fonctionnalités de l’écran login-email-verification. Cet écran invite l’utilisateur à saisir un code à usage unique envoyé à son adresse de courriel afin de vérifier son identité pendant le processus de connexion.

​

Constructeurs

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

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

Fournit des configurations d’image de marque, comme le thème et les paramètres associés.

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran login-email-verification.

organization · OrganizationMembers

Fournit des renseignements sur l’Organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’invite en cours dans le flux d’authentification.

screen · ScreenMembers

Contient des détails propres à l’écran login-email-verification, 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 login-email-verification, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les données saisies par l’utilisateur pendant la connexion.

user · UserMembers

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

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change la langue d’affichage de la page Universal Login.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.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 à 'session', la langue sélectionnée est conservée pendant toute la session.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

continueWithCode · Promise<void>

Cette méthode soumet le code de vérification par courriel saisi par l’utilisateur.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

ContinueWithCodeOptionPayload.

code · string · requis

Le code de vérification envoyé au courriel de l’utilisateur.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

getErrors · Error []

Cette méthode récupère, à partir du contexte, le tableau des erreurs de la transaction, ou un tableau vide s’il n’y en a aucune. Elle renvoie un tableau d’objets d’erreur du contexte de la transaction.

resendCode · Promise<void>

Cette méthode demande qu’un nouveau code de vérification soit envoyé à l’adresse courriel de l’utilisateur.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.resendCode();

Paramètres de la méthode

Afficher Paramètres

options

CustomOptions.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

resendManager · ResendControl

Cette méthode permet de renvoyer le code avec gestion du délai d’attente. 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 LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';

const loginEmailVerificationManager = new LoginEmailVerification();
const { startResend } = loginEmailVerificationManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Appeler startResend lorsque l’utilisateur clique sur le bouton de renvoi
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 à nouveau.

onStatusChange? · OnStatusChangeCallback

Fonction de rappel invoquée chaque fois que l’état du renvoi change; elle renvoie 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.