MfaWebauthnChangeKeyNickname

Universal Login の mfa-webauthn-change-key-nickname 画面をカスタマイズするために利用可能な、すべてのフックとメソッドを説明します。

mfa-webauthn-change-key-nickname 画面では、登録済みの WebAuthn セキュリティキーの表示名を設定または更新できます。

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK は、各画面で部分インポートとルートインポートをサポートしています。

• 部分インポートを使用すると、特定のユースケースに必要なコードだけを含めることができます。
• ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めます。これは、想定されるすべての画面を単一のビルドで処理したい場合に便利です。

Import Example

// ルートインポート
import { useMfaWebAuthnChangeKeyNickname } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  useMfaWebAuthnChangeKeyNickname,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  continueWithNewNickname,
} from "@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname";

function MfaWebAuthnChangeKeyNicknameScreen() {
  const { continueWithNewNickname } = useMfaWebAuthnChangeKeyNickname();
  return (
    <button onClick={() => continueWithNewNickname({ nickname: 'My Security Key' })}>
      Save Nickname
    </button>
  );
}

​

コンテキストフック

mfa-webauthn-change-key-nickname 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname からインポートします。

useBranding · () => BrandingMembers

このフックは、mfa-webauthn-change-key-nickname 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、mfa-webauthn-change-key-nickname 画面の id、name、logoUrl など、クライアント関連の設定を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、MFA フローが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

このフックには、認証フロー内の現在のプロンプトに関するデータが含まれます。

Example

import { usePrompt } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaWebAuthnChangeKeyNickname

このフックには、設定やコンテキストなど、mfa-webauthn-change-key-nickname 画面固有の詳細が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

このフックには、id や関連するメタデータなど、テナントに関するデータが含まれます。

Example

import { useTenant } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

このフックは、現在の MFA フローの状態など、mfa-webauthn-change-key-nickname 画面のトランザクション固有データを提供します。

Example

import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

このフックは、URL パラメーターから事前入力された値など、画面に渡される信頼できないデータを扱います。

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、現在のユーザーの詳細情報を提供します。

Example

import { useUser } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';
function UserProfile() {
  const user = useUser();
}
}

useMfaWebAuthnChangeKeyNickname · MfaWebAuthnChangeKeyNicknameMembers

このフックは、mfa-webauthn-change-key-nickname 画面で使用できるすべてのメソッドとコンテキストを返します。

​

メソッド

continueWithNewNickname · Promise<void>

このメソッドは、登録済みの WebAuthn セキュリティキーの新しいニックネームを送信します。

Example

import { useMfaWebAuthnChangeKeyNickname } from '@auth0/auth0-acul-react/mfa-webauthn-change-key-nickname';

function SaveNicknameForm() {
  const { continueWithNewNickname } = useMfaWebAuthnChangeKeyNickname();
  return (
    <button onClick={() => continueWithNewNickname({ nickname: 'My Security Key' })}>
      Save Nickname
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

MfaWebAuthnChangeKeyNicknameContinueOptions。

nickname · string · 必須

WebAuthn セキュリティキーの新しいニックネーム。

​

共通/ユーティリティフック

useAuth0Themes · Hooks

このフックは、ブランディングコンテキストから、フラット化された設定を含む現在のテーマオプションを取得します。

useChangeLanguage · Hooks

このフックは、現在の ACUL 画面の表示言語を変更するための関数を返します。

useCurrentScreen · Hooks

このフックは、現在の画面のコンテキストと状態を取得します。

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者の各エラーを取得して管理します。