diff options
Diffstat (limited to 'doc/api/audit_events.md')
| -rw-r--r-- | doc/api/audit_events.md | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/doc/api/audit_events.md b/doc/api/audit_events.md index c4b3d99c742..e4856010b6c 100644 --- a/doc/api/audit_events.md +++ b/doc/api/audit_events.md @@ -8,7 +8,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/121) in GitLab 12.4. > - [Author Email added to the response body](https://gitlab.com/gitlab-org/gitlab/-/issues/386322) in GitLab 15.9. -> - Support for keyset pagination [added](https://gitlab.com/gitlab-org/gitlab/-/issues/367528) in GitLab 15.11. ## Instance Audit Events **(PREMIUM SELF)** @@ -19,15 +18,17 @@ To retrieve audit events using the API, you must [authenticate yourself](rest/in ### Retrieve all instance audit events +> Support for keyset pagination [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367528) in GitLab 15.11. + ```plaintext GET /audit_events ``` | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `created_after` | string | no | Return audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | +| `created_after` | string | no | Return audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `created_before` | string | no | Return audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | -| `entity_type` | string | no | Return audit events for the given entity type. Valid values are: `User`, `Group`, or `Project`. | +| `entity_type` | string | no | Return audit events for the given entity type. Valid values are: `User`, `Group`, or `Project`. | | `entity_id` | integer | no | Return audit events for the given entity ID. Requires `entity_type` attribute to be present. | This endpoint supports both offset-based and [keyset-based](rest/index.md#keyset-based-pagination) pagination. You should use keyset-based @@ -139,9 +140,14 @@ Example response: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34078) in GitLab 12.5. > - Support for keyset pagination [added](https://gitlab.com/gitlab-org/gitlab/-/issues/333968) in GitLab 15.2. +> - Also returning project audit events for projects within the given group was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/feat/337757) in GitLab 16.1 behind feature flag `audit_event_group_rollup`. Disabled by default. + +FLAG: +On self-managed GitLab, by default returning project audit events for projects within the given group is not available. To make it available, ask an administrator +to [enable the feature flag](../administration/feature_flags.md) named `audit_event_group_rollup`. On GitLab.com, this feature is not available. The feature is not ready for +production use. The Group Audit Events API allows you to retrieve [group audit events](../administration/audit_events.md#group-events). -This API cannot retrieve project audit events. A user with: @@ -153,6 +159,8 @@ pagination is recommended when requesting consecutive pages of results. ### Retrieve all group audit events +> Support for keyset pagination [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/333968) in GitLab 15.2. + ```plaintext GET /groups/:id/audit_events ``` @@ -254,18 +262,17 @@ Example response: ## Project Audit Events -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/219238) in GitLab 13.1. -> - Support for keyset pagination [added](https://gitlab.com/gitlab-org/gitlab/-/issues/367528) in GitLab 15.10. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/219238) in GitLab 13.1. The Project Audit Events API allows you to retrieve [project audit events](../administration/audit_events.md#project-events). A user with a Maintainer role (or above) can retrieve project audit events of all users. A user with a Developer role is limited to project audit events based on their individual actions. -When requesting consecutive pages of results, you should use [keyset pagination](rest/index.md#keyset-based-pagination). - ### Retrieve all project audit events +> Support for keyset pagination [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367528) in GitLab 15.10. + ```plaintext GET /projects/:id/audit_events ``` @@ -276,8 +283,8 @@ GET /projects/:id/audit_events | `created_after` | string | no | Return project audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `created_before` | string | no | Return project audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | -By default, `GET` requests return 20 results at a time because the API results -are paginated. +By default, `GET` requests return 20 results at a time because the API results are paginated. +When requesting consecutive pages of results, you should use [keyset pagination](rest/index.md#keyset-based-pagination). Read more on [pagination](rest/index.md#pagination). |