多要素認証メール画面クラス

ACULの多要素認証メール画面クラスについて説明します

​

MFAメールチャレンジ画面クラス

MFAメールチャレンジ画面クラスは、ユーザーがMFAを使用して自身のメールアドレスを確認できるようにします。

MFAメールチャレンジ画面クラスのインポートとインスタンス化

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

​

プロパティ

MFAメールチャレンジ画面クラスには以下のプロパティがあります。

branding

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

​

メソッド

MFAメールチャレンジ画面クラスには以下のメソッドがあります。

​

continue( options ?)

このメソッドは提供されたコードを使用してメールチャレンジを続行します。

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

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

パラメーター	タイプ	必須	説明
code	文字列	必須	ユーザーが入力したコードです。
rememberDevice	ブール値	任意	ユーザーのデバイスを記憶します。
[key: string]	文字列 | 数値 | ブール値 | undefined	任意	ユーザーから収集した任意のデータです。

​

pickEmail( options ?)

このメソッドはユーザーが利用可能な別のメールを選択できるようにします。

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

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

パラメーター	タイプ	必須	説明
[key: string]	文字列 | 数字 | ブール値 | undefined	任意	ユーザーから収集した任意のデータです。

​

resendCode( options ?)

このメソッドはメールコードを再度送信します。

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

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

パラメーター	タイプ	必須	説明
[key: string]	文字列 | 数字 | ブール値 | undefined	任意	ユーザーから収集した任意のデータです。

​

tryAnotherMethod( options ?)

このメソッドはユーザーが別のMFAオプションを選択できるようにします。

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

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

パラメーター	タイプ	必須	説明
[key: string]	文字列 | 数字 | ブール値 | undefined	任意	ユーザーから収集した任意のデータです。

​

MFAメールリスト画面クラス

MFAメールリスト画面クラスは、ユーザーがMFAに登録済みのメールアドレスを選択できるようにします。

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

​

プロパティ

MFAメールリスト画面クラスには以下のプロパティがあります。

branding

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

​

メソッド

MFAメールリスト画面クラスには以下のメソッドがあります。

​

goBack( options ?)

このメソッドはユーザーが前の画面に戻れるようにします。

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

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

パラメーター	タイプ	必須	説明
[key: string]	文字列 | 数字 | ブール値 | undefined	任意	ユーザーから収集した任意のデータです。

​

selectMfaEmail( options ?)

このメソッドは、ユーザーが登録済みのメールアドレスのリストから選択できるようにします。

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

パラメーター	タイプ	必須	説明
index	数値	必須	選択するメールアドレスのインデックスです。
[key: string]	文字列 | 数値 | ブール値 | undefined	任意	ユーザーから収集した任意のデータです。