> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ログアウト

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

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

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/translations/pvjQqAy3EB2TK6NP/docs/images/cdy7uua7fh8z/4fvafgoqxrpjSNPdR8tlGj/185beaff20e8fe2b23a4ca3810940fe9/Screenshot_2025-05-15_at_16.04.46.png?fit=max&auto=format&n=pvjQqAy3EB2TK6NP&q=85&s=cf1c3b026e74bbb77c56fc8699ba0e28" alt="ログアウト" width="391" height="527" data-path="docs/images/cdy7uua7fh8z/4fvafgoqxrpjSNPdR8tlGj/185beaff20e8fe2b23a4ca3810940fe9/Screenshot_2025-05-15_at_16.04.46.png" />
</Frame>

<div id="import">
  ## インポート
</div>

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

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

```jsx Import Example theme={null}
// ルートインポート
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>
  );
}
```

<div id="context-hooks">
  ## コンテキストHooks
</div>

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

<ParamField body="useBranding" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}>
  このフックは、`logout` 画面に表示されるロゴ、色、テーマ設定などのブランディング構成を提供します。

  ```jsx Example theme={null}
  import { useBranding } from '@auth0/auth0-acul-react/logout';
  function CustomTheme() {
    const branding = useBranding();
  }
  ```
</ParamField>

<ParamField body="useClient" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}>
  このフックは、`logout` 画面で使用される `id`、`name`、`logoUrl` などのクライアント関連の構成を提供します。

  ```jsx Example theme={null}
  import { useClient } from '@auth0/auth0-acul-react/logout';
  function AppInfo() {
    const client = useClient();
  }
  ```
</ParamField>

<ParamField body="useOrganization" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
  このフックは、logout が組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は `null` を返します。

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

<ParamField body="usePrompt" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}>
  このフックには、認証フローにおける現在の prompt に関するデータが含まれます。

  ```jsx Example theme={null}
  import { usePrompt } from '@auth0/auth0-acul-react/logout';
  function FlowInfo() {
    const prompt = usePrompt();
  }
  ```
</ParamField>

<ParamField body="useScreen" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}>
  このフックには、設定やコンテキストを含む `logout` 画面固有の詳細が含まれます。

  ```jsx Example theme={null}
  import { useScreen } from '@auth0/auth0-acul-react/logout';
  function ScreenDebug() {
    const screen = useScreen();
  }
  ```
</ParamField>

<ParamField body="useTenant" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}>
  このフックには、`id` や関連するメタデータなど、テナントに関連するデータが含まれます。

  ```jsx Example theme={null}
  import { useTenant } from '@auth0/auth0-acul-react/logout';
  function TenantInfo() {
    const tenant = useTenant();
  }
  ```
</ParamField>

<ParamField body="useTransaction" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}>
  このフックは、アクティブな接続や現在のフローの状態など、`logout` 画面に関するトランザクション固有のデータを提供します。

  ```jsx Example theme={null}
  import { useTransaction } from '@auth0/auth0-acul-react/logout';
  function TransactionInfo() {
    const transaction = useTransaction();
  }
  ```
</ParamField>

<ParamField body="useUntrustedData" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
  このフックは、URL のクエリ文字列のパラメータなど、画面に渡された信頼できないデータを扱います。

  ```jsx Example theme={null}
  import { useUntrustedData } from '@auth0/auth0-acul-react/logout';
  function PrefilledForm() {
    const untrustedData = useUntrustedData();
  }
  ```
</ParamField>

<ParamField body="useUser" type={<span>() =&gt; <a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}>
  このフックは、`username`、`email`、利用可能な認証方法など、アクティブユーザーの詳細を提供します。

  ```jsx Example theme={null}
  import { useUser } from '@auth0/auth0-acul-react/logout';
  function UserProfile() {
    const user = useUser();
  }
  ```
</ParamField>

<ParamField body="useLogout" type={<a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/LogoutMembers">LogoutMembers</a>}>
  このフックは、`logout` 画面で使用できるすべてのメソッドとコンテキストを返します。
</ParamField>

<div id="methods">
  ## メソッド
</div>

<ParamField body="confirmLogout" type="Promise<void>">
  このメソッドは、現在のセッションのログアウトアクションを確定またはキャンセルします。

  ```jsx Example theme={null}
  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>
      </>
    );
  }
  ```

  **メソッドのパラメーター**

  <Expandable title="パラメーター">
    <ParamField body="options">
      [ConfirmLogoutOptions](/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions)。
    </ParamField>

    <ParamField body="action" type="&#x22;accept&#x22; | &#x22;deny&#x22;" required>
      ログアウトを確定する (`"accept"`) か、キャンセルする (`"deny"`) かを指定します。
    </ParamField>
  </Expandable>
</ParamField>

<div id="commonutility-hooks">
  ## 共通/ユーティリティ Hooks
</div>

<ParamField body={<a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Hooks/useAuth0Themes">useAuth0Themes</a>} type="Hooks">
  このフックは、ブランディング コンテキストからフラット化された設定を含む現在のテーマオプションを取得します。
</ParamField>

<ParamField body={<a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Hooks/useChangeLanguage">useChangeLanguage</a>} type="Hooks">
  このフックは、現在の ACUL 画面の表示言語を変更する関数を返します。
</ParamField>

<ParamField body={<a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Hooks/useCurrentScreen">useCurrentScreen</a>} type="Hooks">
  このフックは、現在の画面のコンテキストと state を取得します。
</ParamField>

<ParamField body={<a href="/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Hooks/useErrors">useErrors</a>} type="Hooks">
  このフックは、画面上のサーバー、クライアント、開発者向けのエラーを読み取り、管理します。
</ParamField>
