Classes d’écran authentification multifacteur (MFA) par courriel

Découvrez les classes d’écran ACUL authentification multifacteur (MFA) par courriel

​

Classe d’écran Défi-réponse de la MFA par courriel

La classe d’écran Défi-réponse de la MFA par courriel permet aux utilisateurs de vérifier leur adresse courriel à l’aise de la MFA.

Importez et instanciez la classe d’écran Défi-réponse de la MFA par courriel:

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallengeManager = new MfaEmailChallenge();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaDetectBrowserCapabilitiesManager.screen.name;

// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"} 
await mfaEmailChallenge.continue({
  code: '123456',
   rememberDevice: true
});

​

Propriétés

Propriétés de la classe d’écran Défi-réponse de la MFA par courriel :

image de marque

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​

Méthodes

Méthodes de la classe d’écran Défi-réponse de la MFA par courriel :

​

continue( options ?)

Cette méthode continue le défi-réponse par courriel à l’aide du code fourni.

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

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

Parameter	Type	Required	Description
code	chaîne	oui	Code saisi par l’utilisateur.
rememberDevice	booléen	Non	Mémoriser l’appareil de l’utilisateur.
[key: string]	chaîne | nombre | booléen | non défini	Non	Données facultatives collectées auprès de l’utilisateur.

​

pickEmail( options ?)

Cette méthode permet à l’utilisateur de sélectionner d’autres adresses courriel, le cas échéant.

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

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

Parameter	Type	Required	Description
[key: string]	string | number | boolean | undefined	No	Optional data collected to user.

​

resendCode( options ?)

Cette méthode renvoie le code courriel.

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

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

Parameter	Type	Required	Description
[key: string]	string | number | boolean | undefined	No	Optional data collected to user.

​

tryAnotherMethod( options ?)

Cette méthode permet à l’utilisateur de sélectionner une autre option de MFA.

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

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

Parameter	Type	Required	Description
[key: string]	string | number | boolean | undefined	No	Optional data collected to user.

​

Classe d’écran Liste d’adresses courriel MFA

La classe d’écran Liste d’adresses courriel MFA permet aux utilisateurs de sélectionner une adresse courriel inscrite à la MFA.

Importez et instanciez la classe d’écran Liste d’adresses courriel MFA :

import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';
const mfaEmailList = new MfaEmailList();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaEmailList.screen.name;

// SDK Methods return an object or array
await mfaEmailList.selectMfaEmail({
index: 0 // for demonstration we are selecting the first index
});

​

Propriétés

Propriétés de la classe d’écran Liste d’adresses courriel MFA :

image de marque

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​

Méthodes

Méthodes de la classe d’écran Liste d’adresses courriel MFA :

​

goBack( options ?)

Cette méthode permet à l’utilisateur d’aller à l’écran précédent.

import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.goBack();

Parameter	Type	Required	Description
[key: string]	string | number | boolean | undefined	No	Optional data collected to user.

​

selectMfaEmail( options ?)

Cette méthode permet à l’utilisateur d’effectuer une sélection dans la liste des adresses courriel inscrites.

import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.selectMfaEmail({
  index: 0 // for demonstration we are selecting the first index
});

Parameter	Type	Required	Description
index	nombre	Oui	L’index de l’adresse courriel à sélectionner.
[key: string]	chaîne | nombre | booléen | non défini	Non	Données facultatives collectées auprès de l’utilisateur.