MfaWebauthnEnrollmentSuccess

Universal Login の mfa-webauthn-enrollment-success 画面をカスタマイズするために利用できる、すべてのフックとメソッドについて説明します。

mfa-webauthn-enrollment-success 画面では、ユーザーが WebAuthn セキュリティキーの登録に成功したことを確認し、認証フローを続行できます。

​

インポート

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

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

Import Example

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

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

function MfaWebAuthnEnrollmentSuccessScreen() {
  const { continueMethod } = useMfaWebAuthnEnrollmentSuccess();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、mfa-webauthn-enrollment-success 画面で使用される id、name、logoUrl などのクライアント関連の構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-enrollment-success';
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-enrollment-success';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaWebAuthnEnrollmentSuccess

このフックには、設定やコンテキストを含む、mfa-webauthn-enrollment-success 画面に固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaWebAuthnEnrollmentSuccess · MfaWebAuthnEnrollmentSuccessMembers

このフックは、mfa-webauthn-enrollment-success 画面で利用可能なすべてのメソッドとコンテキストを返します。

​

メソッド

continueMethod · Promise<void>

このメソッドは、ユーザーが WebAuthn セキュリティキーの登録に成功した後、フローを先に進めます。

Example

import { useMfaWebAuthnEnrollmentSuccess } from '@auth0/auth0-acul-react/mfa-webauthn-enrollment-success';

function ContinueButton() {
  const { continueMethod } = useMfaWebAuthnEnrollmentSuccess();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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