正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

監査イベントAPI

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

インスタンス監査イベント

  • プラン: Premium、Ultimate
  • 提供形態: GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、インスタンス監査イベントを取得します。

APIを使用して監査イベントを取得するには、管理者として認証する必要があります。

すべてのインスタンス監査イベントを取得します

利用可能なすべてのインスタンス監査イベントを取得します。各クエリにつき最大30日に制限されます。

GET /audit_events
属性型必須説明
created_after文字列いいえ指定された時刻以降に作成された監査イベントを返します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）
created_before文字列いいえ指定された時刻以前に作成された監査イベントを返します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）
entity_type文字列いいえ指定されたエンティティタイプの監査イベントを返します。有効な値は、User、Group、Project、またはGitlab::Audit::InstanceScopeです。
entity_id整数いいえ指定されたエンティティIDの監査イベントを返します。entity_type属性が存在する必要があります。

オフセットベースのページネーションは、GitLab 17.8で非推奨になり、19.0で削除される予定です。keyset-basedページネーションを代わりに使用してください。これは破壊的な変更です。

このエンドポイントは、オフセットベースとキーセットベースのページネーションの両方をサポートしています。結果のページを連続してリクエストする場合は、キーセットページネーションを使用する必要があります。

詳細については、ページネーションを参照してください。

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/audit_events"

レスポンス例:

[
  {
    "id": 1,
    "author_id": 1,
    "entity_id": 6,
    "entity_type": "Project",
    "details": {
      "custom_message": "Project archived",
      "author_name": "Administrator",
      "author_email": "admin@example.com",
      "target_id": "flightjs/flight",
      "target_type": "Project",
      "target_details": "flightjs/flight",
      "ip_address": "127.0.0.1",
      "entity_path": "flightjs/flight"
    },
    "created_at": "2019-08-30T07:00:41.885Z"
  },
  {
    "id": 2,
    "author_id": 1,
    "entity_id": 60,
    "entity_type": "Group",
    "details": {
      "add": "group",
      "author_name": "Administrator",
      "author_email": "admin@example.com",
      "target_id": "flightjs",
      "target_type": "Group",
      "target_details": "flightjs",
      "ip_address": "127.0.0.1",
      "entity_path": "flightjs"
    },
    "created_at": "2019-08-27T18:36:44.162Z"
  },
  {
    "id": 3,
    "author_id": 51,
    "entity_id": 51,
    "entity_type": "User",
    "details": {
      "change": "email address",
      "from": "hello@flightjs.com",
      "to": "maintainer@flightjs.com",
      "author_name": "Andreas",
      "author_email": "admin@example.com",
      "target_id": 51,
      "target_type": "User",
      "target_details": "Andreas",
      "ip_address": null,
      "entity_path": "Andreas"
    },
    "created_at": "2019-08-22T16:34:25.639Z"
  },
  {
    "id": 4,
    "author_id": 43,
    "entity_id": 1,
    "entity_type": "Gitlab::Audit::InstanceScope",
    "details": {
      "author_name": "Administrator",
      "author_class": "User",
      "target_id": 32,
      "target_type": "AuditEvents::Streaming::InstanceHeader",
      "target_details": "unknown",
      "custom_message": "Created custom HTTP header with key X-arg.",
      "ip_address": "127.0.0.1",
      "entity_path": "gitlab_instance"
    },
    "ip_address": "127.0.0.1",
    "author_name": "Administrator",
    "entity_path": "gitlab_instance",
    "target_details": "unknown",
    "created_at": "2023-08-01T11:29:44.764Z",
    "target_type": "AuditEvents::Streaming::InstanceHeader",
    "target_id": 32,
    "event_type": "audit_events_streaming_instance_headers_create"
  }
]

単一インスタンス監査イベントを取得します

GET /audit_events/:id
属性型必須説明
id整数はい監査イベントのID
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/audit_events/1"

レスポンス例:

{
  "id": 1,
  "author_id": 1,
  "entity_id": 6,
  "entity_type": "Project",
  "details": {
    "custom_message": "Project archived",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "target_id": "flightjs/flight",
    "target_type": "Project",
    "target_details": "flightjs/flight",
    "ip_address": "127.0.0.1",
    "entity_path": "flightjs/flight"
  },
  "created_at": "2019-08-30T07:00:41.885Z"
}

グループ監査イベント

このAPIを使用して、グループ監査イベントを取得します。

次の権限を持つユーザー:

  • オーナーロールを持つユーザーは、すべてのユーザーのグループ監査イベントを取得できます。
  • デベロッパーまたはメンテナーロールを持つユーザーは、個々の操作に基づくグループ監査イベントに制限されます。

オフセットベースのページネーションは、GitLab 17.8で非推奨になり、19.0で削除される予定です。keyset-basedページネーションを代わりに使用してください。これは破壊的な変更です。

このエンドポイントは、オフセットベースとキーセットベースのページネーションの両方をサポートしています。結果のページネーションを連続してリクエストする場合は、キーセットページネーションを使用することをお勧めします。

すべてのグループ監査イベントを取得します

GET /groups/:id/audit_events
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
created_after文字列いいえ指定された時刻以降に作成されたグループ監査イベントを返します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ)）
created_before文字列いいえ指定された時刻以前に作成されたグループ監査イベントを返します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。

詳細については、ページネーションを参照してください。

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/groups/60/audit_events"

レスポンス例:

[
  {
    "id": 2,
    "author_id": 1,
    "entity_id": 60,
    "entity_type": "Group",
    "details": {
      "custom_message": "Group marked for deletion",
      "author_name": "Administrator",
      "author_email": "admin@example.com",
      "target_id": "flightjs",
      "target_type": "Group",
      "target_details": "flightjs",
      "ip_address": "127.0.0.1",
      "entity_path": "flightjs"
    },
    "created_at": "2019-08-28T19:36:44.162Z"
  },
  {
    "id": 1,
    "author_id": 1,
    "entity_id": 60,
    "entity_type": "Group",
    "details": {
      "add": "group",
      "author_name": "Administrator",
      "author_email": "admin@example.com",
      "target_id": "flightjs",
      "target_type": "Group",
      "target_details": "flightjs",
      "ip_address": "127.0.0.1",
      "entity_path": "flightjs"
    },
    "created_at": "2019-08-27T18:36:44.162Z"
  }
]

特定のグループ監査イベントを取得します

グループオーナーと管理者のみが使用できます。

GET /groups/:id/audit_events/:audit_event_id
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
audit_event_id整数はい監査イベントのID
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/groups/60/audit_events/2"

レスポンス例:

{
  "id": 2,
  "author_id": 1,
  "entity_id": 60,
  "entity_type": "Group",
  "details": {
    "custom_message": "Group marked for deletion",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "target_id": "flightjs",
    "target_type": "Group",
    "target_details": "flightjs",
    "ip_address": "127.0.0.1",
    "entity_path": "flightjs"
  },
  "created_at": "2019-08-28T19:36:44.162Z"
}

プロジェクト監査イベント

このAPIを使用して、プロジェクト監査イベントを取得します。

メンテナーロール（以上）を持つユーザーは、すべてのユーザーのプロジェクト監査イベントを取得できます。デベロッパーロールを持つユーザーは、個々の操作に基づくプロジェクト監査イベントに制限されます。

すべてのプロジェクト監査イベントを取得します

GET /projects/:id/audit_events
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
created_after文字列いいえ指定された時刻以降に作成されたプロジェクト監査イベントを返します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）
created_before文字列いいえ指定された時刻以前に作成されたプロジェクト監査イベントを返します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）

オフセットベースのページネーションは、GitLab 17.8で非推奨になり、19.0で削除される予定です。keyset-basedページネーションを代わりに使用してください。これは破壊的な変更です。

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。結果のページネーションを連続するページネーションをする場合は、キーセットページネーションを使用する必要があります。

詳細については、ページネーションを参照してください。

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/projects/7/audit_events"

レスポンス例:

[
  {
    "id": 5,
    "author_id": 1,
    "entity_id": 7,
    "entity_type": "Project",
    "details": {
        "change": "prevent merge request approval from committers",
        "from": "",
        "to": "true",
        "author_name": "Administrator",
        "author_email": "admin@example.com",
        "target_id": 7,
        "target_type": "Project",
        "target_details": "twitter/typeahead-js",
        "ip_address": "127.0.0.1",
        "entity_path": "twitter/typeahead-js"
    },
    "created_at": "2020-05-26T22:55:04.230Z"
  },
  {
      "id": 4,
      "author_id": 1,
      "entity_id": 7,
      "entity_type": "Project",
      "details": {
          "change": "prevent merge request approval from authors",
          "from": "false",
          "to": "true",
          "author_name": "Administrator",
          "author_email": "admin@example.com",
          "target_id": 7,
          "target_type": "Project",
          "target_details": "twitter/typeahead-js",
          "ip_address": "127.0.0.1",
          "entity_path": "twitter/typeahead-js"
      },
      "created_at": "2020-05-26T22:55:04.218Z"
  }
]

特定のプロジェクト監査イベントを取得します

プロジェクトのメンテナーロール以上のユーザーのみが利用できます。

GET /projects/:id/audit_events/:audit_event_id
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
audit_event_id整数はい監査イベントのID
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/projects/7/audit_events/5"

レスポンス例:

{
  "id": 5,
  "author_id": 1,
  "entity_id": 7,
  "entity_type": "Project",
  "details": {
      "change": "prevent merge request approval from committers",
      "from": "",
      "to": "true",
      "author_name": "Administrator",
      "author_email": "admin@example.com",
      "target_id": 7,
      "target_type": "Project",
      "target_details": "twitter/typeahead-js",
      "ip_address": "127.0.0.1",
      "entity_path": "twitter/typeahead-js"
  },
  "created_at": "2020-05-26T22:55:04.230Z"
}