MfaVoiceEnrollment

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

mfa-voice-enrollment 画面では、ユーザーは電話番号を入力して、音声通話ベースの MFA 用に電話番号を登録できます。

​

インポート

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

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

Import Example

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

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

function MfaVoiceEnrollmentScreen() {
  const { continueMethod } = useMfaVoiceEnrollment();
  return (
    <button onClick={() => continueMethod({ phone: '[phone]' })}>
      Enroll Phone Number
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、mfa-voice-enrollment 画面で使用される id、name、logoUrl などのクライアント関連の設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

このフックには、設定やコンテキストなど、mfa-voice-enrollment 画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaVoiceEnrollment · MfaVoiceEnrollmentMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、音声通話による MFA 登録を完了するために、ユーザーの電話番号を送信します。

Example

import { useMfaVoiceEnrollment } from '@auth0/auth0-acul-react/mfa-voice-enrollment';

function EnrollPhoneForm() {
  const { continueMethod } = useMfaVoiceEnrollment();
  return (
    <button onClick={() => continueMethod({ phone: '[phone]' })}>
      Enroll Phone Number
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

MfaVoiceEnrollmentContinueOptions。

phone · string · 必須

ユーザーの電話番号。

selectPhoneCountryCode · Promise<void>

このメソッドは、国番号の選択画面に移動します。

Example

import { useMfaVoiceEnrollment } from '@auth0/auth0-acul-react/mfa-voice-enrollment';

function SelectCountryCodeButton() {
  const { selectPhoneCountryCode } = useMfaVoiceEnrollment();
  return (
    <button onClick={() => selectPhoneCountryCode()}>
      Select Country Code
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaVoiceEnrollment } from '@auth0/auth0-acul-react/mfa-voice-enrollment';

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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