diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx new file mode 100644 index 000000000..63e700b70 --- /dev/null +++ b/dashboard/audit-logs.mdx @@ -0,0 +1,56 @@ +--- +title: "Audit logs" +description: "Review the actions that members of your organization perform." +keywords: ["monitoring", "activity tracking", "security", "compliance"] +--- + + + Audit logs are available on [Custom plans](https://mintlify.com/pricing?ref=audit-logs). + + +Use audit logs to monitor and track actions performed by members of your organization. Audit logs provide a record of activities for security, compliance, and troubleshooting purposes. + +- **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. + +## View audit logs + +Go to the [Audit log](https://dashboard.mintlify.com/settings/organization/audit-logs) page of your dashboard to view audit logs. + +Click on any log entry to expand it and view detailed information, including: + +| Field | Description | +| ----- | ----------- | +| Timestamp | Date and time when the action occurred | +| Actor | Email address of the user who performed the action | +| Action | What action the user performed | +| Category | Type of resource affected | +| Outcome | Whether the action succeeded or failed | +| Metadata | Additional context about the action | + +### Filter logs + +Filter audit logs to find specific activities. + +**Date range**: Select a preset date range to view logs over a specific period. + +**Category**: Filter logs by the type of action. + +| Category | Description | +|------------------|--------------------------------------------------------------------| +| Organization | Organization settings updates and deletion requests. | +| Member | Team member invitations, removals, and role changes. | +| Deployment | Deployment configuration changes including custom domains, authentication, and Git sources. | +| Preview deployment | Preview deployment creation, updates, and authentication changes. | +| API key | API key and discovery API key creation and deletion. | +| Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. | +| PDF export | PDF export generation and deletion. | +| Integration | GitHub, Slack, and Discord installations and removals. | +| Billing | Subscription updates, add-on purchases, and invoice views. | +| Quota | Overage policy and alert configuration changes. | +| User | Individual user notification settings. | +| Suggestions | Suggestion configurations and repository management. | +| Audit log | Audit log views and exports. | +| Auth | Login attempts, logouts, and session creations. | 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"