PhoneIdentifierChallenge

Décrit toutes les propriétés et méthodes permettant de personnaliser l’écran phone-identifier-challenge d’Universal Login.

La classe PhoneIdentifierChallenge implémente la fonctionnalité de l’écran phone-identifier-challenge. Cet écran invite l’utilisateur à saisir un code de vérification envoyé à son numéro de téléphone afin de confirmer son identité.

​

Constructeurs

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

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.submitPhoneChallenge({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran phone-identifier-challenge.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnPhoneIdentifierChallenge

Contient les détails propres à l’écran phone-identifier-challenge, 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 · TransactionMembers

Fournit des données propres à la transaction pour l’écran phone-identifier-challenge, 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 pendant le flux de vérification par téléphone.

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 PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
phoneIdentifierChallengeManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de locale de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à '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.

resendCode · Promise<void>

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

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.resendCode();

resendManager · ResendControl

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

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
const { startResend } = phoneIdentifierChallengeManager.resendManager({
  timeoutSeconds: 30,
});
await 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 prend fin et que le renvoi redevient possible.

returnToPrevious · Promise<void>

Cette méthode ramène l’utilisateur à l’écran précédent.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.returnToPrevious();

submitPhoneChallenge · Promise<void>

Cette méthode soumet le code de vérification téléphonique pour terminer la vérification.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.submitPhoneChallenge({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

PhoneChallengeOptions.

code · string · requis

Le code de vérification envoyé au numéro de téléphone de l’utilisateur.

captcha? · string

Le jeton de réponse CAPTCHA, si CAPTCHA est activé pour ce tenant.

switchToText · Promise<void>

Cette méthode fait passer le mode de livraison du code de vérification à un message texte SMS.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToText();

switchToVoice · Promise<void>

Cette méthode fait passer le mode de livraison du code de vérification à un appel vocal.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToVoice();

switchToPassword · Promise<void>

Cette méthode fait passer le flux d’authentification de la vérification par OTP téléphonique à l’authentification par mot de passe.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToPassword();