MfaSmsEnrollment

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

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

​

インポート

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

• 部分インポートを使うと、特定のユースケースに必要なコードだけを含めることができます。
• ルートインポートを使うと、1 つのバンドルからすべての画面を読み込めるため、想定されるすべての画面を 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 フローの state など、mfa-sms-enrollment 画面向けの transaction 固有のデータを提供します。

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

検証用のオプションのCAPTCHAトークン。

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 · フック

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

useChangeLanguage · フック

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

useCurrentScreen · フック

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

useErrors · フック

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