LoginPasswordlessEmailCode

Décrit toutes les propriétés et méthodes offertes 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 le courriel et le code de l’utilisateur.

​

Constructeurs

Créez une instance du gestionnaire de l’é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 associés.

client · ClientMembers

Fournit des configurations liées à l’application, 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 l’invite en cours 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 locataire, 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

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur lors de la connexion.

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 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 paramètres régionaux de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque cette valeur 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').

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 renvoie 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();

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 fournit une fonctionnalité de renvoi avec gestion du délai d’expiration. 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 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');
  }
});

// Appelez 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.

onStatusChange? · OnStatusChangeCallback

Callback invoqué chaque fois que le statut du renvoi change; il renvoie le nombre de secondes restantes et indique si la fonctionnalité de renvoi est actuellement désactivée.

onTimeout? · () => void

Callback invoqué lorsque la période d’attente prend fin et que le renvoi redevient possible.

submitCode · Promise<void>

Cette méthode poursuit le processus de connexion à l’aide du code reçu 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 saisi par l’utilisateur.

captcha? · string

Le code captcha ou la réponse du fournisseur de CAPTCHA. Cette propriété est requise si la détection des bots est activée pour votre locataire Auth0.

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

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

switchConnection · Promise<void>

Cette méthode permet de passer d’une connexion de base de données (mot de passe) à une connexion Passwordless (OTP par courriel/SMS), et inversement.

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 Passwordless, ou un nom de connexion de base de données pour l’authentification par mot de passe.

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

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