Skip to main content

List Audit Logs

Endpoint

GET /api/v1/audit

Required Role

  • Client Admin
  • Reviewer

Query Parameters

ParameterTypeDescription
action_typestringFilter by action: create, update, delete, approve
entity_typestringFilter by entity: bra, control, user, etc.
user_idUUIDFilter by specific user
start_datedateStart of date range
end_datedateEnd of date range
pageintegerPage number
page_sizeintegerItems per page

Response

{
  "data": [
    {
      "id": "log-uuid-001",
      "user_id": "user-uuid-001",
      "user_email": "admin@acme.com",
      "user_name": "John Admin",
      "action_type": "approve",
      "entity_type": "bra",
      "entity_id": "bra-uuid-001",
      "action_details": {
        "bra_name": "Q1 2026 Assessment",
        "final_comment": "Assessment approved",
        "snapshot_id": "snapshot-uuid-001"
      },
      "ip_address": "192.168.1.100",
      "user_agent": "Mozilla/5.0 ...",
      "status": "success",
      "created_at": "2026-01-16T10:00:00Z"
    }
  ],
  "pagination": { ... }
}

Audit Log Details

FieldDescription
action_typeType of action performed
entity_typeType of entity affected
entity_idID of the affected entity
action_detailsJSON with specific change information
ip_addressSource IP address
user_agentClient browser/application
statussuccess or failed

Action Types

TypeDescription
createNew record created
updateRecord modified
deleteRecord archived/deleted
approveBRA approved
cancelBRA cancelled
loginUser authentication
logoutUser signed out
access_deniedPermission denied event

Entity Types

TypeDescription
braBusiness Risk Assessment
bra_ratingRisk rating
controlKey or sub-control
mitigation_actionAction plan
legal_entityOrganization structure
userUser management
risk_appetiteAppetite configuration

Export Audit Logs

Endpoint

GET /api/v1/audit/export

Query Parameters

Same as list endpoint, plus:
ParameterTypeDescription
formatstringjson or csv

Response

Returns downloadable file in specified format.
Audit logs are immutable and cannot be modified or deleted. All entries are retained per data retention policy (minimum 7 years).