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

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

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()}>
      戻る
    </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' })}>
      +1（US）を選択
    </button>
  );
}

メソッド パラメーター

表示 パラメーター

options

SelectCountryCodeOptions。

country_code · string · 必須

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

phone_prefix · string · 必須

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者のエラーを参照および管理します。