MfaEmailList

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

mfa-email-list 画面には、MFA の検証に使用できるメールアドレスの一覧が表示され、ユーザーはその中から選択できます。

​

インポート

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

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

Import Example

// root import
import { useMfaEmailList } from '@auth0/auth0-acul-react';

// partial import
import {
  useMfaEmailList,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  goBack,
  selectMfaEmail,
} from "@auth0/auth0-acul-react/mfa-email-list";

function MfaEmailListScreen() {
  const { selectMfaEmail } = useMfaEmailList();
  return (
    <button onClick={() => selectMfaEmail({ index: 0 })}>
      Select Email
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaEmailList

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaEmailList · MfaEmailListMembers

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

​

メソッド

goBack · Promise<void>

このメソッドは、MFA フローで前の画面に戻ります。

Example

import { useMfaEmailList } from '@auth0/auth0-acul-react/mfa-email-list';

function BackButton() {
  const { goBack } = useMfaEmailList();
  return (
    <button onClick={() => goBack()}>
      Back
    </button>
  );
}

selectMfaEmail · Promise<void>

このメソッドは、MFA チャレンジで使用するメールアドレスを一覧から選択します。

Example

import { useMfaEmailList } from '@auth0/auth0-acul-react/mfa-email-list';

function EmailSelector() {
  const { selectMfaEmail } = useMfaEmailList();
  return (
    <button onClick={() => selectMfaEmail({ index: 0 })}>
      Use This Email
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

SelectMfaEmailOptions。

index · number · 必須

選択するメールアドレスのインデックス。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者エラーを参照および管理します。