MfaLoginOptions

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

mfa-login-options 画面には、ログインフロー中にユーザーが選択できる MFA の認証要素が表示されます。

​

インポート

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

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

Import Example

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

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

function MfaLoginOptionsScreen() {
  const { enroll } = useMfaLoginOptions();
  return (
    <button onClick={() => enroll({ action: 'totp' })}>
      Use Authenticator App
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、mfa-login-options 画面で使用される id、name、logoUrl などのクライアント関連の構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-login-options';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaLoginOptions

このフックには、mfa-login-options 画面固有の詳細 (構成やコンテキストなど) が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaLoginOptions · MfaLoginOptionsMembers

このフックは、mfa-login-options 画面で利用可能なすべてのメソッドとコンテキストを返します。

​

メソッド

enroll · Promise<void>

このメソッドは、指定された MFA 認証要素を選択し、その認証要素に対応するチャレンジ画面へログインフローを進めます。

Example

import { useMfaLoginOptions } from '@auth0/auth0-acul-react/mfa-login-options';

function LoginOptions() {
  const { enroll } = useMfaLoginOptions();
  return (
    <button onClick={() => enroll({ action: 'totp' })}>
      Use Authenticator App
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

LoginEnrollOptions。

action · string · 必須

登録する MFA 認証要素を指定する action です。“push-notification”、“otp”、“sms”、“phone”、“voice”、“email”、“recovery-code”、“webauthn-roaming”、“webauthn-platform”、または “duo” のいずれかです。

returnToPrevious · Promise<void>

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

Example

import { useMfaLoginOptions } from '@auth0/auth0-acul-react/mfa-login-options';

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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