MfaCountryCodes

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

mfa-country-codes 画面では、ユーザーは電話ベースの MFA の登録またはチャレンジのフローで使用する国番号を一覧から選択できます。

​

インポート

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

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

Import Example

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

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

function MfaCountryCodesScreen() {
  const { selectCountryCode } = useMfaCountryCodes();
  return (
    <button onClick={() => selectCountryCode({ country_code: 'US', phone_prefix: '+1' })}>
      Select +1 (US)
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaCountryCodes

このフックには、利用可能な国番号の一覧や現在の画面コンテキストなど、mfa-country-codes 画面に固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaCountryCodes · MfaCountryCodesMembers

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

​

メソッド

goBack · Promise<void>

このメソッドは、MFAフロー内で前の画面に戻ります。

Example

import { useMfaCountryCodes } from '@auth0/auth0-acul-react/mfa-country-codes';

function BackButton() {
  const { goBack } = useMfaCountryCodes();
  return (
    <button onClick={() => goBack()}>
      Back
    </button>
  );
}

selectCountryCode · Promise<void>

このメソッドは、選択した国コードを確定し、ユーザーを登録画面またはチャレンジ画面に戻します。

Example

import { useMfaCountryCodes } from '@auth0/auth0-acul-react/mfa-country-codes';

function CountryCodePicker() {
  const { selectCountryCode } = useMfaCountryCodes();
  return (
    <button onClick={() => selectCountryCode({ country_code: 'US', phone_prefix: '+1' })}>
      Select +1 (US)
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

SelectCountryCodeOptions。

country_code · string · 必須

国コード (例: "US"、"GB") 。

phone_prefix · string · 必須

電話番号のプレフィックス (例: "+1"、"+44") 。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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