MfaDetectBrowserCapabilities

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

mfa-detect-browser-capabilities 画面では、ブラウザーがサポートしている MFA 機能が自動的に検出され、ユーザーは適切な認証要素の登録フローまたはチャレンジフローに振り分けられます。

​

インポート

各画面には、それぞれ固有のフックとメソッドが用意されています。SDK では、各画面で partial import と root import をサポートしています。

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

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

​

コンテキストHooks

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

Example

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

useTransaction · () => TransactionMembers

このフックは、現在のMFAフローの状態など、mfa-detect-browser-capabilities 画面向けのtransaction固有のデータを提供します。

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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