MfaPushChallengePush

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

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

​

インポート

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

• partial import を使うと、特定の用途に必要なコードだけを取り込めます。
• root import を使うと、1 つのバンドルからすべての画面を読み込めるため、想定されるあらゆる画面に対応する統一ビルドが必要な場合に便利です。

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 フローの状態など、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>

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

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

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