ResetPasswordMfaPushChallengePush

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

ResetPasswordMfaPushChallengePush クラスは、reset-password-mfa-push-challenge-push 画面の機能を提供します。この画面は、パスワードリセットフロー中の MFA ステップの一部として、ユーザーのデバイスにプッシュ通知が送信された際に表示されます。

​

コンストラクター

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

Example

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePushManager.continue();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

reset-password-mfa-push-challenge-push 画面に対して、id、name、logoUrl などのクライアント関連の設定を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordMfaPushChallengePush

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

tenant · TenantMembers

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

transaction · TransactionMembers

reset-password-mfa-push-challenge-push 画面に対して、有効な識別子やフローの状態などの transaction 固有のデータを提供します。

untrustedData · UntrustedDataMembers

MFA challenge フロー中のユーザー入力など、SDK に渡される信頼されていないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

'session' に設定すると、選択した言語は session の間保持されます。

continue · Promise<void>

このメソッドは、パスワードリセットフロー中の MFA ステップを続行するために、プッシュ通知チャレンジを承認します。

Example

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePushManager.continue();

enterCodeManually · Promise<void>

このメソッドは、プッシュ通知の承認を待つ代わりに、手動でコードを入力する画面に切り替えます。

Example

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePushManager.enterCodeManually();

getErrors · Error []

このメソッドは、context から transaction エラーの配列を取得します。存在しない場合は空の配列を返します。

pollingManager · MfaPushPollingControl

このメソッドは、MFA プッシュチャレンジの polling を開始し、管理します。指定した間隔でプッシュ通知が承認されたかどうかを繰り返し確認し、承認が検出されると onCompleted コールバックを呼び出します。HTTP 429 の rate limit レスポンスは内部的に処理され、polling は rate limit がリセットされるまで待機してから再試行します。

返される MfaPushPollingControl では、polling のライフサイクルを管理するために startPolling()、stopPolling()、isRunning() を利用できます。

Example

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush();
const control = resetPasswordMfaPushChallengePushManager.pollingManager({
  intervalMs: 5000,
  onCompleted: () => resetPasswordMfaPushChallengePushManager.continue(),
  onError: (error) => console.error('Polling error:', error),
});

control.startPolling();

// 必要に応じて polling を停止します
control.stopPolling();

メソッドのパラメーター

表示 パラメーター

options

MfaPollingOptions。

intervalMs? · number

polling の試行間隔 (ミリ秒) 。

onCompleted? · () => void

プッシュチャレンジが承認され、polling が自動的に停止したときに呼び出されるコールバック。

onError? · (error: Error) => void

polling 中にエラーが発生した場合に呼び出されるコールバック。

resendPushNotification · Promise<void>

このメソッドは、ユーザーのデバイスにプッシュ通知を再送します。

Example

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePushManager.resendPushNotification();

tryAnotherMethod · Promise<void>

このメソッドを使用すると、ユーザーはチャレンジを完了するための別のMFA方式を選択できます。

Example

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePushManager.tryAnotherMethod();