mirror of https://github.com/grafana/grafana
Docs: Permissions updates (#31843)
* moved restricting access content to a separate topic * changed topic name * Update organization_roles.md * update link * content updatespull/31908/head
parent
a7e243db8a
commit
93ead2a50c
@ -0,0 +1,50 @@ |
||||
+++ |
||||
title = "Dashboard and folder permissions" |
||||
description = "Grafana Dashboard and Folder Permissions Guide " |
||||
keywords = ["grafana", "configuration", "documentation", "dashboard", "folder", "permissions", "teams"] |
||||
aliases = ["/docs/grafana/latest/permissions/dashboard_folder_permissions/"] |
||||
weight = 200 |
||||
+++ |
||||
|
||||
# Grant dashboard and folder permissions |
||||
|
||||
You can assign and remove permissions for organization roles, users, and teams for specific dashboards and dashboard folders. |
||||
|
||||
This page explains how to grant permissions to specific folders and dashboards. |
||||
|
||||
To learn more about denying access to certain Grafana users, refer to [Restricting access]({{< relref "restricting-access.md">}}). |
||||
|
||||
 |
||||
|
||||
## Permission levels |
||||
|
||||
Grafana has three permission levels that can be assigned regardless of organization role. |
||||
|
||||
- **Admin -** Can edit and create dashboards and edit permissions. Can also add, edit, and delete folders. |
||||
- **Edit -** Can edit and create dashboards. _Cannot_ edit folder/dashboard permissions, or add, edit, or delete folders. |
||||
- **View -** Can only view existing dashboards/folders. |
||||
|
||||
## Grant folder permissions |
||||
|
||||
Folder permissions apply to the folder and all dashboards contained within it. |
||||
|
||||
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and then click **Manage**. |
||||
1. Hover your mouse cursor over a folder and then click **Go to folder**. |
||||
1. Go to the **Permissions** tab, and then click **Add Permission**. |
||||
1. In **Add Permission For**, select **User**, **Team**, or one of the role options. |
||||
1. In the second box, select the user or team to add permission for. Skip this step if you selected a role option in the previous step. |
||||
1. In the third box, select the permission you want to add. |
||||
1. Click **Save**. |
||||
|
||||
## Grant dashboard permissions |
||||
|
||||
1. In the top right corner of your dashboard, click the cog icon to go to **Dashboard settings**. |
||||
1. Go to the **Permissions** tab, and then click **Add Permission**. |
||||
1. In **Add Permission For**, select **User**, **Team**, or one of the role options. |
||||
1. In the second box, select the user or team to add permission for. Skip this step if you selected a role option in the previous step. |
||||
1. In the third box, select the permission you want to add. |
||||
1. Click **Save**. |
||||
|
||||
## Edit permissions |
||||
|
||||
To change existing permissions, navigate to the permissions page as described above. Instead of clicking **Add permission**, change or delete permissions already assigned. Changes take effect immediately. |
@ -1,84 +0,0 @@ |
||||
+++ |
||||
title = "Dashboard and Folder Permissions" |
||||
description = "Grafana Dashboard and Folder Permissions Guide " |
||||
keywords = ["grafana", "configuration", "documentation", "dashboard", "folder", "permissions", "teams"] |
||||
weight = 200 |
||||
+++ |
||||
|
||||
# Dashboard and Folder Permissions |
||||
|
||||
{{< docs-imagebox img="/img/docs/v50/folder_permissions.png" max-width="500px" class="docs-image--right" >}} |
||||
|
||||
For dashboards and dashboard folders there is a **Permissions** page that makes it possible to |
||||
remove the default role based permissions for Editors and Viewers. On this page you can add and assign permissions to specific **Users** and **Teams**. |
||||
|
||||
You can assign and remove permissions for **Organization Roles**, **Users** and **Teams**. |
||||
|
||||
Permission levels: |
||||
|
||||
- **Admin**: Can edit and create dashboards and edit permissions. Can also add, edit, and delete folders. |
||||
- **Edit**: Can edit and create dashboards. **Cannot** edit folder/dashboard permissions, or add, edit, or delete folders. |
||||
- **View**: Can only view existing dashboards/folders. |
||||
|
||||
## Grant folder permissions |
||||
|
||||
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and then click **Manage**. |
||||
1. Hover your mouse cursor over a folder and then click **Go to folder**. |
||||
1. Go to the **Permissions** tab, and then click **Add Permission**. |
||||
1. In the **Add Permission For** dialog, select **User**, **Team**, or one of the role options. |
||||
1. In the second box, select the user or team to add permission for. Skip this step if you selected a role option in the previous step. |
||||
1. In the third box, select the permission you want to add. |
||||
1. Click **Save**. |
||||
|
||||
## Grant dashboard permissions |
||||
|
||||
1. In the top right corner of your dashboard, click the cog icon to go to **Dashboard settings**. |
||||
1. Go to the **Permissions** tab, and then click **Add Permission**. |
||||
1. In the **Add Permission For** dialog, select **User**, **Team**, or one of the role options. |
||||
1. In the second box, select the user or team to add permission for. Skip this step if you selected a role option in the previous step. |
||||
1. In the third box, select the permission you want to add. |
||||
1. Click **Save**. |
||||
|
||||
## Restricting Access |
||||
|
||||
The highest permission always wins so if you for example want to hide a folder or dashboard from others you need to remove the **Organization Role** based permission from the Access Control List (ACL). |
||||
|
||||
- You cannot override permissions for users with the Organization Admin role. Admins always have access to everything. |
||||
- A more specific permission with a lower permission level will not have any effect if a more general rule exists with higher permission level. You need to remove or lower the permission level of the more general rule. |
||||
|
||||
### How Grafana Resolves Multiple Permissions - Examples |
||||
|
||||
#### Example 1 (`user1` has the Editor Role) |
||||
|
||||
Permissions for a dashboard: |
||||
|
||||
- Everyone with Editor role can edit |
||||
- user1 can view |
||||
|
||||
Result: `user1` has Edit permission as the highest permission always wins. |
||||
|
||||
#### Example 2 (`user1` has the Viewer Role and is a member of `team1`) |
||||
|
||||
Permissions for a dashboard: |
||||
|
||||
- `Everyone with Viewer Role Can View` |
||||
- `user1 Can Edit` |
||||
- `team1 Can Admin` |
||||
|
||||
Result: `user1` has Admin permission as the highest permission always wins. |
||||
|
||||
#### Example 3 |
||||
|
||||
Permissions for a dashboard: |
||||
|
||||
- `user1 Can Admin (inherited from parent folder)` |
||||
- `user1 Can Edit` |
||||
|
||||
Result: You cannot override to a lower permission. `user1` has Admin permission as the highest permission always wins. |
||||
|
||||
### Summary |
||||
|
||||
- **View**: Can only view existing dashboards/folders. |
||||
- A more specific permission with lower permission level will not have any effect if a more general rule exists with higher permission level. |
||||
|
||||
For example if "Everyone with Editor Role Can Edit" exists in the ACL list then **John Doe** will still have Edit permission even after you have specifically added a permission for this user with the permission set to **View**. You need to remove or lower the permission level of the more general rule. |
@ -0,0 +1,41 @@ |
||||
+++ |
||||
title = "Restricting access" |
||||
weight = 500 |
||||
+++ |
||||
|
||||
# Restricting access |
||||
|
||||
The highest permission always wins so if you for example want to hide a folder or dashboard from others you need to remove the **Organization Role** based permission from the Access Control List (ACL). |
||||
|
||||
- You cannot override permissions for users with the Organization Admin role. Admins always have access to everything. |
||||
- A more specific permission with a lower permission level will not have any effect if a more general rule exists with higher permission level. You need to remove or lower the permission level of the more general rule. |
||||
|
||||
Here are some examples of how Grafana resolves multiple permissions. |
||||
|
||||
## Example 1 (user1 has the Editor Role) |
||||
|
||||
Permissions for a dashboard: |
||||
|
||||
- Everyone with Editor role can edit |
||||
- user1 can view |
||||
|
||||
Result: `user1` has Edit permission as the highest permission always wins. |
||||
|
||||
## Example 2 (user1 has the Viewer Role and is a member of team1) |
||||
|
||||
Permissions for a dashboard: |
||||
|
||||
- Everyone with Viewer role can view |
||||
- user1 Can Edit |
||||
- team1 Can Admin |
||||
|
||||
Result: `user1` has Admin permission as the highest permission always wins. |
||||
|
||||
## Example 3 |
||||
|
||||
Permissions for a dashboard: |
||||
|
||||
- user1 can admin (inherited from parent folder) |
||||
- user1 can edit |
||||
|
||||
Result: You cannot override to a lower permission. `user1` has Admin permission as the highest permission always wins. |
Loading…
Reference in new issue