API docs by Redocly

ID Gateway Audit API (0.1.0)

Download OpenAPI specification:Download

OpenAPI specification for audit export and search endpoints.

The Audit API provides:

  • User data export for GDPR access requests
  • Compliance search across audit events (admin-only)

Security

  • All endpoints require valid bearer token (JWT)
  • /audit/search requires admin/compliance role

Export audit events for the authenticated user

Exports all audit events for the authenticated user with optional filtering by action and time range.

Authorizations:
bearerAuth
query Parameters
from
string <date-time>

Start timestamp (inclusive) in ISO 8601 format

to
string <date-time>

End timestamp (inclusive) in ISO 8601 format

action
string

Filter by action type

Responses

Response samples

Content type
application/json
{
  • "user_id": "user_123",
  • "export_date": "2025-12-03T10:00:00Z",
  • "events": [
    ],
  • "total": 1
}

Search audit events across users (admin-only)

Searches audit events with optional filters for compliance and investigation workflows. Requires admin/compliance authorization.

Authorizations:
bearerAuth
query Parameters
user_id
string

Filter by user ID

action
Array of strings

Filter by action type (repeat for multiple values)

purpose
string

Filter by purpose

decision
string

Filter by decision outcome

from
string <date-time>

Start timestamp (inclusive) in ISO 8601 format

to
string <date-time>

End timestamp (inclusive) in ISO 8601 format

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1,
  • "took_ms": 12
}