Consent

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

consent 画面は、ユーザーがアプリケーションに対する権限の付与または拒否を求められる際に、認可フロー中に表示されます。要求されたスコープが表示され、ユーザーは同意リクエストを承認または拒否できます。

​

インポート

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

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

Import Example

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

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

function ConsentScreen() {
  const { accept, deny } = useConsent();
  return (
    <>
      <button onClick={() => accept()}>Accept</button>
      <button onClick={() => deny()}>Deny</button>
    </>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

このフックには、authentication flow における現在の prompt に関するデータが含まれます。

Example

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

useScreen · () => ScreenMembersOnConsent

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフロー state など、consent 画面における transaction 固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useConsent · ConsentMembers

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

​

メソッド

accept · Promise<void>

このメソッドはユーザーの同意を送信し、アプリケーションに要求された権限を付与します。

Example

import { useConsent } from '@auth0/auth0-acul-react/consent';

function AcceptButton() {
  const { accept } = useConsent();
  return (
    <button onClick={() => accept()}>
      Accept
    </button>
  );
}

deny · Promise<void>

このメソッドは同意リクエストを拒否し、アプリケーションに要求された権限を取り消します。

Example

import { useConsent } from '@auth0/auth0-acul-react/consent';

function DenyButton() {
  const { deny } = useConsent();
  return (
    <button onClick={() => deny()}>
      Deny
    </button>
  );
}

​

共通/Utility Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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