MfaCountryCodes

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-country-codes d’Universal Login.

La classe MfaCountryCodes implémente la fonctionnalité de l’écran mfa-country-codes. Cet écran permet aux utilisateurs de sélectionner un code du pays pour la vérification du numéro de téléphone pour la MFA.

​

Constructeurs

Créez une instance du gestionnaire de l’écran des codes de pays MFA :

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';

const mfaCountryCodes = new MfaCountryCodes();
await mfaCountryCodes.selectCountryCode({
  country_code: 'US',
  phone_prefix: '+1',
});

​

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-country-codes.

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 · ScreenMembersOnMfaCountryCodes

Contient des détails propres à l’écran mfa-country-codes, 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-country-codes, 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 sélection de l’indicatif de pays MFA.

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 MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';
const mfaCountryCodes = new MfaCountryCodes();
mfaCountryCodes.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue souhaité (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 la transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune.

goBack · Promise<void>

Cette méthode retourne à l’écran précédent.

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';
const mfaCountryCodes = new MfaCountryCodes();
await mfaCountryCodes.goBack();

selectCountryCode · Promise<void>

Cette méthode sélectionne un code du pays parmi les options disponibles.

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';

const mfaCountryCodes = new MfaCountryCodes();
await mfaCountryCodes.selectCountryCode({
  country_code: 'US',
  phone_prefix: '+1',
});

Paramètres de la méthode

Afficher Paramètres

options

SelectCountryCodeOptions.

country_code · string · requis

Le code du pays (par exemple, 'US', 'GB').

phone_prefix · string · requis

L’indicatif téléphonique (par exemple, '+1', '+44').