Classes d’écran de l’authentification multifacteur (MFA) par notification poussée

Classe d’écran Défi-réponse de la MFA par notification poussée

La classe d’écran Défi-réponse de la par notification poussée est affichée lorsqu’une notification poussée a été envoyée à l’appareil de l’utilisateur.

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

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';
const mfaPushChallengePush = new MfaPushChallengePush();

// SDK Properties return a string, number or boolean
mfaPushChallengePush.screen.name;

// SDK Methods return an object or array
await mfaPushChallengePush.continue();

Propriétés

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

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 | {
    deviceName: string;
    rememberDevice?: 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 notification poussée :

continue( options ?)

Cette méthode continue avec le défi-réponse par notification poussée.

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

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

enterCodeManually( options ?)

Cette méthode permet à l’utilisateur de saisir le code de vérification manuellement.

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.enterCodeManually();

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

resendnotification pousséeNotification( options ?)

Cette méthode renvoie la notification poussée.

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.resendPushNotification();

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

tryAnotherMethod( options ?)

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

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.tryAnotherMethod();

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

Classe d’écran Inscription code QR MFA par notification poussée

La classe d’écran Inscription code QR MFA par notification poussée met en œuvre l’écran de balayage du code QR.

Importez et instanciez la classe d’écran Inscription code QR MFA par notification poussée :

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();

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

// SDK Methods return an object or array
await mfaPushEnrollmentQr.pickAuthenticator();

Propriétés

Propriétés de la classe d’écran Inscription code QR MFA par notification poussée :

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 | { qr_code: string; qr_uri: string; show_code_copy: 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éthode de la classe d’écran Inscription code QR MFA par notification poussée :

pickAuthenticator( options ?)

Cette méthode renvoie l’utilisateur à l’écran de sélection d’authentifiant.

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

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

Classe d’écran Liste MFA par notification poussée

La classe d’écran Liste MFA par notification poussée met en œuvre la fonctionnalité d’écran mfa-push-list.

Importez et instanciez la classe d’écran Liste MFA par notification poussée :

import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';
const mfaPushList = new MfaPushList();

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

// SDK Methods return an object or array
await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 });

Propriétés

Propriétés de la classe d’écran Liste MFA par fication poussée :

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 | {enrolled_devices: string[];};
  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 Liste MFA par notification poussée :

goBack( options ?)

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

import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';

const mfaPushList = new MfaPushList();
await mfaPushList.goBack();

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

selectMfaPushDevice( options ?)

Cette méthode permet à l’utilisateur de sélectionner dans une liste un appareil enregistré pour initier la MFA par notification poussée.

import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';

const mfaPushList = new MfaPushList();
await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 });

Parameter	Type	Required	Description
`deviceIndex`	nombre	Oui	L’index de l’appareil à sélectionner dans la liste des appareils inscrits.
`[key: string]`	chaîne \| nombre \| booléen \| non défini	Non	Données facultatives collectées auprès de l’utilisateur.

Classe d’écran Bienvenue MFA par notification poussée

La classe d’écran Bienvenue MFA par notification poussée initialise l’écran MfaPushWelcome avec des données tirées du contexte de la connexion universelle.

Importez et instanciez la classe d’écran Bienvenue MFA par notification poussée :

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';
const mfaPushWelcome = new MfaPushWelcome();

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

// SDK Methods return an object or array
await mfaPushWelcome.enroll();

Propriétés

Propriétés de la classe d’écran Bienvenue MFA notification poussée :

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
      | string[]
      | PhonePrefix[]>;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  screen: {
    links: {
      android: string;
      ios: 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 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éthode de la classe d’écran Bienvenue MFA par notification poussée :

enroll( options ?)

Cette méthode envoie l’utilisateur à l’écran d’inscription.

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

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

pickAuthenticator( options ?)

Cette méthode renvoie l’utilisateur à l’écran de sélection d’authentifiant.

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.pickAuthenticator();

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

Personnalisation de la marque

Personnalisation du code

Personnalisation tierce

Classes d’écran de l’authentification multifacteur (MFA) par notification poussée

Classe d’écran Défi-réponse de la MFA par notification poussée

Propriétés

Méthodes

continue( options ?)

enterCodeManually( options ?)

resendnotification pousséeNotification( options ?)

tryAnotherMethod( options ?)

Classe d’écran Inscription code QR MFA par notification poussée

Propriétés

Méthodes

pickAuthenticator( options ?)

Classe d’écran Liste MFA par notification poussée

Propriétés

Méthodes

goBack( options ?)

selectMfaPushDevice( options ?)

Classe d’écran Bienvenue MFA par notification poussée

Propriétés

Méthodes

enroll( options ?)

pickAuthenticator( options ?)

Personnalisation de la marque

Personnalisation du code

Personnalisation tierce

Documentation Index

​Classe d’écran Défi-réponse de la MFA par notification poussée

​Propriétés

​Méthodes

​continue( options ?)

​enterCodeManually( options ?)

​resendnotification pousséeNotification( options ?)

​tryAnotherMethod( options ?)

​Classe d’écran Inscription code QR MFA par notification poussée

​Propriétés

​Méthodes

​pickAuthenticator( options ?)

​Classe d’écran Liste MFA par notification poussée

​Propriétés

​Méthodes

​goBack( options ?)

​selectMfaPushDevice( options ?)

​Classe d’écran Bienvenue MFA par notification poussée

​Propriétés

​Méthodes

​enroll( options ?)

​pickAuthenticator( options ?)

Classe d’écran Défi-réponse de la MFA par notification poussée

Propriétés

Méthodes

continue( options ?)

enterCodeManually( options ?)

resendnotification pousséeNotification( options ?)

tryAnotherMethod( options ?)

Classe d’écran Inscription code QR MFA par notification poussée

Propriétés

Méthodes

pickAuthenticator( options ?)

Classe d’écran Liste MFA par notification poussée

Propriétés

Méthodes

goBack( options ?)

selectMfaPushDevice( options ?)

Classe d’écran Bienvenue MFA par notification poussée

Propriétés

Méthodes

enroll( options ?)

pickAuthenticator( options ?)