MfaSmsList

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

mfa-sms-list 画面には登録済みの電話番号の一覧が表示され、ユーザーは SMS の確認コードを受け取る電話番号を 1 つ選択できます。

​

インポート

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

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

Import Example

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

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

function MfaSmsListScreen() {
  const { selectPhoneNumber } = useMfaSmsList();
  return (
    <button onClick={() => selectPhoneNumber({ index: 0 })}>
      Use This Phone Number
    </button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、現在のMFAフローの状態など、mfa-sms-list 画面における transaction 固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaSmsList · MfaSmsListMembers

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

​

メソッド

backAction · Promise<void>

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

Example

import { useMfaSmsList } from '@auth0/auth0-acul-react/mfa-sms-list';

function BackButton() {
  const { backAction } = useMfaSmsList();
  return (
    <button onClick={() => backAction()}>
      Go Back
    </button>
  );
}

selectPhoneNumber · Promise<void>

このメソッドは、登録済みの一覧からSMSチャレンジに使用する電話番号を選択します。

Example

import { useMfaSmsList } from '@auth0/auth0-acul-react/mfa-sms-list';

function PhoneNumberSelector() {
  const { selectPhoneNumber } = useMfaSmsList();
  return (
    <button onClick={() => selectPhoneNumber({ index: 0 })}>
      Use This Phone Number
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

MfaSmsListOptions。

index · number · 必須

選択する電話番号のインデックス。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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