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>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

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

このフックには、認証フローにおける現在の prompt に関するデータが含まれます。

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 や関連するメタデータなど、tenant に関連するデータが含まれます。

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 画面における transaction 固有のデータを提供します。

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' })}>
      ニックネームを保存
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

MfaWebAuthnChangeKeyNicknameContinueOptions。

nickname · string · 必須

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

​

共通/Utility Hooks

useAuth0Themes · Hooks

このフックは、brandingコンテキストからフラット化されたConfigurationを含む現在のThemeオプションを取得します。

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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