> ## 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.

> Auth0 セッションメタデータを設定する方法について説明します

# セッションメタデータを設定する

セッションメタデータを設定するには、Auth0 の [Post-Login Action](/ja/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger) と [Management API](https://auth0.com/docs/api/management/v2) を使用できます。また、[OpenID Connect バックチャネルログアウト](/ja/docs/authenticate/login/logout/back-channel-logout) トークンに含めることもできます。

<Warning>
  Auth0 セッションメタデータは安全なデータストアではないため、機密情報の保存には使用しないでください。これには、シークレットや、社会保障番号やクレジットカード番号などの機微性の高い PII が含まれます。Auth0 をご利用のお客様には、メタデータに保存するデータを評価し、アイデンティティおよびアクセス管理の目的に必要なものだけを保存することを強く推奨します。詳細については、[Auth0 の GDPR コンプライアンス](/ja/docs/secure/data-privacy-and-compliance/gdpr) を参照してください。
</Warning>

## Auth0 Management API

Management API を使用して、セッションメタデータに対する CRUD (作成、置換、更新、削除) リクエストを管理できます。

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  `/api/v2/sessions/{id}` エンドポイントの呼び出しには、`update:session` スコープを持つ [Management API アクセストークン](/ja/docs/secure/tokens/access-tokens) が必要です。
</Callout>

<div id="retrieve-existing-session-metadata">
  ### 既存のセッションメタデータを取得する
</div>

[`/api/v2/sessions/{id}`](https://auth0.com/docs/api/management/v2/sessions/get-session) エンドポイントに `GET` リクエストを送信します。

```bash lines theme={null}
GET /api/v2/sessions/{id}
```

<div id="add-or-update-existing-session-metadata">
  ### 既存のセッションメタデータを追加または更新する
</div>

[`/api/v2/sessions/{id}`](https://auth0.com/docs/api/management/v2/sessions/patch-sessions-by-id) エンドポイントに `PATCH` リクエストを送信します。

```bash lines theme={null}
PATCH /api/v2/sessions/{id}
Content-Type: application/json

{
  "session_metadata": {
    "my_metadata": "my new metadata"
  }
}
```

<div id="delete-session-metadata">
  ### セッションメタデータを削除する
</div>

[`/api/v2/sessions/{id}`](https://auth0.com/docs/api/management/v2/sessions/patch-sessions-by-id) エンドポイントに対して `PATCH` リクエストを送信します。

```bash lines theme={null}
PATCH /api/v2/sessions/{id}
Content-Type: application/json

{
  "session_metadata": {}
}
```

<div id="auth0-post-login-actions">
  ## Auth0 Post-Login Actions
</div>

[post-login Action](/ja/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger) では、`api.session` オブジェクトを使用して、セッションメタデータに対する CRUD 操作を実行できます。これにより、ユーザーやコンテキスト固有のロジックに基づいてセッションメタデータを管理できます。

<div id="retrieve-existing-session-metadata">
  ### 既存のセッションメタデータを取得する
</div>

`deviceName` メタデータを読み取るには、`event.session.metadata?.deviceName` オブジェクトを参照します。

```javascript lines theme={null}
const device = event.session.metadata?.deviceName;
```

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  `event.session.metadata` オブジェクトには、次の場所で設定されたメタデータが含まれます。
  \*同じフロー内のそれ以前の Actions
  \*セッションが再利用された場合は、以前のトランザクション
</Callout>

<div id="add-or-update-existing-metadata">
  ### 既存のメタデータを追加または更新する
</div>

セッションメタデータを更新するには、`api.session.setMetadata()` メソッドを使用します。

```javascript lines theme={null}
api.session.setMetadata("deviceName", "Auth0's iPhone");
```

変更内容は、後続の Actions の `event.session` オブジェクトですぐに利用できます。

<div id="delete-session-metadata">
  ### セッションメタデータを削除する
</div>

セッションメタデータを削除するには、次の `api.session` オブジェクトを使用します。

* `api.session.deleteMetadata("key")` は、指定したセッションメタデータを削除します

* `api.session.evictMetadata()` は、すべてのセッションメタデータを削除します

これらのオブジェクトの詳細については、次を参照してください。

* [イベントオブジェクト](/ja/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-event-object): リフレッシュトークンのイベントオブジェクトとプロパティについて確認してください。
* [API object](/ja/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object): リフレッシュトークンの API object とメソッドについて確認してください。

<div id="oidc-back-channel-logout">
  ## OIDC バックチャネルログアウト
</div>

Auth0 の [Dashboard](/ja/docs/get-started/auth0-overview/dashboard) または [Management API](https://auth0.com/docs/api/management/v2) を使用して、`logout_token` にセッションメタデータを含めるよう設定できます。

<div id="auth0-dashboard">
  ### Auth0 Dashboard
</div>

セッションメタデータを含めて OIDC バックチャネルログアウトトークンを設定するには、次の手順に従います。

1. [Dashboard > Applications](https://manage.auth0.com/#/applications) に移動し、アプリケーションを選択します。

2. **Settings** タブを選択します。

3. **OpenID Connect バックチャネルログアウト > Back-Channel Logout URL** で、`logout_tokens` を受信するアプリケーションのログアウト URI を追加します。

4. **Back-Channel Logout Initiators** を次のいずれかに設定します。

   * **選択したイニシエーターのみ** または

   * **サポートされているすべてのイニシエーター**

5. **Include Session Metadata** をオンにします。

6. **Save Changes** を選択します。

設定が完了すると、`logout_token` には保存されているすべてのセッションメタデータが含まれます。

<div id="auth0-management-api">
  ### Auth0 Management API
</div>

[`/api/v2/clients/{id}`](https://auth0.com/docs/api/management/v2/sessions/patch-sessions-by-id) エンドポイントを使用して、`logout_token` にセッションメタデータが含まれるようにアプリケーションを更新できます。

[`/api/v2/sessions/{id}`](https://auth0.com/docs/api/management/v2/sessions/patch-sessions-by-id) エンドポイントに `PATCH` リクエストを送信します:

```json lines theme={null}
"oidc_backchannel_logout": {
  "backchannel_logout_initiators": {
    "mode": "all"
  },
  "backchannel_logout_urls": [
    "https://httpdump.app/inspect/9bccf574-e55f-4b2e-9822-f37372588fc1"
  ],
  "backchannel_logout_session_metadata": {
    "include": true
  }
}
```

<div id="error-handling">
  ## エラー処理
</div>

[Dashboard > Monitoring > Logs](https://manage.auth0.com/#/logs) に移動してセッションメタデータのログイベントを確認するか、[Management API logs](/ja/docs/api/management/v2/logs/get-logs) エンドポイントを使用してログを取得できます。

* Actions によるセッションメタデータの追加または更新中にエラーが発生した場合、認証トランザクションは失敗し、エラーがコールバック URL に返されます。

失敗を示す `f` イベントコードが、対応するエラーとともに記録されます。

```json lines theme={null}
{
  "error": "access_denied",
  "error_description": "Failed to set session metadata: Invalid metadata: Metadata keys may only include letters, numbers, underscores, or hyphens",
  "state": "my-custom-state"
}
```

* Auth0 Management API を使用した セッションメタデータの管理中に失敗が発生した場合、API は `HTTP status: 400` エラーと対応するエラーメッセージを返します。

```json lines theme={null}
{
  "statusCode": 400,
  "message": "Metadata must not exceed 25 entries. Each key and value must be ≤ 255 characters."
}
```