MfaSmsChallenge

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

La classe MfaSmsChallenge implémente les fonctionnalités de l’écran mfa-sms-challenge. Cet écran s’affiche lorsque l’utilisateur doit saisir un code SMS pour vérifier son identité.

​

Constructeurs

Créez une instance du gestionnaire d’écran MFA SMS Challenge :

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaSmsChallenge

Contient des détails propres à l’écran mfa-sms-challenge, notamment 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 mfa-sms-challenge, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembersOnMfaSmsChallenge

Gère les données non fiables transmises au SDK, comme les entrées utilisateur pendant le défi SMS d’AMF.

user · UserMembers

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

​

Méthodes

changeLanguage · Promise<void>

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

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
mfaSmsChallenge.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 reste enregistrée pendant toute la session.

continueMfaSmsChallenge · Promise<void>

Cette méthode soumet le défi SMS d’AMF avec le code fourni.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

Paramètres de la méthode

Afficher Paramètres

options

MfaSmsChallengeOptions.

code · string · requis

Le code SMS saisi par l’utilisateur.

rememberDevice? · boolean

Lorsqu’elle est définie à true, cette option enregistre cet appareil comme fiable afin que l’utilisateur ne soit pas invité à utiliser l’AMF lors des connexions ultérieures à partir du même appareil.

getACall · Promise<void>

Cette méthode fait passer la méthode de vérification à un appel vocal.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.getACall();

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.

pickSms · Promise<void>

Cette méthode amène l’utilisateur à l’écran où il peut choisir un autre numéro pour les SMS.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.pickSms();

resendCode · Promise<void>

Cette méthode renvoie le code de vérification SMS à l’utilisateur.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.resendCode();

resendManager · ResendControl

Cette méthode offre une fonction de renvoi avec un délai d’expiration configurable et une gestion du statut.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
const { startResend } = mfaSmsChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  },
});

startResend();

Paramètres de la méthode

Afficher Paramètres

options

StartResendOptions.

onStatusChange? · OnStatusChangeCallback

Fonction de rappel appelée chaque fois que le statut du renvoi change; elle reçoit le nombre de secondes restantes ainsi qu’une indication précisant si le renvoi est actuellement désactivé.

onTimeout? · () => void

Fonction de rappel appelée lorsque le délai d’expiration du renvoi prend fin et que l’option de renvoi redevient disponible.

timeoutSeconds? · number

Le nombre de secondes à attendre avant que l’option de renvoi redevienne disponible.

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur d’essayer une autre méthode d’AMF.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.tryAnotherMethod();