Groundeddocs
ReferenceAdmin

The platform-wide audit log (platform admins and auditors)

GET/v1/admin/audit

Query Parameters

cursor?string

nextCursor from the previous page

limit?integer
Range1 <= value <= 200
Default50
action?string

An exact action (agent.publish), or a prefix ending in a dot (agent.) for every action in that group. group_mapping. is the SSO group mapping rules' changes and the memberships the rules added, changed or removed.

Match^[a-z][a-z_]*\.[a-z_]*$
Lengthlength <= 100
excludeAction?string

An action group (a prefix ending in a dot) to leave out, e.g. auth. to hide sign-ins and sign-outs.

Match^[a-z][a-z_]*\.$
Lengthlength <= 100
actorUserId?string

Only entries by this person (including their API keys)

Formatuuid
actorKind?string

Only entries by the system (system), or only the memberships SSO group mapping rules made at sign-in (group_mapping: "System (group mapping)" in the Person filter)

Value in

  • "system"
  • "group_mapping"
targetType?string
Match^[a-z_]+$
Lengthlength <= 64
from?string

Entries at or after this time

Formatdate-time
to?string

Entries before this time (exclusive)

Formatdate-time

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/admin/audit"
{  "data": {    "items": [      {        "id": 0,        "occurredAt": "2019-08-24T14:15:22Z",        "actorKind": "user",        "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",        "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",        "teamName": "string",        "teamSlug": "string",        "action": "team.member_add",        "actor": {          "kind": "user",          "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",          "displayName": "string",          "email": "string",          "apiKeyName": "string"        },        "targetType": "string",        "targetId": "string",        "targetLabel": "string",        "targetExists": true,        "parent": {          "type": "agent",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "label": "string",          "exists": true        },        "before": null,        "after": null,        "metadata": {},        "requestId": "string"      }    ],    "nextCursor": "string"  }}