多要素認証画面クラス

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

​

MFA登録開始オプション画面クラス

MFA登録開始オプション画面クラスはMFA要素の選択と登録を処理します。

MFA登録開始オプション画面クラスのインポートとインスタンス化

import MfaBeginEnrollOptions from "@auth0/auth0-acul-js/mfa-begin-enroll-options";
const mfaBeginEnrollOptionsManager = new MfaBeginEnrollOptions();

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

// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"} 
mfaBeginEnrollOptionsManager.enroll();

​

プロパティ

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登録開始オプション画面クラスには以下のメソッドがあります。

​

enroll( options ?)

このメソッドは選択されたMFAオプションで登録の処理を続行します。

const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.enroll({
  action: 'push-notification'
});

パラメーター	タイプ	必須	説明
action	FactorType: | push-notification | otp | sms | phone | voice | webauth-roaming	必須	選択された多要素認証のオプションです。
[key: string]	文字列 | 数値 | ブール値 | undefined	任意	ユーザーから収集した追加のデータです。

​

MFAブラウザー機能検出画面クラス

MFAブラウザー機能検出画面クラスは、MFA認証方法に対するブラウザーの機能性を検出します。

MFAブラウザー機能検出画面クラスのインポートとインスタンス化

import MfaDetectBrowserCapabilities from "@auth0/auth0-acul-js/mfa-detect-browser-capabilities";

const mfaDetectBrowserCapabilitiesManager = new MfaDetectBrowserCapabilities();

// 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"} 
mfaDetectBrowserCapabilitiesManager.detectCapabilities();

​

プロパティ

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ブラウザー機能検出画面クラスには以下のメソッドがあります。

​

detectCapabilities( options ?)

このメソッドはブラウザーの機能性に基づいてAuthenticatorを選択できるようにします。

const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities();
await mfaDetectBrowserCapabilities.detectCapabilities();

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

​

MFA登録結果画面クラス

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

MFA登録結果画面クラスのインポートとインスタンス化

import MfaEnrollResult from '@auth0/auth0-acul-js/mfa-enroll-result';
const mfaEnrollResult = new MfaEnrollResult();

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

​

プロパティ

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ログインオプション画面クラス

MFAログインオプション画面クラスは、ユーザーがログインに使用するMFA要素を選択できるようにします。

MFAログインオプション画面クラスのインポートとインスタンス化

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';
const mfaLoginOptions = new MfaLoginOptions();

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

// SDK Methods return an object or array
await mfaLoginOptions.enroll({
  action: 'push-notification'
});

​

プロパティ

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ログインオプション画面クラスには以下のメソッドがあります。

​

enroll( options ?)

このメソッドは選択されたMFAオプションでログインの処理を続行します。

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.enroll({
  action: 'push-notification'
});

パラメーター	タイプ	必須	説明
action	LoginFactorType: | push-notification | otp | sms | phone | voice | email | recovery-code | webauthn-platform | webauth-roaming | duo	必須	ログインに選択された多要素認証のオプションです。
[key: string]	文字列 | 数値 | ブール値 | undefined	任意	ユーザーから収集した追加のデータです。