This section provides detailed information about the Audit Logs API, which allows you to track and monitor security events in your system.
Overview
The Audit Logs API is designed to help you keep a record of all security-related activities within your application. It provides a comprehensive log of actions taken by users, system events, and any other security-relevant activities.
Endpoints
List Audit Logs
The /api/management/security/logs endpoint allows you to retrieve a list of audit logs. This endpoint supports filtering and pagination.
- Path:
/api/management/security/logs - Method:
GET - Query Parameters:
page: The page number for pagination (default: 1)limit: The number of records per page (default: 10)filter: Filter the logs based on specific criteria (e.g.,user_id=123,event_type=login)
Get Audit Log Details
The /api/management/security/logs/{id} endpoint allows you to retrieve the details of a specific audit log entry.
- Path:
/api/management/security/logs/{id} - Method:
GET - Parameters:
id: The unique identifier of the audit log entry
Example Usage
Here's an example of how to retrieve the first page of audit logs:
GET /api/management/security/logs?page=1&limit=10
This request would return a list of audit logs, up to 10 records per page.
Resources
For more information about the Audit Logs API, please refer to the following resources: