ログアウト

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

logout 画面は、ユーザーのセッションが終了したときに表示され、ログアウトアクションの確認を求めます。

​

インポート

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

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

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

​

コンテキストHooks

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

このフックは、logout 画面で使用される id、name、logoUrl などのクライアント関連の構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

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

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") かを指定します。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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