MfaSmsList

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

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

​

インポート

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

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

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>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

この Hook は、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()}>
      戻る
    </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 })}>
      この電話番号を使用
    </button>
  );
}

メソッド パラメーター

表示 パラメーター

options

MfaSmsListOptions。

index · number · 必須

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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