MfaSmsEnrollment

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

mfa-sms-enrollment 画面では、ユーザーが電話番号を入力して配信方法を選択することで、SMS ベースの MFA に使用する電話番号を登録できます。

​

インポート

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

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

Import Example

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

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

function MfaSmsEnrollmentScreen() {
  const { continueEnrollment } = useMfaSmsEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]' })}>
      Enroll Phone Number
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaSmsEnrollment

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaSmsEnrollment · MfaSmsEnrollmentMembers

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

​

メソッド

continueEnrollment · Promise<void>

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

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

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

メソッドパラメーター

表示 パラメーター

options

MfaSmsEnrollmentContinueOptions。

phone · string · 必須

ユーザーの電話番号。

captcha · string

検証用の省略可能なキャプチャ トークン。

pickCountryCode · Promise<void>

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

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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