MfaPushEnrollmentQr

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

MfaPushEnrollmentQr クラスは、mfa-push-enrollment-qr画面の機能を実装したクラスです。

​

コンストラクター

MFAプッシュ登録QR画面マネージャーのインスタンスを作成します：

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaPushEnrollmentQr

設定やコンテキストを含む、mfa-push-enrollment-qr 画面固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFAプッシュ登録中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
mfaPushEnrollmentQr.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、プッシュ通知の登録処理を続行します。

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.continue();

メソッドのパラメーター

表示 パラメーター

options

MfaPushEnrollmentQrWithRememberOptions。

rememberDevice? · boolean

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

getErrors · Error []

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

pickAuthenticator · Promise<void>

このメソッドは、認証器選択画面に移動します。

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

pollingManager · MfaPushPollingControl

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

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

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

以下を公開する MfaPushPollingControl インスタンスを返します:

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

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();

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

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

備考

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

メソッドパラメータ

表示 パラメータ

options

MfaPollingOptions。

intervalMs? · number

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

onCompleted()? · () => void

MFA プッシュ登録が正常に承認されてポーリングが完了したときに実行される、省略可能なコールバックです。呼び出されるのは 1 回だけで、その後ポーリングは自動的に停止します。

onError()? · (error) => void

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