MfaPushEnrollmentQrMembers - Auth0 Docs

mfa-push-enrollment-qr 画面で使用できるメソッドとプロパティを定義するインターフェース

Example

export interface MfaPushEnrollmentQrMembers extends BaseMembers {
  screen: ScreenMembersOnMfaPushEnrollmentQr;
  /**
   * 認証器選択画面に移動します。
   * @param payload リクエストに含める任意のカスタムオプション
   */
  pickAuthenticator(payload?: CustomOptions): Promise<void>;

  pollingManager(options: MfaPollingOptions): MfaPushPollingControl;
  
}

プロパティ

BrandingMembers

OrganizationMembers

ScreenMembersOnMfaPushEnrollmentQr

TransactionMembers

UntrustedDataMembers

メソッド

Promise<void>

認証器選択画面に移動します。

Show パラメーター

リクエストに含める省略可能なカスタムオプション

MfaPushPollingControl

Show パラメーター

MfaPollingOptions

object

MFA プッシュ通知のポーリング処理を管理するための設定オプションです。ポーリングセッションの開始時にこれらのオプションを指定すると、チャレンジエンドポイントへの問い合わせ頻度や、成功時または失敗時の処理方法を制御できます。

Show プロパティ

number

連続するポーリングリクエストの間隔を ミリ秒 単位で指定する省略可能な値です。

省略した場合は、SDK の内部デフォルト間隔 (通常は 5000 ms) が使用されます。
応答性とレート制限への配慮のバランスが取れる値を選択してください。

() => void

MFA プッシュチャレンジが正常に承認され、ポーリングが完了した時点で実行される省略可能なコールバックです。

1 回だけ呼び出され、その後ポーリングは自動的に停止します。
ログインフローを進めるのに役立ちます (例: continue() の呼び出し) 。

(error) => void

ポーリング中にエラーが発生した場合に呼び出される省略可能なコールバックです。次を含む ULError オブジェクトを受け取ります。

status — 失敗したリクエストの HTTP ステータスコード
responseText — 利用可能な場合の生のレスポンス本文
エラーイベントごとに 1 回呼び出されます。エラーの種類によっては、ポーリングが再試行される場合があります。
エラーメッセージを表示したり、カスタムの再試行/中止ロジックをトリガーしたりするために使用します。

プロパティ

プロパティ

string

string

string

PasswordComplexityRule[]

プロパティ

object

Show プロパティ

number

string

number

string

boolean

PasswordComplexityRule

string

"valid"