MfaOtpEnrollmentQr

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

mfa-otp-enrollment-qr 画面には、ユーザーが認証アプリでスキャンして OTP の登録を完了するための QR コードが表示されます。

​

インポート

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

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

Import Example

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

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

function MfaOtpEnrollmentQrScreen() {
  const { continueMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaOtpEnrollmentQr

このフックには、設定やコンテキストを含む mfa-otp-enrollment-qr 画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaOtpEnrollmentQr · MfaOtpEnrollmentQrMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、OTP コードを送信して認証アプリが正しく設定されていることを検証し、登録を完了します。

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function EnrollmentQrForm() {
  const { continueMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify
    </button>
  );
}

メソッド パラメーター

表示 パラメーター

options

MfaOtpEnrollmentQrContinueOptions。

code · string · 必須

ユーザーが入力した OTP コード。

toggleView · Promise<void>

このメソッドは、登録画面の表示を QR コード モードと手動入力 (シークレットキー) モードで切り替えます。

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function ToggleViewButton() {
  const { toggleView } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => toggleView()}>
      Enter Code Manually
    </button>
  );
}

tryAnotherMethod · Promise<void>

このメソッドは MFA の方法選択画面に移動し、ユーザーが別の認証要素を選択できるようにします。

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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