MfaWebAuthnEnrollmentSuccessMembers

MfaWebAuthnEnrollmentSuccessMembers

Example

export interface MfaWebAuthnEnrollmentSuccessMembers extends BaseMembers {
  /**
   * 'mfa-webauthn-enrollment-success' 画面の特定のプロパティとデータへのアクセス。
   * 登録された認証器の `nickname` とその `webauthnType` を含みます。
   * @type {ScreenMembersOnMfaWebAuthnEnrollmentSuccess}
   */
  screen: ScreenMembersOnMfaWebAuthnEnrollmentSuccess;

  /**
   * WebAuthn 登録が成功した後、ユーザーが認証フローを続行できるようにします。
   * このメソッドは `/u/mfa-webauthn-enrollment-success` エンドポイントに `action: "default"` を指定して POST リクエストを送信します。
   *
   * @param {ContinueOptions} [payload] - 省略可能。リクエストに追加のパラメーターを含める必要がある場合の `CustomOptions` オブジェクト。
   * @returns {Promise<void>} 続行アクションが正常に送信されたときに解決される Promise。
   *                          成功した場合、ブラウザは通常フローの次のステップにリダイレクトされます。
   * @throws {Error} フォームの送信に失敗した場合（例：ネットワークエラー、無効な state）にエラーをスローします。
   *
   * @example
   * ```typescript
   * // 'sdk' は MfaWebAuthnEnrollmentSuccess のインスタンスと仮定します
   * try {
   *   await sdk.continue();
   *   // ユーザーは次のステップにリダイレクトされます。
   * } catch (error) {
   *   console.error("WebAuthn 登録後の続行に失敗しました:", error);
   *   // エラーを処理します。ページがエラーで再レンダリングされる場合は sdk.transaction.errors を確認してください。
   * }
   * ```
   */
  continue(payload?: ContinueOptions): Promise<void>;
}

プロパティ

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaWebAuthnEnrollmentSuccess

‘mfa-webauthn-enrollment-success’ 画面固有のプロパティとデータにアクセスできます。 登録されている認証器の nickname と webauthnType が含まれます。

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

メソッド

continue · Promise<void>

WebAuthn の登録が正常に完了した後、ユーザーが認証フローを続行できるようにします。 このメソッドは、action: "default" を指定して /u/mfa-webauthn-enrollment-success エンドポイントに POST リクエストを送信します。

continue アクションが正常に送信されると解決される Promise です。 成功すると、通常、ブラウザーはフローの次のステップにリダイレクトされます。

Throws

フォームの送信に失敗した場合 (例: ネットワークの問題、無効な state) にエラーをスローします。

Example

// 'sdk' は MfaWebAuthnEnrollmentSuccess のインスタンスであると仮定します
try {
  await sdk.continue();
  // ユーザーは次のステップにリダイレクトされます。
} catch (error) {
  console.error("Failed to continue after WebAuthn enrollment:", error);
  // エラーを処理します。ページがエラーとともに再度レンダリングされる場合は、sdk.transaction.errors を確認してください。
}

Show パラメーター

payload? · WebAuthnEnrollSuccessContinueOptions

任意。リクエストとともに追加のパラメーターを送信する必要がある場合に指定する、CustomOptions 用のオブジェクトです。