MfaPushList

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

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

​

インポート

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

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

Import Example

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

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

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPushList · MfaPushListMembers

このHooksは、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()}>
      Go Back
    </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 })}>
      Use This Device
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

SelectMfaPushDeviceOptions。

deviceIndex · number · 必須

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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