ブルートフォース対策のブロック解除

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

brute-force-protection-unblock 画面は、ログイン失敗が多すぎるために Auth0 がユーザーのアカウントをブロックした際に表示され、本人確認を行ってアクセスのブロックを解除するよう求めます。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useBruteForceProtectionUnblock,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  unblockAccount,
} from '@auth0/auth0-acul-react/brute-force-protection-unblock';

function UnblockForm() {
  const { unblockAccount } = useBruteForceProtectionUnblock();
  return (
    <button onClick={() => unblockAccount()}>
      Unblock Account
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、brute-force-protection-unblock 画面用の id、name、logoUrl など、クライアント関連の設定を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnBruteForceProtectionUnblock

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

Example

import { useScreen } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

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

Example

import { useTenant } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフローの状態など、brute-force-protection-unblock 画面に関するトランザクション固有のデータを提供します。

Example

import { useTransaction } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

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

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

import { useUser } from '@auth0/auth0-acul-react/brute-force-protection-unblock';
function UserProfile() {
  const user = useUser();
}

useBruteForceProtectionUnblock · BruteForceProtectionUnblockMembers

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

​

メソッド

unblockAccount · Promise<void>

このメソッドは、総当たり攻撃対策がトリガーされた後に、ユーザーのアカウントのブロックを解除するリクエストを送信します。

Example

import { useBruteForceProtectionUnblock } from '@auth0/auth0-acul-react/brute-force-protection-unblock';

function UnblockForm() {
  const { unblockAccount } = useBruteForceProtectionUnblock();
  return (
    <button onClick={() => unblockAccount()}>
      Unblock Account
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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