MfaLoginOptions

Universal Login の mfa-login-options 画面をカスタマイズするために利用可能な、すべてのプロパティとメソッドについて説明します。

MfaLoginOptions クラスは、mfa-login-options 画面の機能を実装します。この画面では、ユーザーはログイン時に使用する MFA 認証要素を選択できます。

​

コンストラクター

MFAログインオプション画面マネージャーのインスタンスを作成します:

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

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

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、ブランディングに関する構成情報を提供します。

client · ClientMembers

mfa-login-options 画面向けに、id、name、logoUrl などのクライアント関連の構成情報を提供します。

organization · OrganizationMembers

ユーザーの組織に関する情報 (id や name など) を提供します。

prompt · PromptMembers

認証フローにおける現在のプロンプトに関するデータを含みます。

screen · ScreenMembersOnMfaLoginOptions

設定やコンテキストなど、mfa-login-options 画面に固有の詳細を含みます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関するデータを含みます。

transaction · TransactionMembers

アクティブな識別子やフローの状態など、mfa-login-options 画面に固有のトランザクションデータを提供します。

untrustedData · UntrustedDataMembers

MFA ログインオプションの選択時のユーザー入力など、SDK に渡される信頼されていないデータを扱います。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';
const mfaLoginOptions = new MfaLoginOptions();
mfaLoginOptions.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語がセッションの間保持されます。

enroll · Promise<void>

このメソッドは、選択したMFA認証要素でログインプロセスを続行します。

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

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

メソッドパラメーター

表示 パラメーター

options

LoginEnrollOptions。

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "email" | "recovery-code" | "webauthn-roaming" | "webauthn-platform" | "duo" · 必須

登録する認証要素を指定する値です。指定できるのは “push-notification”、“otp”、“sms”、“phone”、“voice”、“email”、“recovery-code”、“webauthn-roaming”、“webauthn-platform”、“duo” のいずれかです。

getErrors · Error []

このメソッドは、コンテキストからトランザクションのエラー配列を取得します。エラーが存在しない場合は空の配列を返します。

returnToPrevious · Promise<void>

このメソッドは、前の画面に戻ります。

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.returnToPrevious();