LoginPasswordlessSmsOtp

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

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

BrandingMembers

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

ClientMembers

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

OrganizationMembers

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

PromptMembers

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

ScreenMembersOnLoginPasswordlessSmsOtp

Contient des détails propres à l’écran login-passwordless-sms-otp, y compris sa configuration et son contexte.

TenantMembers

Contient des données liées au locataire, comme id et les métadonnées associées.

TransactionMembersOnLoginPasswordlessSmsOtp

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

UntrustedDataMembers

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

UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

Méthodes

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

LanguageChangeOptions.

string

requis

Le code local correspondant à la langue souhaitée (par exemple, 'en', 'fr', 'es').

"session"

Lorsqu’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

"string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires précédés du préfixe ulp- (par exemple, 'ulp-custom-field').

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.

ResendControl

Cette méthode fournit une fonctionnalité de renvoi 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 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');
  }
});

// Call startResend when user clicks resend button
startResend();

Paramètres de la méthode

Afficher Paramètres

StartResendOptions.

number

La durée de la période d’attente, en secondes, avant que l’utilisateur puisse renvoyer le code.

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.

() => void

Fonction de rappel invoquée lorsque la période d’attente prend fin et que le renvoi redevient possible.

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

Paramètres de la méthode

Afficher Paramètres

CustomOptions.

"string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires précédés du préfixe ulp- (par exemple, 'ulp-custom-field').

Promise<void>

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

Exemple

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

SubmitOTPOptions.

string

requis

Le code saisi par l’utilisateur.

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 dans votre locataire Auth0.

string

L’identifiant de l’utilisateur.

"string" | "number" | "boolean" | "undefined"

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

Promise<void>

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

Exemple

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

SwitchConnectionOptionsSmsOtp.

string

requis

Le nom de la connexion vers laquelle basculer. Utilisez 'email' ou 'sms' pour Passwordless, ou le nom d’une connexion de base de données pour l’authentification par mot de passe.

"string" | "number" | "boolean"

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

​Constructeurs

​Propriétés

​Méthodes

Constructeurs

Propriétés

Méthodes