Skip to content

Commit

Permalink
Merge pull request #479 from permitio/add-frontend-requests-to-api-lo…
Browse files Browse the repository at this point in the history
…gs-docs

Add Frontend requests to API Logs - update doc + img api log
  • Loading branch information
shuvyA authored Jan 9, 2025
2 parents 0c9368e + ecd8a35 commit 913cda8
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 42 deletions.
74 changes: 74 additions & 0 deletions docs/manage-your-account/permit-logs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
sidebar_position: 3
title: Permit logs
description: "Permit logs - track and store essential records of histories, status changes and actions for permissions."
---

import memberManagement from "/static/ui-videos/workspace-settings/member-management.mp4";
import invitingUsers from "/static/ui-videos/workspace-settings/inviting-users.mp4";
import changingMemberRoles from "/static/ui-videos/workspace-settings/changing-member-roles.mp4";

import createNewKey from "/static/ui-videos/workspace-settings/creating-new-key.mp4";
import rotatingAndDeletingKey from "/static/ui-videos/workspace-settings/rotating-and-deleting-key.mp4";

import apiLogs from "/static/ui-videos/workspace-settings/api-logs.mp4";

The Permit.io Logs provides comprehensive auditing of all administrative actions and changes made within your workspace, allowing you to track who made what changes and when.
These logs are essential for security, compliance, and troubleshooting purposes, giving you complete visibility into both dashboard activities and API-level changes across your permission management system.


## Activity Logs

The activity log screen shows the Permit.io internal audit log - **who did what** within your Permit.io workspace.
This log will only show changes made via the Permit.io dashboard.
If you wish to see changes made via the Permit.io REST API, you should check out the API log.

To view the activity log, go to the **Settings screen** on the Sidebar and select the **Activity Log** tab.

![Activity log screen](/ui-videos/workspace-settings/activity-logs.png)

:::info
Only workspace owners may view activity logs.

If you cannot see this screen, contact the workspace owner (typically the person who opened the account).
:::

### Searching and filtering activity logs

To pinpoint a particular activity in the log carried out by a team member, simply refine your search by selecting the
specific date of the action and/or filtering by the individual who made the changes. This targeted approach ensures
that tracking and reviewing internal operations remain both efficient and thorough, enhancing accountability within the team.

![Filtering activity log](/ui-videos/workspace-settings/filtering-activity-log.png)

## API Logs

To view the API log, go to the **Settings screen** on the Sidebar and select the **API Log** tab.

![API log screen](/ui-videos/workspace-settings/api-log-screen.png)


This screen enables filtering requests by response type and source. The available filter options are for these sources:

- API Log: Requests sent via API endpoints rather than through the user interface
- UI: Requests originating from your user interface
- Element: Requests sent from the Element component embedded in the your system

![API log screen](/ui-videos/workspace-settings/api-log-screen-source.png)


![API log screen](/ui-videos/workspace-settings/api-log-screen-select.png)



:::info
Only workspace owners may view the API log.

If you cannot see this screen, contact the workspace owner (typically the person who opened the account).
:::

You have the ability to delve deeper into individual API logs to examine the complete request and response details.

<video controls>
<source src={apiLogs} />
</video>
42 changes: 0 additions & 42 deletions docs/manage-your-account/workspace-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,45 +122,3 @@ Environment-level API keys are automatically generated for new environments.
<video controls>
<source src={rotatingAndDeletingKey} />
</video>

## Activity Logs

The activity log screen shows the Permit.io internal audit log - **who did what** within your Permit.io workspace.
This log will only show changes made via the Permit.io dashboard.
If you wish to see changes made via the Permit.io REST API, you should check out the API log.

To view the activity log, go to the **Settings screen** on the Sidebar and select the **Activity Log** tab.

![Activity log screen](/ui-videos/workspace-settings/activity-logs.png)

:::info
Only workspace owners may view activity logs.

If you cannot see this screen, contact the workspace owner (typically the person who opened the account).
:::

### Searching and filtering activity logs

To pinpoint a particular activity in the log carried out by a team member, simply refine your search by selecting the
specific date of the action and/or filtering by the individual who made the changes. This targeted approach ensures
that tracking and reviewing internal operations remain both efficient and thorough, enhancing accountability within the team.

![Filtering activity log](/ui-videos/workspace-settings/filtering-activity-log.png)

## API Logs

To view the API log, go to the **Settings screen** on the Sidebar and select the **API Log** tab.

![API log screen](/ui-videos/workspace-settings/api-log-screen.png)

:::info
Only workspace owners may view the API log.

If you cannot see this screen, contact the workspace owner (typically the person who opened the account).
:::

You have the ability to delve deeper into individual API logs to examine the complete request and response details.

<video controls>
<source src={apiLogs} />
</video>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/ui-videos/workspace-settings/api-log-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 913cda8

Please sign in to comment.