Audit Log
Audit log represents a log record of actions performed by users.
Only admin or organization group admins can access the log records. Logs do not include records about changes made by Rossum representatives via internal systems. The log retention policy is set to 1 year.
Talk with a Rossum representative about enabling this feature.
Audit log
ID of the organization
Timestamp of the log record.
Username of the user that performed the action
ID of the object on which the action was performed
Type of the object on which the action was performed
Type of the action performed.
Each object_type has different actions available.
| object_type | Available actions |
|---|---|
| document | create |
| annotation | update-status |
| user | create, delete, purge, update, destroy, app_load, reset-password, change-password |
List audit logs
List audit log records for chosen objects and actions.
Only admin or organization group admins can access the log records.
curl -X GET "https://example.rossum.app/api/v1/audit_logs?object_type=document&action=change_password"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"organization_id": 406,
"timestamp": "2024-07-01T07:00:00.000000Z",
"username": "john.doe@example.com",
"object_id": 131,
"object_type": "user",
"action": "update",
"content": {
"path": "api/v1/users/131",
"method": "PATCH",
"request_id": "0aadfd75-8dcz-4e62-94d9-a23811d0d0b0",
"status_code": 200,
"details": {
"payload": {
"groups": [
"admin"
]
}
}
}
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error