MfaWebauthnEnrollmentSuccess

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

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

​

インポート

各画面には、それぞれ専用のフックとメソッドが用意されています。SDK は、各画面で 部分インポート と ルートインポート の両方をサポートしています。

• 部分インポートを使うと、特定の用途に必要なコードだけを取り込めます。
• ルートインポートを使うと、1 つのバンドルからすべての画面を読み込めるため、想定されるすべての画面に対応する共通のビルドを使いたい場合に便利です。

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>組織コンテキストがありません</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フローの状態など、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

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