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_68C0DB5["Service: Audit Service"]
nAuditableEventOccurred_AF8D6F7["Event: AuditableEventOccurred"] -->|consumed by| nAuditService_68C0DB5
subgraph nCompliance_11EAF98F_domain["Domain: Compliance"]
nAuditService_68C0DB5
nAuditableEventOccurred_AF8D6F7
end
Common Configurations
- Swagger
- Azure App Configuration
- Kafka Configuration
- Kafka Consumer Retry Configuration
- Service Registry Configuration
- CORS Configuration
- Token Service Configuration
- Service Authentication
- SQL Server Database Configuration
Database Schema
| Name | Type | Required? | Length |
|---|---|---|---|
| MigrationId | string | Yes | 150 |
| ProductVersion | string | Yes | 32 |
| 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
Route Parameters
None
Query Parameters
None
Returns a list of audit events based on filters provided.
Route Parameters
None
Query Parameters
| Name | Type | 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 |
Returns an audit event with the provided Audit Log Id.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| auditId | Yes |
Query Parameters
None
Returns a list of audit events for a specific facility.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| facilityId | Yes |
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| sortBy | No | Options: FacilityId, Action, ServiceName, Resource, CreatedOn | |
| sortOrder | No | Ascending = 0, Descending = 1, defaults to Ascending | |
| pageNumber | No | ||
| pageSize | No |
Health check endpoint
Route Parameters
None
Query Parameters
None
Relationships
flowchart LR
nAuditService_68C0DB5["Service: Audit Service"]
nAuditableEventOccurred_AF8D6F7["Event: AuditableEventOccurred"] -->|consumed by| nAuditService_68C0DB5
subgraph nCompliance_11EAF98F_domain["Domain: Compliance"]
nAuditService_68C0DB5
nAuditableEventOccurred_AF8D6F7
end