Sign Up

Audit

GET
/audit/organizations/{organizationId}

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

organizationId*string

Organization ID

Query Parameters

page?integer

Page number of the results

Range1 <= value
Default1
limit?integer

Number of results per page

Range1 <= value <= 200
Default100
from?stringDeprecated

Deprecated alias for createdAt[gte]. From date (ISO 8601 format).

Formatdate-time
to?stringDeprecated

Deprecated alias for createdAt[lte]. To date (ISO 8601 format).

Formatdate-time
nextToken?string

Token for cursor-based pagination. When provided, takes precedence over page parameter.

id?

Filter by audit log ID.

actorId?

Filter by actor user ID.

actorEmail?

Filter by actor email.

actorApiKeyPrefix?

Filter by actor API key prefix.

actorApiKeySuffix?

Filter by actor API key suffix.

action?

Filter by action.

targetType?

Filter by target type.

targetId?

Filter by target ID.

statusCode?

Filter by HTTP status code.

createdAt?

Filter by creation timestamp.

Response Body

Paginated list of organization audit logs

application/json
  1. response
items*array<>
total*integer
page*integer
totalPages*integer
nextToken?string

Token for next page in cursor-based pagination

curl -X GET 'http://localhost:3000/audit/organizations/string'
{  "total": 6,  "nextToken": "nextToken",  "totalPages": 5,  "page": 1,  "items": [    {      "actorApiKeyPrefix": "actorApiKeyPrefix",      "metadata": {        "key": ""      },      "targetId": "targetId",      "errorMessage": "errorMessage",      "ipAddress": "ipAddress",      "actorEmail": "actorEmail",      "targetType": "targetType",      "userAgent": "userAgent",      "source": "source",      "organizationId": "organizationId",      "createdAt": "2000-01-23T04:56:07.000+00:00",      "actorId": "actorId",      "action": "action",      "id": "id",      "actorApiKeySuffix": "actorApiKeySuffix",      "statusCode": 0.8008281904610115    },    {      "actorApiKeyPrefix": "actorApiKeyPrefix",      "metadata": {        "key": ""      },      "targetId": "targetId",      "errorMessage": "errorMessage",      "ipAddress": "ipAddress",      "actorEmail": "actorEmail",      "targetType": "targetType",      "userAgent": "userAgent",      "source": "source",      "organizationId": "organizationId",      "createdAt": "2000-01-23T04:56:07.000+00:00",      "actorId": "actorId",      "action": "action",      "id": "id",      "actorApiKeySuffix": "actorApiKeySuffix",      "statusCode": 0.8008281904610115    }  ]}
GET
/audit/scenarios

Returns the supported audit log actions grouped by target type. The list is derived at runtime from the audited routes and system events, so it always reflects what can actually appear in the audit log.

Response Body

Supported audit log scenarios grouped by target type

application/json
  1. response
targets*array<>

Supported audit log scenarios grouped by target type. Derived at runtime from the audited routes and system events, sorted by target type.

curl -X GET 'http://localhost:3000/audit/scenarios'
{  "targets": [    {      "targetType": "api_key",      "actions": [        "create",        "create"      ]    },    {      "targetType": "api_key",      "actions": [        "create",        "create"      ]    }  ]}