MfaEmailChallenge

La classe MfaEmailChallenge implémente les fonctionnalités de l’écran mfa-email-challenge. Cet écran s’affiche lorsqu’un utilisateur doit vérifier son adresse courriel dans le cadre de l’AMF.

Constructeurs

Créez une instance du gestionnaire de l’écran de défi AMF par courriel :

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

Propriétés

BrandingMembers

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

ClientMembers

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

CountryCodesMembers

Fournit des données sur les codes de pays pour la saisie d’un numéro de téléphone, comme available et recommended, pour l’écran mfa-email-challenge.

ExperimentMembers

L’expérimentation Experiment Center active pour cet écran, ou null lorsqu’aucune expérimentation n’est active (ou que l’écran n’a pas été activé au moyen de context_configuration).

OrganizationMembers

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

PromptMembers

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

ScreenMembersOnMfaEmailChallenge

Contient des détails propres à l’écran mfa-email-challenge, notamment sa configuration et son contexte.

TenantMembers

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

TransactionMembers

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

UntrustedDataMembersOnMfaEmailChallenge

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

UserMembers

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 MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallenge = new MfaEmailChallenge();
mfaEmailChallenge.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

LanguageChangeOptions.

string

requis

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

"session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est enregistrée pendant toute la durée de la session.

Promise<void>

Cette méthode poursuit le défi par courriel à l’aide du code fourni.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

Paramètres de la méthode

Afficher Paramètres

ContinuePayloadOptions.

string

requis

Le code saisi par l’utilisateur.

boolean

Indique s’il faut mémoriser l’appareil.

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.

Promise<void>

Cette méthode soumet l’action permettant de choisir une autre configuration Email, si elle est offerte.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.pickEmail();

Promise<void>

Cette méthode renvoie le code par courriel.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.resendCode();

ResendControl

Cette méthode fournit une fonctionnalité de renvoi avec gestion du délai d’attente pour cet écran.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

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

// Appeler startResend lorsque l’utilisateur clique sur le bouton de renvoi
startResend();

Paramètres de la méthode

Afficher Paramètres

StartResendOptions.

number

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

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.

() => void

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

Promise<void>

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

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.tryAnotherMethod();

auth0-acul-js

auth0-acul-react

auth0-android

auth0-php

Constructeurs

Propriétés

Méthodes

​Constructeurs

​Propriétés

​Méthodes

Constructeurs

Propriétés

Méthodes