MfaPushEnrollmentQr - Auth0 Docs

mfa-push-enrollment-qr 画面には、ユーザーが Auth0 Guardian アプリでスキャンしてプッシュ通知の登録を完了するための QR コードが表示されます。

インポート

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

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

Import Example

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

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

function MfaPushEnrollmentQrScreen() {
  const { pickAuthenticator } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => pickAuthenticator()}>
      Pick Authenticator
    </button>
  );
}

コンテキストHooks

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

useBranding

() => BrandingMembers

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

Example

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

useClient

() => ClientMembers

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

Example

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

useOrganization

() => OrganizationMembers

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

Example

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

useScreen

() => ScreenMembersOnMfaPushEnrollmentQr

このフックには、設定やコンテキストなど、mfa-push-enrollment-qr 画面固有の情報が含まれます。

Example

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

useTenant

() => TenantMembers

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

Example

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

useTransaction

() => TransactionMembers

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

Example

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

useUntrustedData

() => UntrustedDataMembers

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

Example

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

useUser

() => UserMembers

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

Example

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

useMfaPushEnrollmentQr

MfaPushEnrollmentQrMembers

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

メソッド

continueMethod

Promise<void>

このメソッドは、ユーザーが Auth0 Guardian アプリで QR コードをスキャンした後に、プッシュの登録を完了します。

Example

import { useMfaPushEnrollmentQr } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';

function ContinueButton() {
  const { continueMethod } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ rememberDevice: true })}>
      Continue
    </button>
  );
}

メソッドパラメーター

表示パラメーター

options

MfaPushEnrollmentQrWithRememberOptions.

rememberDevice?

boolean

true の場合、このデバイスが記憶され、このデバイスでは MFA が再度要求されなくなります。

pickAuthenticator

Promise<void>

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

Example

import { useMfaPushEnrollmentQr } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';

function PickAuthenticatorButton() {
  const { pickAuthenticator } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => pickAuthenticator()}>
      Pick Authenticator
    </button>
  );
}