ログアウト

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

logout 画面は、ユーザーのセッションが終了すると表示され、ログアウトするかどうかの確認を求めます。

​

インポート

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

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

Import Example

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

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

function LogoutScreen() {
  const { confirmLogout } = useLogout();
  return (
    <button onClick={() => confirmLogout({ action: 'accept' })}>
      Sign Out
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

このフックには、設定やコンテキストを含む、logout 画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URL クエリ文字列のパラメーターなど、画面に渡される信頼できないデータを提供します。

Example

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

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、アクティブなユーザーの詳細を提供します。

Example

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

useLogout · LogoutMembers

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

​

メソッド

confirmLogout · Promise<void>

このメソッドは、現在のセッションのログアウトを確定するか、キャンセルするかを指定します。

Example

import { useLogout } from '@auth0/auth0-acul-react/logout';

function LogoutScreen() {
  const { confirmLogout } = useLogout();
  return (
    <>
      <button onClick={() => confirmLogout({ action: 'accept' })}>
        Sign Out
      </button>
      <button onClick={() => confirmLogout({ action: 'deny' })}>
        Stay Signed In
      </button>
    </>
  );
}

メソッドパラメーター

表示 パラメーター

options

ConfirmLogoutOptions。

action · "accept" | "deny" · 必須

ログアウトを確定するか ("accept") 、キャンセルするか ("deny") を指定します。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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