LoginPasswordlessSmsOtp

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

La classe LoginPasswordlessSmsOtp implémente les fonctionnalités de l’écran login-passwordless-sms-otp. Cet écran permet de saisir le numéro de téléphone de l’utilisateur et le code.

​

Constructeurs

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.submitOTP({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnLoginPasswordlessSmsOtp

Contient des détails propres à l’écran login-passwordless-sms-otp, 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 · TransactionMembersOnLoginPasswordlessSmsOtp

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

Contient les 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 LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.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 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’en existe aucune. Elle renvoie un tableau d’objets d’erreur provenant du contexte de transaction.

resendManager · ResendControl

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';

const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
const { startResend } = loginPasswordlessSmsOtpManager.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

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 disponible.

resendOTP · Promise<void>

Cette méthode renvoie le code au numéro de téléphone de l’utilisateur.

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.resendOTP();

submitOTP · Promise<void>

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.submitOTP({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

SubmitOTPOptions.

code · string · 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 Bot Detection est activé dans votre tenant Auth0.

username? · string

L’identifiant de l’utilisateur.

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 (Email/SMS OTP).

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.switchConnection({
  connection: 'sms',
});

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsSmsOtp.

connection · string · requis

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