MfaPushList

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

mfa-push-list 画面には、登録済みのプッシュ通知デバイスの一覧が表示され、ユーザーは認証に使用するデバイスを 1 つ選択できます。

​

インポート

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

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

Import Example

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

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

function MfaPushListScreen() {
  const { selectMfaPushDevice } = useMfaPushList();
  return (
    <button onClick={() => selectMfaPushDevice({ deviceIndex: 0 })}>
      Select Device
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPushList · MfaPushListMembers

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

​

メソッド

goBack · Promise<void>

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

Example

import { useMfaPushList } from '@auth0/auth0-acul-react/mfa-push-list';

function GoBackButton() {
  const { goBack } = useMfaPushList();
  return (
    <button onClick={() => goBack()}>
      戻る
    </button>
  );
}

selectMfaPushDevice · Promise<void>

このメソッドは、MFA チャレンジで使用するプッシュ通知デバイスを、登録済みデバイスの一覧から選択します。

Example

import { useMfaPushList } from '@auth0/auth0-acul-react/mfa-push-list';

function DeviceSelector() {
  const { selectMfaPushDevice } = useMfaPushList();
  return (
    <button onClick={() => selectMfaPushDevice({ deviceIndex: 0 })}>
      このデバイスを使用
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

SelectMfaPushDeviceOptions。

deviceIndex · number · 必須

登録済みデバイスの一覧から選択するデバイスのインデックスです。インデックスは 0 始まりです。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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