Frontegg provides automatic audit logging from the moment it’s integrated into your application, capturing key events as your customers interact with the product. User-management activities, such as logins and settings updates, are automatically logged without any additional setup required on your part.
Alongside Frontegg’s out-of-the-box logged events, you can add custom audit logs via the POST
API or our backend SDKs, preserving the standard audit event structure. Custom logs will appear to your customers in their dedicated audit section within the self-service menu.
This section lists all relevant API endpoints, organized into Management and Self-Service categories:
Management Endpoints: Require environment-level authorization and offer comprehensive control over audits resources.
Self-Service Endpoints: Accessible with a user token (JWT), allowing users with the required permissions to create, update, and delete aduits connections on their account.
https://api.frontegg.com/audits/
https://api.us.frontegg.com/audits/
https://api.ca.frontegg.com/audits/
https://api.au.frontegg.com/audits/
https://{domain}.frontegg.com/audits/
https://api.frontegg.com/audits/stats
https://api.us.frontegg.com/audits/stats
https://api.ca.frontegg.com/audits/stats
https://api.au.frontegg.com/audits/stats
https://app-xxx.frontegg.com/audits/stats
curl -i -X GET \
https://api.frontegg.com/audits/stats \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'frontegg-tenant-id: string'
https://api.frontegg.com/audits/export/csv/v2
https://api.us.frontegg.com/audits/export/csv/v2
https://api.ca.frontegg.com/audits/export/csv/v2
https://api.au.frontegg.com/audits/export/csv/v2
https://app-xxx.frontegg.com/audits/export/csv/v2
curl -i -X POST \
'https://api.frontegg.com/audits/export/csv/v2?count=0&offset=0&tenantId=string&vendorId=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-tenant-id: string' \
-d '{
"properties": [
{
"displayName": "string",
"name": "string"
}
]
}'
Retrieve audit logs for a specific account (tenant). Use optional query parameters to filter results by creation date, users, email addresses, or account (tenant) IDs. You can also sort the results and paginate through them using count
and offset
. The maximum number of audit logs per request is 200. For example: ?count=200&offset=0&sortBy=createdAt&sortDirection=desc returns audits 1-200, ?count=200&offset=200&sortBy=createdAt&sortDirection=desc returns audits 201-400
https://api.frontegg.com/audits/resources/audits/v2
https://api.us.frontegg.com/audits/resources/audits/v2
https://api.ca.frontegg.com/audits/resources/audits/v2
https://api.au.frontegg.com/audits/resources/audits/v2
https://app-xxx.frontegg.com/audits/resources/audits/v2
curl -i -X GET \
'https://api.frontegg.com/audits/resources/audits/v2?count=1&offset=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'