MfaEmailList

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

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

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useMfaEmailList,
  // コンテキストHooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通Hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティHooks
  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>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

このHooksは、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

このHooksには、認証フローにおける現在の prompt に関するデータが含まれています。

Example

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

useScreen · () => ScreenMembersOnMfaEmailList

このHooksには、設定やコンテキストを含む、mfa-email-list 画面固有の詳細が含まれています。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このHooksは、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 challenge に使用するメールアドレスを一覧から選択します。

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 · 必須

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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