List ABAC audit events

Prev Next
Get
/api/v1/abac/audit
Defense
  • Lists ABAC audit events.
  • Returns a paginated audit log of ABAC-related actions (attribute changes, room attribute changes/removals, ABAC actions, and membership previews), filterable by time range (start, end) and optional actor, with optional sorting.
  • Membership previews are recorded only for successful new room previews from POST /api/v1/abac/rooms.evaluateMembership. Existing room previews and failed requests are not recorded.
  • Requires the ABAC and Auditing licenses, the abac-management and view-abac-admin-audit permissions.

Changelog

Version Description
9.0.0 Added the abac.membership.evaluated event, recorded by POST /api/v1/abac/rooms.evaluateMembership.
8.0.0 Added
8.5.0 Added the view-abac-admin-audit granular permission requirement.
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
start
string

start of time range (defaults to epoch if omitted)

end
string

end of time range (defaults to now if omitted)

actor
string

Filter by actor fields

offset
number

Pagination offset (default 0)

count
number

Page size (default 25)

sort
string

Sorting, typically { "ts": -1 } or { "ts": 1 }

Responses
200

OK

Success
{
  "success": true,
  "events": [
    {
      "_id": "6720f3c5c4d5e6f7a8b9c0f3",
      "t": "abac.membership.evaluated",
      "ts": "2026-10-28T15:30:02.215Z",
      "actor": {
        "type": "user",
        "_id": "aB3dE5fG7hJ9kL1mN",
        "username": "jane.doe",
        "ip": "203.0.113.10",
        "useragent": "Mozilla/5.0"
      },
      "data": [
        {
          "key": "reason",
          "value": "api"
        },
        {
          "key": "attributes",
          "value": [
            {
              "key": "clearance",
              "values": [
                "secret"
              ]
            }
          ]
        },
        {
          "key": "subjects",
          "value": [
            {
              "_id": "pQ2rS4tU6vW8xY0zA",
              "username": "john.roe"
            }
          ]
        }
      ]
    }
  ],
  "offset": 0,
  "count": 25,
  "total": 1
}
Expand All
object
success
boolean
events
Array of object
object
_id
string
ts
string
t
string

The event type, for example abac.membership.evaluated, abac.attribute.changed, abac.object.attribute.changed or abac.action.performed.

actor
object
type
string
_id
string
username
string
ip
string
useragent
string
data
Array of object

Event details as a list of key and value pairs. The keys depend on the event type.

object
key
string
value
offset
integer
count
integer
total
integer
400

Bad Request

Invalid query
{
  "success": false,
  "error": "error-invalid-query-parameters"
}
object
success
boolean
error
string
401

Unauthorized

Unauthorized login attempt
{
  "success": false,
  "error": "error-unauthorized"
}
object
success
boolean
error
string
403

Forbidden

Missing required ABAC permissions
{
  "success": false,
  "error": "error-not-authorized"
}
object
success
boolean
error
string