MfaWebAuthnEnrollmentSuccessMembers

MfaWebAuthnEnrollmentSuccessMembers

Example

export interface MfaWebAuthnEnrollmentSuccessMembers extends BaseMembers {
  /**
   * Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen.
   * Includes the `nickname` of the enrolled authenticator and its `webauthnType`.
   * @type {ScreenMembersOnMfaWebAuthnEnrollmentSuccess}
   */
  screen: ScreenMembersOnMfaWebAuthnEnrollmentSuccess;

  /**
   * Allows the user to continue the authentication flow after successful WebAuthn enrollment.
   * This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`.
   *
   * @param {ContinueOptions} [payload] - Optional. An object for `CustomOptions` if any
   *                                        additional parameters need to be sent with the request.
   * @returns {Promise<void>} A promise that resolves when the continue action is successfully submitted.
   *                          On success, the browser will typically be redirected to the next step in the flow.
   * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state).
   *
   * @example
   * ```typescript
   * // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess
   * try {
   *   await sdk.continue();
   *   // User is redirected to the next step.
   * } catch (error) {
   *   console.error("Failed to continue after WebAuthn enrollment:", error);
   *   // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error.
   * }
   * ```
   */
  continue(payload?: ContinueOptions): Promise<void>;
}

Properties

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaWebAuthnEnrollmentSuccess

Access to the specific properties and data of the ‘mfa-webauthn-enrollment-success’ screen. Includes the nickname of the enrolled authenticator and its webauthnType.

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Methods

continue · Promise<void>

Allows the user to continue the authentication flow after successful WebAuthn enrollment. This method sends a POST request to the /u/mfa-webauthn-enrollment-success endpoint with action: "default".

A promise that resolves when the continue action is successfully submitted. On success, the browser will typically be redirected to the next step in the flow.

Throws

Throws an error if the form submission fails (e.g., network issue, invalid state).

Example

// Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess
try {
  await sdk.continue();
  // User is redirected to the next step.
} catch (error) {
  console.error("Failed to continue after WebAuthn enrollment:", error);
  // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error.
}

Show Parameters

payload? · WebAuthnEnrollSuccessContinueOptions

Optional. An object for CustomOptions if any additional parameters need to be sent with the request.