MfaSmsList

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-sms-list dans Universal Login.

La classe MfaSmsList implémente la fonctionnalité de l’écran mfa-sms-list. Cet écran s’affiche lorsque l’utilisateur doit sélectionner un numéro de téléphone déjà inscrit pour la MFA par SMS.

​

Constructeurs

Créez une instance du gestionnaire de l’écran de liste des SMS MFA :

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.selectPhoneNumber({ index: 0 });

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

Contient des détails propres à l’écran mfa-sms-list, 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 · TransactionMembers

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

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme la saisie de l’utilisateur lors de la sélection dans la liste MFA par SMS.

user · UserMembers

Détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

backAction · Promise<void>

Cette méthode permet de revenir à l’écran précédent.

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.backAction();

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
mfaSmsList.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"

Lorsqu’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute 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.

selectPhoneNumber · Promise<void>

Cette méthode sélectionne un numéro de téléphone dans la liste des numéros de téléphone déjà inscrits.

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.selectPhoneNumber({ index: 0 });

Paramètres de la méthode

Afficher Paramètres

options

MfaSmsListOptions.

index · number · requis

L’index du numéro de téléphone à sélectionner.