MfaVoiceEnrollment

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

MfaVoiceEnrollment クラスは、mfa-voice-enrollment 画面の機能を実装します。この画面は、登録を続行するための確認コードを音声通話で受け取るために、ユーザーが電話番号を入力する必要がある場合に表示されます。

​

コンストラクタ

MFA音声登録画面マネージャーのインスタンスを作成します:

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.continue({ phone: '[phone]' });

​

プロパティ

branding · BrandingMembers

ブランドテーマや各種設定など、ブランディングに関する設定を提供します。

client · ClientMembers

mfa-voice-enrollment 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

organization · OrganizationMembers

id や name など、ユーザーが属する Organization に関する情報を提供します。

prompt · PromptMembers

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

screen · ScreenMembers

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

tenant · TenantMembers

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

transaction · TransactionMembers

有効な識別子やフローの状態など、mfa-voice-enrollment 画面向けのトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
mfaVoiceEnrollment.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、指定した電話番号で音声登録プロセスを続行します。

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.continue({ phone: '[phone]' });

メソッドパラメーター

表示 パラメーター

options

MfaVoiceEnrollmentContinueOptions。

phone · string · 必須

音声通話を受けるユーザーの電話番号です。

getErrors · Error []

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

selectPhoneCountryCode · Promise<void>

このメソッドは、ユーザーが電話番号の国番号を選択する画面に移動します。

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.selectPhoneCountryCode();

tryAnotherMethod · Promise<void>

このメソッドは、ユーザーが別の MFA 方法を試せるようにします。

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';

const mfaVoiceEnrollment = new MfaVoiceEnrollment();
await mfaVoiceEnrollment.tryAnotherMethod();