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

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

screen · ScreenMembers

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

tenant · TenantMembers

id や関連するメタデータなど、tenant に関するデータを含みます。

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: '234567890', type: 'sms' });

メソッドのパラメータ

表示 パラメータ

options

MfaPhoneEnrollmentContinueOptions.

phone · string · 必須

ユーザーの電話番号。

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

確認コードの配信方法。

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