Admin logs

This API is not available for self-service at the moment, and you will need to contact us if you are interested in using it.

List admin logs

This endpoint allows to list admin logs on a particular project.

Records are returned sorted by createdAt date, in descending order (from most recent to least recent).

Pagination can be achieved by filtering on createdAt date.

get

/v1/project/{projectName}/admin-logs

Authorizations

Path parameters

projectNamestring · min: 1required

The case sensitive project name

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

This specifies a limit on the number of objects to return, ranging between 1 and 100. Limit is set to 10 by default

userEmailstring · email

The administrator email

userIdinteger · min: 1

The administrator id

typestring · enum

The type of action performed

Options: add, remove, update, initial

initiatorstring · enum

The entity that initiated the action

Options: administrator, identityProvider, forestAdmin

resourcestring · enum

The resource affected by the action

Options: user-project, role, team, environment

createdAt.eqstring · date-time

Value to filter by

createdAt.ltstring · date-time

Maximum value to filter by (exclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.ltestring · date-time

Minimum value to filter by (inclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.gtstring · date-time

Minimum value to filter by (exclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.gtestring · date-time

Maximum value to filter by (inclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://public-api.forestadmin.com/v1/project/{projectName}/admin-logs' \
  --header 'Authorization: Bearer JWT'

200

429

4XX

5XX

200

{
  "hasMore": false,
  "parameters": {
    "projectName": "Forest"
  },
  "data": [
    {
      "object": "adminLog",
      "id": "rbCb98wCZ1y-_zv4wrXz",
      "type": "update",
      "initiator": "administrator",
      "createdAt": "2024-03-14T15:09:26.535Z",
      "resource": "team",
      "newValue": {
        "name": "Managers UK"
      },
      "user": {
        "object": "user",
        "id": 40,
        "username": "Alice",
        "email": "[e-mail]"
      },
      "previousValue": {
        "name": "Managers"
      }
    },
    {
      "object": "adminLog",
      "id": "fHCb9IXCZ1y_Pzv4wrXz",
      "type": "add",
      "initiator": "administrator",
      "createdAt": "2024-03-14T15:11:28.148Z",
      "resource": "user-project",
      "user": {
        "object": "user",
        "id": 40,
        "username": "Alice",
        "email": "[e-mail]"
      },
      "newValue": {
        "permissionLevel": "editor",
        "user": {
          "object": "user",
          "id": 45,
          "username": "John",
          "email": "[e-mail]"
        },
        "role": {
          "object": "role",
          "name": "everything allowed"
        },
        "teams": [
          {
            "object": "team",
            "name": "Managers UK"
          }
        ]
      }
    }
  ]
}

List of admin logs