MfaBeginEnrollOptions

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

MfaBeginEnrollOptions クラスは、mfa-begin-enroll-options 画面の機能を実装します。この画面では、MFA 認証要素の選択と登録を行います。

​

コンストラクター

MFA Begin Enroll Options 画面マネージャーのインスタンスを作成します:

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.enroll({
  action: 'push-notification'
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

認証フロー内の現在のプロンプトに関するデータが含まれます。

screen · ScreenMembers

構成やコンテキストを含む、mfa-begin-enroll-options 画面固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA 登録時のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
mfaBeginEnrollOptions.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語はセッション中維持されます。

enroll · Promise<void>

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

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';

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

メソッドパラメーター

表示 パラメーター

options

MfaEnrollOptions。

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "webauthn-roaming" · 必須

登録する認証要素を示すアクションです。指定できる値は “push-notification”、“otp”、“sms”、“phone”、“voice”、“webauthn-roaming” のいずれかです。

getErrors · Error []

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