MfaVoiceChallenge

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

MfaVoiceChallenge クラスは、mfa-voice-challenge 画面の機能を実装します。この画面は、ユーザーが本人確認のために音声通話で受信したコードを入力する必要がある場合に表示されます。

​

コンストラクター

MFA Voice Challenge画面マネージャーのインスタンスを作成します。

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.continue({ code: '123456' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

mfa-voice-challenge 画面の id、name、logoUrl など、クライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaVoiceChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembersOnMfaVoiceChallenge

MFA 音声チャレンジ中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、音声通話で受信した確認コードを送信して、MFA チャレンジを検証します。

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.continue({
  code: '123456',
  rememberDevice: true,
});

メソッドパラメーター

表示 パラメーター

options

MfaVoiceChallengeContinueOptions。

code · string · 必須

音声通話で受信した確認コードです。

rememberDevice? · boolean

true の場合、以後の MFA チャレンジに備えてブラウザーを記憶します。screen.showRememberDevice が true の場合にのみ適用されます。

getErrors · Error []

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

pickPhone · Promise<void>

このメソッドは、別の電話番号を選択できる画面に移動します。

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.pickPhone();

resendCode · Promise<void>

このメソッドは、確認コードを含む新しい音声通話をリクエストします。

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.resendCode();

resendManager · ResendControl

このメソッドは、タイムアウトやステータス管理を設定可能な再送機能を提供します。

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
const { startResend } = mfaVoiceChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  },
});

startResend();

メソッドパラメーター

表示 パラメーター

options

StartResendOptions。

onStatusChange? · OnStatusChangeCallback

再送ステータスが変化するたびに呼び出されるコールバックです。残り秒数と、現在再送が無効かどうかを受け取ります。

onTimeout? · () => void

再送のタイムアウトが満了し、再送オプションが利用可能になったときに呼び出されるコールバックです。

timeoutSeconds? · number

再送オプションが利用可能になるまでの秒数です。

switchToSms · Promise<void>

このメソッドは、認証方法を SMS に切り替えます。

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.switchToSms();

tryAnotherMethod · Promise<void>

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

Example

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';

const mfaVoiceChallenge = new MfaVoiceChallenge();
await mfaVoiceChallenge.tryAnotherMethod();