diff --git a/docs/audit-logs.md b/docs/audit-logs.md new file mode 100644 index 0000000..4ebfe14 --- /dev/null +++ b/docs/audit-logs.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 14 +--- + +# Audit logs + +[[API Docs](/api/audit-logs)] +[[SDK](https://www.npmjs.com/package/@epilot/audit-logs-client)] + +Audit logs are a record of all the events which modified resources in your account. This includes changes to entities, automations, webhooks, and more. The audit logs are immutable and can be accessed by admin users in the epilot portal. + + +:::info + +Audit logs are a pricing feature for enterprise tiers. Contact our sales team to learn more about the pricing. + +::: + +![Audit log table](../static/img/audit-log-table.png) + +## Permission +To access the audit logs, you need to have the `audit_log:view` permission. This permission is only available to admin users or as a dedicated permission, which can be assigned to any user in the access management. + +## Services being audited +As epilot covers a variety of services, the audit logging is added incrementally. The following services are currently being audited. Contact our support team if you need audit logs for a service not listed here. + + +| Service | | +|---------- |---------- | +| Entity | ✅ | +| Workflow | ✅ | +| Webhook | ✅ | +| Automation| ✅ | +| Journey | ❌ | +| User | ✅ | +| Permission | ✅ | +| Blueprint | ❌ | +| Messaging | ❌ | + + +## Facade apis +Our generic entity api is audited. More specific wrappers for this apis (facade apis) are not audited to avoid duplication. \ No newline at end of file diff --git a/static/img/audit-log-table.png b/static/img/audit-log-table.png new file mode 100644 index 0000000..ca32c2c Binary files /dev/null and b/static/img/audit-log-table.png differ