MfaPushChallengePush

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

mfa-push-challenge-push 画面では、ユーザーのモバイルデバイスに送信された MFA プッシュ通知の承認を求めます。

​

インポート

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

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

Import Example

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

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

function MfaPushChallengePushScreen() {
  const { continueMethod } = useMfaPushChallengePush();
  return (
    <button onClick={() => continueMethod({})}>
      I've Approved
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaPushChallengePush

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaPushChallengePush

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPushChallengePush · MfaPushChallengePushMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、ユーザーがモバイルデバイスで通知を承認した後、プッシュチャレンジを完了します。

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function ContinueButton() {
  const { continueMethod } = useMfaPushChallengePush();
  return (
    <button onClick={() => continueMethod({ rememberDevice: true })}>
      I've Approved
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

WithRememberOptions。

rememberDevice? · boolean

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

enterCodeManually · Promise<void>

このメソッドは手動で code を入力する画面に移動し、ユーザーがプッシュ通知の代わりに OTP code を入力できるようにします。

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function EnterCodeButton() {
  const { enterCodeManually } = useMfaPushChallengePush();
  return (
    <button onClick={() => enterCodeManually()}>
      Enter Code Manually
    </button>
  );
}

resendPushNotification · Promise<void>

このメソッドは、ユーザーのモバイルデバイスにプッシュ通知を再送信します。

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function ResendButton() {
  const { resendPushNotification } = useMfaPushChallengePush();
  return (
    <button onClick={() => resendPushNotification({})}>
      Resend Notification
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

WithRememberOptions。

rememberDevice? · boolean

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

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

​

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

useMfaPolling · Hooks

このフックは、非同期のプッシュ通知への応答を待機する画面のポーリング状態を管理します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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