MfaPushChallengePush

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

MfaPushChallengePush クラスは、mfa-push-challenge-push 画面の機能を実装します。この画面は、MFA 中にユーザーがプッシュ通知を確認する必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaPushChallengePush

構成やコンテキストなど、mfa-push-challenge-push 画面に固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembersOnMfaPushChallengePush

MFA プッシュチャレンジ中のユーザー入力など、SDK に渡される信頼されていないデータを扱います。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細が含まれます。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';
const mfaPushChallengePush = new MfaPushChallengePush();
mfaPushChallengePush.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、プッシュ通知チャレンジを続行します。

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

メソッドパラメーター

表示 パラメーター

options

WithRememberOptions。

rememberDevice? · boolean

デバイスを記憶するかどうかを指定します。

enterCodeManually · Promise<void>

このメソッドは、確認コードを手動で入力する画面に切り替えます。

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.enterCodeManually();

getErrors · Error []

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

pollingManager · MfaPushPollingControl

このメソッドは、MFA プッシュチャレンジのポーリングを開始し、管理します。

指定した間隔で MFA プッシュチャレンジのエンドポイントを繰り返し確認するポーリングセッションを作成し、チャレンジが承認されるかエラーが発生するまで継続します。承認条件が満たされると、指定した onCompleted コールバックが呼び出され、ポーリングは自動的に停止します。

返される MfaPushPollingControl を使用すると、ポーリング処理の開始、停止、状態確認をいつでも行えます。

以下を提供する MfaPushPollingControl インスタンスを返します。

• startPolling() — ポーリングを開始または再開します。
• stopPolling() — ポーリングを直ちに停止します。
• isRunning() — ポーリングが現在実行中かどうかを示します。

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();

// プッシュチャレンジが承認されるまで 5 秒ごとにポーリングを開始
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.continue(),
  onError: (error) => console.error('Polling error:', error),
});

// 必要に応じて後でポーリングを停止
control.stopPolling();

備考

• HTTP 429 (レート制限) レスポンスは内部で処理されます。ポーリングは、レート制限がリセットされるまで自動的に待機してから再試行します。
• startPolling() は複数回呼び出しても安全です。すでに実行中の場合は効果がありません。

メソッドパラメーター

表示 パラメーター

options

MfaPollingOptions.

intervalMs? · number

連続するポーリングリクエストの間隔 (ミリ秒) を指定する任意の値です。省略した場合は、SDK の内部デフォルト間隔 (通常は 5000 ms) が使用されます。

onCompleted()? · () => void

MFA プッシュチャレンジが正常に承認されてポーリングが完了したときに実行される任意のコールバックです。呼び出されるのは 1 回のみで、その後ポーリングは自動的に停止します。

onError()? · (error) => void

ポーリング中にエラーが発生した場合に呼び出される任意のコールバックです。status (HTTP ステータスコード) と responseText (生のレスポンス本文) を含む ULError オブジェクトを受け取ります。

resendPushNotification · Promise<void>

このメソッドは、プッシュ通知を再送信します。

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.resendPushNotification();

メソッドパラメーター

表示 パラメーター

options

WithRememberOptions.

rememberDevice? · boolean

このデバイスを記憶するかどうかを示します。

tryAnotherMethod · Promise<void>

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

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.tryAnotherMethod();