MfaPhoneEnrollment

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

MfaPhoneEnrollment クラスは、mfa-phone-enrollment 画面の機能を実装します。この画面では、ユーザーは電話番号を使って MFA に登録できます。

​

コンストラクター

MFA電話番号登録画面マネージャーのインスタンスを作成します：

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '[phone]', type: 'sms' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

設定やコンテキストなど、mfa-phone-enrollment 画面固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

username、email、roles など、現在のユーザーの詳細が含まれます。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollment = new MfaPhoneEnrollment();
mfaPhoneEnrollment.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continueEnrollment · Promise<void>

このメソッドは、指定された電話番号と種別 (SMS または音声) で登録プロセスを続行します。

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '[phone]', type: 'sms' });

メソッドパラメーター

表示 パラメーター

options

MfaPhoneEnrollmentContinueOptions。

phone · string · 必須

ユーザーの電話番号。

type · "sms" | "voice" · 必須

検証用 code の送信方法。

getErrors · Error []

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

pickCountryCode · Promise<void>

このメソッドは、国番号の選択画面に移動します。

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.pickCountryCode();

tryAnotherMethod · Promise<void>

このメソッドを使用すると、ユーザーは別の MFA 方法を試すことができます。

Example

import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.tryAnotherMethod();