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

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

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 や関連するメタデータなど、tenant に関するデータが含まれます。

Example

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

useTransaction · () => TransactionMembers

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

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

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

useErrors · Hooks

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