はじめに

Codatum の監査ログは、ワークスペース上で行われた重要な操作を、監査イベントとして記録する仕組みです。 このドキュメントでは、すべてのイベントに共通する構造と、イベントごとの定義を説明します。

イベントの例

notebook.rename が1件記録されたときの全体像です。

{
  "event": {
    "uid": "0198f3a2-5c7e-7c31-9a44-6b2f0d8e1a55",
    "code": "notebook.rename",
    "time": "2026-08-14T02:31:07Z"
  },
  "scope": {
    "type": "workspace",
    "workspace_uid": "63e1be654aa70ad689601be0"
  },
  "actor": {
    "principal": {
      "type": "user",
      "uid": "63e1be654aa70ad689601bec",
      "email_addr": "taro@example.com"
    },
    "credential": { "type": "session" },
    "session": { "uid": "0193fa2c-8d4e-7a1b-9c3f-2e5d6a7b8c90" }
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      { "type": "notebook", "uid": "63e1be654aa70ad689601bf3", "name": "Sales KPI" }
    ]
  },
  "result": { "status": "success" },
  "request": {
    "uid": "0198f3a2-5c7e-7c31-9a44-6b2f0d8e1a56",
    "operation": "UpdateNotebookName",
    "path": "/api/v1/notebooks/63e1be654aa70ad689601bf3",
    "source_ip": "203.0.113.10",
    "user_agent": "Mozilla/5.0 ..."
  },
  "change": {
    "fields": [
      { "name": "name", "old": "Old", "new": "Sales KPI" }
    ]
  }
}

構成

イベントは、種類によらず共通の Envelope を持ちます。 イベント固有の情報も、内容に応じて Envelope 内の型付きフィールドに分かれて入り、 いずれにも該当しないフィールドが extra に入ります。

イベント（Envelope）
├─ event       イベント1件の識別（uid / code / time）
├─ scope       どこで起きたか（workspace / account / system）
├─ actor       誰が・どの資格情報で
├─ resource    何に対して
├─ references  操作対象以外の関連リソース
├─ context     操作の経路に関する情報
├─ result      どうなったか（success / deny / failure）
├─ request     きっかけになった HTTP リクエストの情報
├─ query       データをどう取り出そうとしたかの仕様
├─ change      操作対象自身の属性の変更
├─ grant       権限・ロール・所属の変更
└─ extra       上記のいずれにも該当しない値

event / scope / actor / resource / result はすべてのイベントに付きます。 そのため「いつ・誰が・何に・何をして・どうなったか」は、どのイベントでも同じフィールドから読み取れます。 残りのフィールドは、該当する情報を持つイベントにのみ付きます。 それぞれに何が入るかと、その使い分けは Envelope を参照してください。

イベントの種類は {ドメイン}.{アクション} 形式の event.code で識別します。

リファレンス

知りたいこと	ページ
Envelope の各フィールドの意味と使い分け	Envelope
操作した主体と、認証に使われた資格情報	Actor
操作対象のリソースと、その階層（type / path / parts）	Resource
操作対象以外の関連リソースと、その指し方	References
クエリの仕様（何を・どれだけ取り出すか）	Query
操作対象自身の属性の変更	Change
権限・ロール・所属の変更	Grant
操作の経路に関する情報	Context
複数のイベントから参照される型	共有型
イベントごとの固有フィールドの定義	概要（各ドメインページへ）
用語（状態など）	用語集

このドキュメントの読み方

• 各ドメインのページには、イベントごとに event.code / scope.type / resource.type と、 そのイベント固有のフィールド（references / query / change / grant / extra）の定義があります
• 各イベントのサンプルは、イベント固有のフィールドだけを抜粋し、残りの Envelope を ... で省略しています。 完全な形は イベントの例 を参照してください
• sensitivity の注記があるフィールドは、取り扱いに注意が必要な値を含みます。 pii は個人を特定しうる情報、confidential はそれ以外の機密情報を表します
• イベントのステータスについては 用語集 を参照してください
• イベントの種類（event.code）や enum の値、未知のフィールドは、今後追加されることがあります