Classes d’écran 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 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 :

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>;
  };
}

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | {
    email: string;
    remember_device?: boolean;
  };
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

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 :

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>;
  };
}

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | Record<string,
      | string
      | boolean
      | PasskeyCreate
      | string[]
      | PhonePrefix[]>
      | Record<string, string[]>>;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface PhonePrefix {
  country: string;
  country_code: string;
  phone_prefix: string;
}

interface PasskeyCreate {
    public_key: {
        authenticatorSelection: {
            residentKey: string;
            userVerification: string;
        };
        challenge: string;
        pubKeyCredParams: [{ alg: number; type: string }];
        rp: { id: string; name: string };
        user: { displayName: string; id: string; name: string };
    };
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

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.

Personnalisation de la marque

Personnalisation du code

Personnalisation tierce

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

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

Propriétés

Méthodes

continue( options ?)

pickEmail( options ?)

resendCode( options ?)

tryAnotherMethod( options ?)

Classe d’écran Liste d’adresses courriel MFA

Propriétés

Méthodes

goBack( options ?)

selectMfaEmail( options ?)

Personnalisation de la marque

Personnalisation du code

Personnalisation tierce

Documentation Index

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

​Propriétés

​Méthodes

​continue( options ?)

​pickEmail( options ?)

​resendCode( options ?)

​tryAnotherMethod( options ?)

​Classe d’écran Liste d’adresses courriel MFA

​Propriétés

​Méthodes

​goBack( options ?)

​selectMfaEmail( options ?)

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

Propriétés

Méthodes

continue( options ?)

pickEmail( options ?)

resendCode( options ?)

tryAnotherMethod( options ?)

Classe d’écran Liste d’adresses courriel MFA

Propriétés

Méthodes

goBack( options ?)

selectMfaEmail( options ?)