メインコンテンツへスキップ
MfaPushEnrollmentQr クラスは、mfa-push-enrollment-qr 画面の機能を実装しています。
ACUL MFA Push 登録 QR

​
コンストラクター

MFA Push 登録用 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
認証フロー内の現在のプロンプトに関するデータを含みます。
​
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',
});
メソッド パラメーター
​
continue
Promise<void>
このメソッドは、プッシュ通知の登録を進めます。
Example
import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.continue();
メソッド パラメーター
​
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 を使用すると、ポーリング処理をいつでも開始、停止、または状態確認できます。次を提供する 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('Polling error:', error),
});

// 必要に応じて後でポーリングをキャンセル
control.stopPolling();
注記
  • HTTP 429 (レート制限) レスポンスは内部的に処理されます。ポーリングは、再試行する前にレート制限がリセットされるまで自動的に待機します。
  • startPolling() は複数回呼び出しても安全です。すでに実行中の場合は効果がありません。
メソッドパラメーター