Audit log

An audit log.

Get all audit logs

Get all audit logs of the authenticated user of the authenticated hub.

SecurityJWT
Request
query Parameters
type
integer

The type of the audit log.

  • 1 - Full
  • 2 - Auth
Enum: 1 2
created_user
string or integer

Filter the audit log list for a created user.

latest
integer [ 1 .. 100 ]

Filter the audit log list for the latest entries.

The integer value determines the number of elements displayed. The list is sorted in descending order, i.e., the newest element is at the top.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/audit
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "cf2016075a39d9134a56750ca212eb4ba7ffc968",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1688648592192
}

Get an audit log

Get an audit log.

Request
path Parameters
audit
required
string or integer

The id/hash of the audit log.

query Parameters
disposition
string or null
Default: "attachment"

The content-disposition for the requested file.

For attachment the file should be downloaded, forinline the file can be displayed.

Enum: null "attachment" "inline"
signature
required
string

The signature for the audit.

Responses
200

Successful operation

403

Forbidden

404

Not Found

422

Unprocessable Content

get/audit/{audit}
Request samples
Response samples
application/json
{
  • "success": false,
  • "error": {
    },
  • "timestamp": 1688649681648
}

Delete an audit log

Delete an audit log.

SecurityJWT
Request
path Parameters
audit
required
string or integer

The id/hash of the audit log.

Responses
200

Successful operation

404

Not Found

delete/audit/{audit}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1688650274612
}

Export an audit log

Export an audit log for an audit type.

SecurityJWT
Request
path Parameters
type
required
string

The type of the audit log.

Enum: "full" "auth"
Request Body schema: application/json

A JSON object containing audit log information.

start_time
required
string <date>

The start time of the audit log.

end_time
string <date>

The end time of the audit log.

users
Array of strings

The users of the audit log

The audit log only contains entries that were triggered by these users.

Responses
200

Successful operation

422

Unprocessable Content

post/audit/{type}/export
Request samples
application/json
{
  • "start_time": "2023-06-01",
  • "users": [
    ]
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1688650995970
}