Audit Log API Reference

APIs

Custom Actions

This API should be used by third party applications to get information about author and admin activity within a BRYTER tenant.

Enable access via API Key

Before you are able to call the Audit Log API, you need to create an API Key with the correct permissions. Only BRYTER admins can create a respective API Key.

1. Open the BRYTER admin UI
2. In the sidebar click on API Keys
1. Do not use the tab within the Environment configuration as you need a tenant-level API Key
3. Click Generate API Key
4. Enter an API Key name to help you identify the API Key at a later point
5. Enter a Contact email of the person building and maintaining the integration
6. Ensure the permission Read Audit Log is checked
7. Click Generate
8. Copy the secret value and store it in a secure location
9. Close the dialog

You will use the secret value in the header of each API call as the API key.

List audit log events for a tenant

Use the following API call to obtain a list of audit log events for the tenant:

curl --request GET \
--url https://<tenant>.bryter.io/api/audit-log/tenant \
--header 'Authorization: Bearer <API Key>'

The result is paginated and the call will return the first page of audit log events. The events are ordered by latest event first.

Example response:

{
  "entries": [
    {
      "id": "ikuHfSAAQ5aUW-FsHYV8JQ",
      "actorName": "john.doe@example.com",
      "actorId": "kl_GDuQxR2C6GhdvfR4GNQ",
      "actorType": "user",
      "targetEntity": "module",
      "targetId": "s7HoQiqxSmeW2Exv_3CpJg",
      "targetValue": {
        "type": "TEST",
        "moduleName": "NDA generator",
        "moduleVersion": "36",
        "publishedModuleId": "7eaf925c-1b44-45c1-b3b2-3ed2875ec55f",
        "publishedModuleVersion": "29"
      },
      "actionType": "UPDATE",
      "eventName": "module.publishing.published",
      "description": "john.doe@example.com published module with name \"NDA generator\"(id => b3b1e842-2ab1-4a67-96d8-4c6fff70a926) as (version => 29, publishedModuleId => 7eaf925c-1b44-45c1-b3b2-3ed2875ec55f)",
      "version": "e6b0154345ad127ed8dd993e54035929b0673227",
      "correlationId": "4018082828963803097",
      "timestamp": "2024-07-08T07:14:15.321559Z"
    },
    {
      "id": "nNB_KSm_TxKnOgzme12ziw",
      "actorName": "jane.smith@example.com",
      "actorId": "X6yLcnm_ReeiVWnGFueXgA",
      "actorType": "user",
      "targetEntity": "application_permissions",
      "targetId": "sBvDRewKQ4qpG6NMd_Mo4w",
      "targetValue": {
        "applicationId": "b01bc345-ec0a-438a-a91b-a34c77f328e3",
        "applicationPermissions": "00000000-0000-0000-0000-000000000002(ENVIRONMENT) on objects:\n    4c8ae5b0-12dd-47c1-ac5d-cb4b1ecc97c0(MODULE)"
      },
      "actionType": "UPDATE",
      "eventName": "application_permissions.updated",
      "description": "jane.smith@example.com updated application permissions",
      "version": "e6b0154345ad127ed8dd993e54035929b0673227",
      "correlationId": "3885733322971434665",
      "timestamp": "2024-07-08T07:04:20.389894Z"
    }
  ],
  "pageInfo": {
    "page": 1,
    "totalPages": 1,
    "totalElements": 2
  }
}

Each event contains the following properties:

Additional filter parameters

By default every page contains maximum 20 events. You can query other pages or increase the amount of events per page with the query parameters page and entriesPerPage.

curl --request GET \
--url https://<tenant>.bryter.io/api/audit-log/tenant?page=2&entriesPerPage=100 \
--header 'Authorization: Bearer <API Key>'

You can limit the timeframe of events using the from and to query parameters. The parameter value must be an ISO 8601 timestamp including timezone information.

Depending on the format you use, you will have to URL encode the timestamp to work properly

• 2024-07-01T06:00:00.000000Z - 1st July 2024 6 AM UTC
• 2024-07-01T08:00:00.000000+02:00 - 1st July 2024 8 AM with timezone +02:00
• With URL encoding the value looks like this 2024-07-08T08%3A00%3A00.000000%2B02%3A00
• 2024-07-01T06:00Z - 1st July 2024 6 AM UTC

You can obtain all events starting from a specific point in time using from. For example to query all new events that occurred since the last time you queried the API. You can use the value of the timestamp property of an event as the input value.

Respectively, you can use to to let the API return all events that occurred up until a certain timestamp.

You can use both parameters separately or together.

curl --request GET \
--url https://<tenant>.bryter.io/api/audit-log/tenant?from=2024-07-01T06:00:00.000000Z&to=2024-07-07T06:00:00.000000Z \
--header 'Authorization: Bearer <API Key>'

Audit log event types

The BRYTER platform tracks different kinds of events and user interactions. The following list is not exhaustive as it is extended regularly for new features.

Application events

Module events

Case database and data view events

Data view events

Page events

Tenant and environment configuration