> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MfaWebAuthnChangeKeyNicknameMembers

MfaWebAuthnChangeKeyNicknameMembers

````ts Example theme={null}
export interface MfaWebAuthnChangeKeyNicknameMembers extends BaseMembers {
  /**
   * MFA WebAuthn Change Key Nickname固有のデータ構造を持つ画面オブジェクト。
   */
  screen: ScreenMembersOnMfaWebAuthnChangeKeyNickname;
  
  /**
   * WebAuthnセキュリティキーの新しいnicknameを送信します。
   * このactionは、ユーザーが新しいnicknameを入力して「保存」または「続行」ボタンをクリックする操作に対応します。
   * SDKはこの新しいnicknameをAuth0の`/u/mfa-webauthn-change-key-nickname` エンドポイントにPOSTします。
   *
   * 新しいnicknameが有効で更新が成功した場合、Auth0は通常ユーザーを次の適切な画面
   * （例：MFA認証要素管理画面または成功確認画面）にリダイレクトします。
   * nicknameが無効な場合（例：空、長すぎる、短すぎる）、Auth0は
   * 'mfa-webauthn-change-key-nickname' 画面を再レンダリングし、SDKの
   * contextにある`transaction.errors`配列がバリデーション失敗の詳細で更新されます。
   *
   * @param {ContinueOptions} payload - ユーザーが入力した`nickname`（文字列）を含むオブジェクト。
   *                                    拡張のために`CustomOptions`を含めることもできます。
   * @returns {Promise<void>} フォームの送信が開始されたときに解決されるPromise。
   *                          リダイレクトまたはページの再レンダリングが一般的な結果となるため、
   *                          解決時にデータを直接返しません。
   * @throws {Error} `payload.nickname`が指定されていないか文字列でない場合、
   *                 または`FormHandler`が送信中に回復不能な問題（例：ネットワークエラー）に
   *                 遭遇した場合にエラーをスローします。
   *                 Auth0からのバリデーションエラー（無効なnicknameなど）はJavaScriptエラーとして
   *                 スローされず、操作後に`this.transaction.errors`に反映されます。
   *
   * @example
   * ```typescript
   * // 'sdk'はMfaWebAuthnChangeKeyNicknameのインスタンスであると仮定します
   * const newNickname = "My Favorite YubiKey"; // ユーザー入力からの値
   * try {
   *   await sdk.continueWithNewNickname({ nickname: newNickname });
   *   // 成功した場合、ページがリダイレクトされます。
   * } catch (error) {
   *   // このcatchはSDK呼び出し自体で発生した予期しないエラーを処理します。
   *   console.error("Failed to submit the new nickname:", error);
   * }
   * // awaitの後、サーバー側のバリデーションエラーがないかsdk.transaction.errorsを必ず確認してください。
   * if (sdk.transaction.errors && sdk.transaction.errors.length > 0) {
   *   sdk.transaction.errors.forEach(err => {
   *     if (err.field === 'nickname') {
   *       // nicknameの入力フィールドに関連するerr.messageを表示します。
   *       // 例："Name is too short"、"Name is required"
   *     }
   *   });
   * }
   * ```
   */
  continueWithNewNickname(payload: ContinueOptions): Promise<void>;
}
````

<h2 id="properties">
  プロパティ
</h2>

<ParamField body="branding" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>} />

<ParamField body="client" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>} />

<ParamField body="organization" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>} />

<ParamField body="prompt" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>} />

<ParamField body="screen" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>}>
  MFA WebAuthn Change Key Nickname 固有のデータ構造を持つ画面オブジェクトです。
</ParamField>

<ParamField body="tenant" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>} />

<ParamField body="transaction" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>} />

<ParamField body="untrustedData" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} />

<ParamField body="user" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>} />

<h2 id="methods">
  メソッド
</h2>

<ParamField body="continueWithNewNickname" type="Promise<void>">
  WebAuthn セキュリティキーの新しいニックネームを送信します。
  このアクションは、ユーザーが新しいニックネームを入力して「保存」または「続行」ボタンをクリックする操作に対応します。
  SDK は、この新しいニックネームを Auth0 の `/u/mfa-webauthn-change-key-nickname` エンドポイントに POST します。

  新しいニックネームが有効で、更新に成功した場合、Auth0 は通常、ユーザーを
  次の適切な画面 (例: MFA 認証要素管理画面に戻る、または成功確認画面) にリダイレクトします。
  ニックネームが無効な場合 (例: 空、長すぎる、短すぎる) 、Auth0 は
  `mfa-webauthn-change-key-nickname` 画面を再レンダリングし、SDK の
  コンテキスト内の `transaction.errors` 配列がバリデーション失敗の詳細で更新されます。

  フォーム送信が開始されると解決される Promise です。
  解決時に直接データが返されることはありません。通常はリダイレクトまたは
  ページの再レンダリングが発生するためです。

  <h4 id="throws">
    例外
  </h4>

  `payload.nickname` が指定されていない場合、または文字列でない場合はエラーをスローします。
  また、送信中に `FormHandler` で回復不能な問題 (例: ネットワークエラー) が発生した場合も同様です。
  Auth0 からのバリデーションエラー (無効なニックネームなど) は JavaScript エラーとしてはスローされず、
  操作後に `this.transaction.errors` に反映されます。

  ```typescript Example theme={null}
  // 'sdk' が MfaWebAuthnChangeKeyNickname のインスタンスであると仮定します
  const newNickname = "My Favorite YubiKey"; // ユーザー入力の値
  try {
    await sdk.continueWithNewNickname({ nickname: newNickname });
    // 成功した場合、ページはリダイレクトされます。
  } catch (error) {
    // この catch は、SDK 呼び出し自体で発生した予期しないエラーを処理するためのものです。
    console.error("Failed to submit the new nickname:", error);
  }
  // await の後は、サーバー側のバリデーションエラーがないか常に sdk.transaction.errors を確認してください。
  if (sdk.transaction.errors && sdk.transaction.errors.length > 0) {
    sdk.transaction.errors.forEach(err => {
      if (err.field === 'nickname') {
        // ニックネーム入力フィールドに関連する err.message を表示します。
        // 例: "Name is too short", "Name is required"
      }
    });
  }
  ```

  <Expandable title="パラメータ">
    <ParamField body="payload" type={<span><a href="/docs/ja-jp/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions">MfaWebAuthnChangeKeyNicknameContinueOptions</a></span>}>
      ユーザーが入力した `nickname` (文字列) を含むオブジェクトです。
      拡張のための `CustomOptions` を含めることもできます。

      **プロパティ**

      <ParamField body="nickname" type="string">
        WebAuthn セキュリティキーの新しいニックネームです。
        これは、ユーザーが入力フィールドに入力した値です。
        サーバーで定義された長さや文字の制約に従う必要があります。
      </ParamField>
    </ParamField>
  </Expandable>
</ParamField>