MfaPushWelcome

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

mfa-push-welcome 画面では、ユーザーにプッシュ通知 MFA を紹介し、登録するか別の認証器を選択するよう求めます。

​

インポート

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

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

Import Example

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

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

function MfaPushWelcomeScreen() {
  const { enroll } = useMfaPushWelcome();
  return (
    <button onClick={() => enroll()}>
      Set Up Push Notifications
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaPushWelcome

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPushWelcome · MfaPushWelcomeMembers

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

​

メソッド

enroll · Promise<void>

このメソッドは、ユーザーのプッシュ通知の登録フローを開始します。

Example

import { useMfaPushWelcome } from '@auth0/auth0-acul-react/mfa-push-welcome';

function EnrollButton() {
  const { enroll } = useMfaPushWelcome();
  return (
    <button onClick={() => enroll()}>
      Set Up Push Notifications
    </button>
  );
}

pickAuthenticator · Promise<void>

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

Example

import { useMfaPushWelcome } from '@auth0/auth0-acul-react/mfa-push-welcome';

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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