MfaDetectBrowserCapabilities

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

mfa-detect-browser-capabilities 画面は、ブラウザーがサポートする MFA 機能を自動的に検出し、適切な認証要素の登録フローまたはチャレンジフローへユーザーを誘導します。

​

インポート

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

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

Import Example

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

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

function MfaDetectBrowserCapabilitiesScreen() {
  const { detectCapabilities } = useMfaDetectBrowserCapabilities();
  return (
    <button onClick={() => detectCapabilities()}>
      Detect Capabilities
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、mfa-detect-browser-capabilities 画面で使用される id、name、logoUrl などのクライアント関連設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/mfa-detect-browser-capabilities';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaDetectBrowserCapabilities · MfaDetectBrowserCapabilitiesMembers

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

​

メソッド

detectCapabilities · Promise<void>

このメソッドは、どの MFA 認証要素がブラウザーでサポートされているかを検出し、その結果に応じてフローを進めます。

Example

import { useMfaDetectBrowserCapabilities } from '@auth0/auth0-acul-react/mfa-detect-browser-capabilities';

function DetectCapabilities() {
  const { detectCapabilities } = useMfaDetectBrowserCapabilities();
  return (
    <button onClick={() => detectCapabilities()}>
      Continue
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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