Pre-release — content may change.

Change logs

List role audit events

GET
/role_audit_events

A cursor-paginated history of role grants and revocations, newest first. Restricted to administrators and change-log viewers.

Filtering is limited to the specific keys below; any other filter[...] key returns 400 Bad Request.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

page?

Cursor pagination parameters. Used by endpoints that paginate unbounded collections via before / after opaque cursors.

filter[event_eq]?string

Restrict to a single action.

filter[entity_uuid_eq]?string

Restrict to events for a single entity (the grantee).

filter[role_resource_uuid_eq]?string

Restrict to events for roles scoped to a single resource.

filter[role_name_eq]?string

Restrict to events for a single role name.

filter[start_date]?string

Include only events on or after this date (inclusive, from the start of the day in the request time zone).

filter[end_date]?string

Include only events on or before this date (inclusive, through the end of the day in the request time zone).

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/role_audit_events"
{  "data": [    {      "type": "role_audit_events",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "attributes": {        "event": "granted",        "created_at": "2019-08-24T14:15:22Z",        "entity_type": "string",        "entity_uuid": "ccd0bbaa-1979-4620-9054-a91c61d70e41",        "entity_name": "string",        "role_name": "string",        "role_uuid": "190710f2-48df-436d-8525-9bfe3a936a06",        "role_resource_type": "string",        "role_resource_uuid": "4d86efab-5294-4bdd-bf88-16b76c9d50cd",        "role_resource_name": "string",        "grantor_type": "string",        "grantor_uuid": "5bb15396-1d93-4345-92e1-20d4c831aee9",        "grantor_name": "string",        "whodunnit": "c7a8d333-d58f-413c-8849-f7e864b301b9",        "whodunnit_name": "string",        "whodunnit_is_admin": true,        "request_id": "string",        "user_agent": "string",        "ip_address": "string"      }    }  ],  "meta": {    "page": {      "before": "string",      "after": "string",      "size": 0    }  },  "links": {    "prev": "/role_audit_events?page%5Bbefore%5D=WyIxMDAiXQ&page%5Bsize%5D=25",    "next": "/role_audit_events?page%5Bafter%5D=WyI1MCJd&page%5Bsize%5D=25"  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}