MfaLoginOptions

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

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

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK では、各画面で partial import と root import をサポートしています。

• partial import を使用すると、特定のユースケースに必要なコードだけを含めることができます。
• root import を使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるすべての画面に対応する単一のビルドにしたい場合に便利です。

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>
  );
}

​

Context Hooks

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 画面の transaction 固有のデータを提供します。

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 · 必須

登録する認証要素を示す 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>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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