同意

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

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

​

インポート

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

• 部分インポートを使用すると、特定のユースケースに必要なコードだけを取り込めます。
• ルートインポートを使用すると、1 つのバンドルからすべての画面を読み込めるため、考えられるすべての画面に対応する統一ビルドを使用したい場合に便利です。

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

このフックは、同意リクエストが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は 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

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

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

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

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>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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