MfaWebAuthnErrorMembers

MfaWebAuthnErrorMembers

Example

export interface MfaWebAuthnErrorMembers extends BaseMembers {
  /**
   * MFA WebAuthn Error 固有のデータ構造を持つ画面オブジェクト。
   */
  screen: ScreenMembersOnMfaWebAuthnError;
  
  /**
   * ユーザーが前回の WebAuthn 操作を再試行できるようにします。
   * 通常、WebAuthn 操作が開始された画面にユーザーをリダイレクトします。
   *
   * @param {CustomOptions} [payload] - リクエストに含めるオプションのカスタムオプション。
   * @returns {Promise<void>} アクションが正常に送信されると解決される Promise。
   * @throws {Error} 送信に失敗した場合にエラーをスローします。
   * @example
   * ```typescript
   * // 'sdk' は MfaWebAuthnError のインスタンスであると仮定します
   * await sdk.tryAgain();
   * ```
   */
  tryAgain(payload?: CustomOptions): Promise<void>;

  /**
   * 設定されている場合、ユーザーが代替手段としてパスワードベースの認証を選択できるようにします。
   * 通常、主要な認証または前のステップでパスワードが使用された場合に利用可能です。
   *
   * @param {CustomOptions} [payload] - リクエストに含めるオプションのカスタムオプション。
   * @returns {Promise<void>} アクションが正常に送信されると解決される Promise。
   * @throws {Error} 送信に失敗した場合にエラーをスローします。
   * @example
   * ```typescript
   * // 'sdk' は MfaWebAuthnError のインスタンスであると仮定します
   * await sdk.usePassword();
   * ```
   */
  usePassword(payload?: CustomOptions): Promise<void>;

  /**
   * 他の認証要素が登録済みまたは利用可能な場合、ユーザーが別の MFA 方式を選択できるようにします。
   * 認証器選択画面にユーザーを誘導します。
   *
   * @param {CustomOptions} [payload] - リクエストに含めるオプションのカスタムオプション。
   * @returns {Promise<void>} アクションが正常に送信されると解決される Promise。
   * @throws {Error} 送信に失敗した場合にエラーをスローします。
   * @example
   * ```typescript
   * // 'sdk' は MfaWebAuthnError のインスタンスであると仮定します
   * await sdk.tryAnotherMethod();
   * ```
   */
  tryAnotherMethod(payload?: CustomOptions): Promise<void>;

  /**
   * ユーザーがデバイスの追加または WebAuthn ステップの完了を拒否し、現在の WebAuthn フローを実質的にスキップできるようにします。
   * このアクションは通常、ユーザーが続行しないことを選択した登録シナリオで使用されます。
   *
   * @param {CustomOptions} [payload] - リクエストに含めるオプションのカスタムオプション。
   * @returns {Promise<void>} アクションが正常に送信されると解決される Promise。
   * @throws {Error} 送信に失敗した場合にエラーをスローします。
   * @example
   * ```typescript
   * // 'sdk' は MfaWebAuthnError のインスタンスであると仮定します
   * await sdk.noThanks();
   * ```
   */
  noThanks(payload?: CustomOptions): Promise<void>;
}

プロパティ

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaWebAuthnError

MFA WebAuthn Error に固有のデータ構造を持つ画面オブジェクト。

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

メソッド

noThanks · Promise<void>

ユーザーがデバイスの追加や WebAuthn ステップの完了を拒否し、現在の WebAuthn フローを辞退できるようにします。 このアクションは通常、ユーザーが続行しないことを選んだ登録シナリオで使用されます。

アクションが正常に送信されると完了する Promise。

スロー

送信に失敗した場合はエラーをスローします。

Example

// 'sdk' が MfaWebAuthnError のインスタンスであると仮定します
await sdk.noThanks();

Show パラメーター

payload? · CustomOptions

リクエストに含める任意のカスタムオプション。

tryAgain · Promise<void>

ユーザーが直前の WebAuthn 操作を再試行できるようにします。 通常、ユーザーは WebAuthn 操作を開始した画面に戻ります。

アクションが正常に送信されると完了する Promise。

スロー

送信に失敗した場合はエラーをスローします。

Example

// 'sdk' が MfaWebAuthnError のインスタンスであると仮定します
await sdk.tryAgain();

Show パラメーター

payload? · CustomOptions

リクエストに含める任意のカスタムオプション。

tryAnotherMethod · Promise<void>

他の認証要素が登録済みまたは利用可能な場合、ユーザーが別のMFA方式を選択できるようにします。 これにより、ユーザーは認証器選択画面に移動します。

アクションが正常に送信されると完了する Promise。

スロー

送信に失敗した場合はエラーをスローします。

Example

// 'sdk' が MfaWebAuthnError のインスタンスであると仮定します
await sdk.tryAnotherMethod();

Show パラメーター

payload? · CustomOptions

リクエストに含める任意のカスタムオプション。

usePassword · Promise<void>

設定されている場合、ユーザーが代替手段としてパスワードベースの認証を選択できるようにします。 通常、プライマリ認証または前のステップでパスワードが使われていた場合に利用できます。

アクションが正常に送信されると完了する Promise。

スロー

送信に失敗した場合はエラーをスローします。

Example

// 'sdk' が MfaWebAuthnError のインスタンスであると仮定します
await sdk.usePassword();

Show パラメーター

payload? · CustomOptions

リクエストに含める任意のカスタムオプション。