MfaPhoneEnrollment

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

mfa-phone-enrollment 画面では、ユーザーは電話番号を入力して配信方法を選択することで、SMS または音声通話による MFA 用の電話番号を登録できます。

​

インポート

各画面では、それぞれ利用できる Hooks とメソッドが異なります。SDK は、各画面で 部分インポート と ルートインポート の両方をサポートしています。

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

Import Example

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

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

function MfaPhoneEnrollmentScreen() {
  const { continueEnrollment } = useMfaPhoneEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]', type: 'sms' })}>
      Enroll Phone
    </button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-phone-enrollment';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>組織コンテキストがありません</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPhoneEnrollment · MfaPhoneEnrollmentMembers

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

​

メソッド

continueEnrollment · Promise<void>

このメソッドは、ユーザーの電話番号と選択した配信方法を送信して、MFA 用の電話番号を登録します。

Example

import { useMfaPhoneEnrollment } from '@auth0/auth0-acul-react/mfa-phone-enrollment';

function PhoneEnrollmentForm() {
  const { continueEnrollment } = useMfaPhoneEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '5551234567', type: 'sms' })}>
      Enroll Phone
    </button>
  );
}

メソッド引数

表示 引数

options

MfaPhoneEnrollmentContinueOptions。

phone · string · 必須

MFA 用に登録する電話番号。

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

確認コードの配信方法。

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

pickCountryCode · Promise<void>

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

Example

import { useMfaPhoneEnrollment } from '@auth0/auth0-acul-react/mfa-phone-enrollment';

function PickCountryCodeButton() {
  const { pickCountryCode } = useMfaPhoneEnrollment();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaPhoneEnrollment } from '@auth0/auth0-acul-react/mfa-phone-enrollment';

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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