BruteForceProtectionUnblock

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

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

​

インポート

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

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

Import Example

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

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

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

​

コンテキストHooks

brute-force-protection-unblock 画面で、Auth0 のコンテキストデータへの読み取り専用アクセスを提供する画面スコープの Hooks です。@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

このフックは、アンブロックフローが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は 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 パラメータから事前入力された username など、画面に渡される信頼できないデータを扱います。

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

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