監査イベントAPI
- GitLab 12.4で導入されました。
- GitLab 15.9でレスポンスボディに作成者メールアドレスを追加。
インスタンス監査イベント
Audit Events API を使用すると、インスタンス監査イベントを取得できます。この API では、グループまたはプロジェクトの監査イベントを取得できません。
API を使用して監査イベントを取得するには、管理者として認証する必要があります。
すべてのインスタンス監査イベントの取得
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 属性が存在する必要があります。 |
このエンドポイントは、オフセット・ベースのページ分割とキーセット・ベースのページ分割の両方をサポートしています。連続したページの結果を要求する場合は、キーセット・ベースのページ分割を使用する必要があります。
ページ分割についての詳細はこちらをご覧ください。
curl --header "PRIVATE-TOKEN: <your_access_token>" "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 | 整数。 | yes | 監査イベントのID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "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"
}
グループ監査イベント
GitLab 15.2で導入されたキーセットのページ分割をサポートしました。
Group Audit Events API はグループの監査イベントを取得することができます。このAPIはプロジェクトの監査イベントを取得することはできません。
を持つユーザー：
- オーナーロールを持つユーザーは、すべてのユーザーのグループ監査イベントを取得できます。
- 開発者またはメンテナーのロールは、個々のアクションに基づくグループ監査イベントに制限されます。
このエンドポイントは、オフセット・ベースのページ分割とキーセット・ベースのページ分割の両方をサポートしています。連続したページの結果を要求する場合は、キーセット・ベースのページ分割を推奨します。
すべてのグループ監査イベントの取得
GitLab 15.2で導入されたキーセットのページ分割をサポートしました。
GET /groups/:id/audit_events
| 属性 | 種類 | 必須 | 説明 |
|---|---|---|---|
id | 整数/文字列 | yes | グループのIDまたはURLエンコードされたパス |
created_after | 文字列です。 | いいえ | 指定された時刻以降に作成されたグループ監査イベントを返します。フォーマットISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
|
created_before | 文字列です。 | いいえ | 指定された時刻以前に作成されたグループ監査イベントを返します。フォーマットISO 8601 (YYYY-MM-DDTHH:MM:SSZ) |
デフォルトでは、APIの結果はページ分割されているため、GET リクエストは一度に20件の結果を返します。
ページ分割についての詳細はこちらをご覧ください。
curl --header "PRIVATE-TOKEN: <your_access_token>" "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 | 整数/文字列 | yes | グループのIDまたはURLエンコードされたパス |
audit_event_id | 整数。 | yes | 監査イベントのID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "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"
}
プロジェクト監査イベント
GitLab 13.1で導入されました。
Project Audit Events API を使うと、プロジェクトの監査イベントを取得することができます。
メンテナー以上のロールを持つユーザーは、すべてのユーザーのプロジェクト監査イベントを取得できます。開発者ロールを持つユーザーは、個々のアクションに基づくプロジェクト監査イベントに制限されます。
すべてのプロジェクト監査イベントの取得
GitLab 15.10で導入されたキーセットのページ分割をサポートしました。
GET /projects/:id/audit_events
| 属性 | 種類 | 必須 | 説明 |
|---|---|---|---|
id | 整数/文字列 | yes | プロジェクトのIDまたはURLエンコードされたパス |
created_after | 文字列です。 | いいえ | 指定された時刻以降に作成されたプロジェクト監査イベントを返します。フォーマットISO 8601 (YYYY-MM-DDTHH:MM:SSZ) |
created_before | 文字列です。 | いいえ | 指定された時刻以前に作成されたプロジェクト監査イベントを返します。フォーマットISO 8601 (YYYY-MM-DDTHH:MM:SSZ) |
API の結果はページ分割されているため、デフォルトではGET リクエストは一度に 20 件の結果を返します。連続したページの結果をリクエストする場合は、キーセットのページ分割を使用する必要があります。
ページ分割についての詳細はこちらをご覧ください。
curl --header "PRIVATE-TOKEN: <your_access_token>" "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 | 整数/文字列 | yes | プロジェクトのIDまたはURLエンコードされたパス |
audit_event_id | 整数。 | yes | 監査イベントのID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "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"
}