Audit Service

Produces: None

Consumes: Auditable Event Occurred [event]

Overview

The Audit service is responsible for persisting auditable events that are generated by the Link Cloud services.

The service provides REST endpoints for managing and retrieving audit logs. These endpoints allow for the creation, retrieval, and deletion of audit records, facilitating comprehensive tracking of system activities.

flowchart LR
nAuditService_3DEF243A["Service: Audit Service"]
  nAuditableEventOccurred_2E7ED8D7["Event: AuditableEventOccurred"] -->|consumed by| nAuditService_3DEF243A
  subgraph nCompliance_DBAE25D_domain["Domain: Compliance"]
    nAuditService_3DEF243A
    nAuditableEventOccurred_2E7ED8D7
  end

Common Configurations

Database Schema

dbo.__EFMigrationsHistory (array, Required: No)

Name	Type	Required?	Length
MigrationId	string	Yes	150
ProductVersion	string	Yes	32

dbo.AuditLogs (array, Required: No)

Name	Type	Required?	Length
Id	integer	Yes
AuditId	string	Yes
FacilityId	string	No	150
ServiceName	string	No	100
CorrelationId	string	No
EventDate	string (date-time)	No
UserId	string	No	450
User	string	No
Action	string	No	50
Resource	string	No
Notes	string	No
CreatedOn	string (date-time)	Yes
CreatedBy	string	No
PropertyChanges	string	No

OpenAPI Operations

GET /api/audit/info

Route Parameters

None

Query Parameters

None

GET /api/audit

Returns a list of audit events based on filters provided.

Route Parameters

None

Query Parameters

Name	Required?	Description
searchText	No
facility	No
correlationId	No
service	No
action	No
user	No
sortBy	No	Options: FacilityId, Action, ServiceName, Resource, CreatedOn
sortOrder	No	Ascending = 0, Descending = 1, defaults to Ascending
pageSize	No
pageNumber	No

GET /api/audit/{auditId}

Returns an audit event with the provided Audit Log Id.

Route Parameters

Name	Type	Required?	Description
auditId		Yes

Query Parameters

None

GET /api/audit/facility/{facilityId}

Returns a list of audit events for a specific facility.

Route Parameters

Name	Type	Required?	Description
facilityId		Yes

Query Parameters

Name	Required?	Description
sortBy	No	Options: FacilityId, Action, ServiceName, Resource, CreatedOn
sortOrder	No	Ascending = 0, Descending = 1, defaults to Ascending
pageNumber	No
pageSize	No

GET /health

Health check endpoint

Route Parameters

None

Query Parameters

None

Relationships

flowchart LR
nAuditService_3DEF243A["Service: Audit Service"]
  nAuditableEventOccurred_2E7ED8D7["Event: AuditableEventOccurred"] -->|consumed by| nAuditService_3DEF243A
  subgraph nCompliance_DBAE25D_domain["Domain: Compliance"]
    nAuditService_3DEF243A
    nAuditableEventOccurred_2E7ED8D7
  end