diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx new file mode 100644 index 000000000..b55b14c54 --- /dev/null +++ b/dashboard/audit-logs.mdx @@ -0,0 +1,79 @@ +--- +title: "Audit logs" +description: "Track user activity across your organization" +keywords: ["audit logs", "activity tracking", "security", "compliance"] +--- + + + Audit logs functionality requires the AUDIT_LOGS entitlement and org.auditLogs.read permission. + + +Use audit logs to monitor and track all actions performed by members of your organization. Audit logs provide a comprehensive record of activities for security, compliance, and troubleshooting purposes. + +## Access audit logs + +To view your organization's audit logs: + +1. Go to **Organization Settings** in your dashboard +2. Select **Audit Logs** from the sidebar + +## Log information + +Each audit log entry displays the following information: + +| Field | Description | +| ----- | ----------- | +| Timestamp | Date and time when the action occurred | +| Actor | Email address of the user who performed the action | +| Action | Description of the action performed | +| Category | Type of resource affected (e.g., organization, member, deployment) | +| Outcome | Whether the action succeeded or failed | +| Metadata | Additional context about the action | + +Click on any log entry to expand it and view detailed information including: + +- Event ID +- Resource name +- Error messages (for failed actions) +- Full metadata + +## Filter logs + +You can filter audit logs to find specific activities: + +### Date range + +Select a preset date range to view logs from: +- Last 7 days +- Last 14 days +- Last 30 days +- Last 60 days +- Last 90 days + +### Category + +Filter logs by the type of resource: + +- Organization +- Member +- Deployment +- Preview Deployment +- API Key +- Assistant +- PDF Export +- Integration +- Billing +- Quota +- User +- Autopilot +- Audit Log +- Auth + +## Use cases + +Audit logs help you: + +- **Monitor security**: Track authentication attempts and permission changes +- **Ensure compliance**: Maintain records of all organizational activities +- **Troubleshoot issues**: Investigate failed actions and their causes +- **Track changes**: Review who made specific changes and when diff --git a/docs.json b/docs.json index 331669b40..d9038a5e8 100644 --- a/docs.json +++ b/docs.json @@ -56,7 +56,8 @@ "pages": [ "dashboard/sso", "dashboard/permissions", - "dashboard/roles" + "dashboard/roles", + "dashboard/audit-logs" ] }, "customize/custom-404-page" @@ -402,7 +403,8 @@ "pages": [ "fr/dashboard/sso", "fr/dashboard/permissions", - "fr/dashboard/roles" + "fr/dashboard/roles", + "fr/dashboard/audit-logs" ] }, "fr/customize/custom-404-page" @@ -748,7 +750,8 @@ "pages": [ "es/dashboard/sso", "es/dashboard/permissions", - "es/dashboard/roles" + "es/dashboard/roles", + "es/dashboard/audit-logs" ] }, "es/customize/custom-404-page" @@ -1094,7 +1097,8 @@ "pages": [ "zh/dashboard/sso", "zh/dashboard/permissions", - "zh/dashboard/roles" + "zh/dashboard/roles", + "zh/dashboard/audit-logs" ] }, "zh/customize/custom-404-page"