MfaPhoneChallenge

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

mfa-phone-challenge 画面では、SMS または音声通話で電話に送信されたコードを入力して本人確認を行います。

​

インポート

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

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

Import Example

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

// partialインポート
import {
  useMfaPhoneChallenge,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  continueMethod,
  pickPhone,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-phone-challenge";

function MfaPhoneChallengeScreen() {
  const { continueMethod } = useMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaPhoneChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPhoneChallenge · MfaPhoneChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、指定した送信方法でユーザーの電話番号に確認コードを送り、電話チャレンジを開始します。

Example

import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react/mfa-phone-challenge';

function PhoneChallengeForm() {
  const { continueMethod } = useMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

MfaPhoneChallengeContinueOptions.

type · "sms" | "voice" · 必須

実行するチャレンジの種類です。

• sms: テキストメッセージでコードを送信します。
• voice: 音声通話でコードを送信します。

​

デフォルト

'sms'

pickPhone · Promise<void>

このメソッドは電話番号の選択画面に移動し、ユーザーがチャレンジに使用する電話番号を選択できるようにします。

Example

import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react/mfa-phone-challenge';

function PickPhoneButton() {
  const { pickPhone } = useMfaPhoneChallenge();
  return (
    <button onClick={() => pickPhone()}>
      Choose Phone Number
    </button>
  );
}

tryAnotherMethod · Promise<void>

このメソッドはMFA方式の選択画面に移動し、ユーザーが別の認証要素を選択できるようにします。

Example

import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react/mfa-phone-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaPhoneChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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