Audit API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)
Download OpenAPI specification:Download
The audit service implements the an organization log service, to observe all actions inside an organization
API_Token
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | API-TOKEN |
Personal-Access-Token
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | Personal-Access-Token |
ListEvents
List all logged organization actions for passed organization id
query Parameters
| organization_id | integer |
| limit | integer [ 1 .. 50 ] Default: 10 limits audit list output to passed amount. |
| offset | integer Default: 0 defines the offset for pagination |
Responses
Response samples
- 200
{- "events": [
- {
- "affectedUser": null,
- "creator": {
- "id": 0,
- "name": "string",
- "type": "string"
}, - "data": "string",
- "id": 0,
- "organizationID": 0,
- "service": "string",
- "timestamp": null,
- "type": "string",
- "user": null
}
], - "totalEvents": 0
}