MfaEnrollResult

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

mfa-enroll-result 画面には、MFA の登録試行の結果が表示され、認証要素が正常に登録されたかどうかが確認できます。

​

インポート

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

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

Import Example

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

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

function MfaEnrollResultScreen() {
  const screen = useMfaEnrollResult();
  return (
    <div>Enrollment complete</div>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaEnrollResult

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaEnrollResult · MfaEnrollResultMembers

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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