LoginPasswordlessEmailCode

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

La classe LoginPasswordlessEmailCode implémente la fonctionnalité de l’écran login-passwordless-email-code. Cet écran recueille l’adresse courriel de l’utilisateur et le code.

​

Constructeurs

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

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.submitCode({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran login-passwordless-email-code.

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 · ScreenMembersOnLoginPasswordlessEmailCode

Contient des détails propres à l’écran login-passwordless-email-code, 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 · TransactionMembersOnLoginPasswordlessEmailCode

Fournit des données propres à la transaction pour l’écran login-passwordless-email-code, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Contient les données non fiables transmises au SDK, comme la saisie de l’utilisateur lors de la connexion.

user · UserMembers

Informations sur 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 LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.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 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. Elle retourne un tableau d’objets d’erreur provenant du contexte de transaction.

resendCode · Promise<void>

Cette méthode renvoie le code à l’adresse courriel de l’utilisateur.

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.resendCode();

resendManager · ResendControl

Cette méthode offre une fonctionnalité de renvoi avec gestion du délai d’expiration. 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 de nouveau.

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';

const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
const { startResend } = loginPasswordlessEmailCodeManager.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 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 expire et que le renvoi redevient possible.

submitCode · Promise<void>

Cette méthode poursuit le processus de connexion à l’aide du code envoyé par courriel.

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.submitCode({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

SubmitCodeOptions.

code · string | number · requis

Le code entré par l’utilisateur.

captcha? · string

Le code CAPTCHA ou la réponse fournie par le fournisseur CAPTCHA. Cette propriété est requise si la fonctionnalité Bot Detection est activée dans votre tenant Auth0.

switchConnection · Promise<void>

Cette méthode permet de basculer entre une connexion de base de données (mot de passe) et une connexion sans mot de passe (courriel/SMS OTP).

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.switchConnection({
  connection: 'email',
});

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsEmailCode.

connection · string · requis

Le nom de la connexion vers laquelle basculer. Utilisez 'email' ou 'sms' pour une connexion sans mot de passe, ou un nom de connexion DB pour l’authentification par mot de passe.