From 78b225a5c2557ab040095d4c5dfc1e898052dee9 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Thu, 29 Jul 2021 13:29:10 +0100 Subject: [PATCH] Add fine-grained access control information to the features which now support it (#37303) (#37336) * Add fine-grained access control information to the features which now support it * Mention the new permissions in Explore docs (cherry picked from commit 2c810506a57c694e54203775867779935468014d) Co-authored-by: Vardan Torosyan --- .../view-server/view-server-settings.md | 2 ++ .../view-server/view-server-stats.md | 2 ++ docs/sources/auth/ldap.md | 2 ++ docs/sources/enterprise/enhanced_ldap.md | 2 ++ docs/sources/explore/_index.md | 2 ++ docs/sources/http_api/admin.md | 16 ++++++++++++++++ 6 files changed, 26 insertions(+) diff --git a/docs/sources/administration/view-server/view-server-settings.md b/docs/sources/administration/view-server/view-server-settings.md index 3db4f2c198b..d847ad65b25 100644 --- a/docs/sources/administration/view-server/view-server-settings.md +++ b/docs/sources/administration/view-server/view-server-settings.md @@ -8,6 +8,8 @@ weight = 300 # View Grafana server settings +> Refer to [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with fine-grained permissions. + If you are a Grafana server administrator, use the Settings tab to view the settings that are applied to your Grafana server via the [Configuration]({{< relref "../configuration.md#config-file-locations" >}}) file and any environmental variables. > **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Grafana server admin]({{< relref "../../permissions/_index.md" >}}). diff --git a/docs/sources/administration/view-server/view-server-stats.md b/docs/sources/administration/view-server/view-server-stats.md index 4057846fcf6..7f5b00c8911 100644 --- a/docs/sources/administration/view-server/view-server-stats.md +++ b/docs/sources/administration/view-server/view-server-stats.md @@ -7,6 +7,8 @@ weight = 400 # View Grafana server stats +> Refer to [Fine-grained access control]({{< relref "../../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with fine-grained permissions. + If you are a Grafana server admin, then you can view useful statistics about your Grafana server in the Stats tab. > **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Grafana server admin]({{< relref "../../permissions/_index.md" >}}). diff --git a/docs/sources/auth/ldap.md b/docs/sources/auth/ldap.md index 9aabb28809c..06b6add47ea 100644 --- a/docs/sources/auth/ldap.md +++ b/docs/sources/auth/ldap.md @@ -13,6 +13,8 @@ group memberships and Grafana Organization user roles. > [Enhanced LDAP authentication]({{< relref "../enterprise/enhanced_ldap.md" >}}) is available in [Grafana Cloud Pro and Advanced](https://grafana.com/docs/grafana-cloud/) and in [Grafana Enterprise]({{< relref "../enterprise" >}}). +> Refer to [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with fine-grained permissions. + ## Supported LDAP Servers Grafana uses a [third-party LDAP library](https://github.com/go-ldap/ldap) under the hood that supports basic LDAP v3 functionality. diff --git a/docs/sources/enterprise/enhanced_ldap.md b/docs/sources/enterprise/enhanced_ldap.md index 272ab48e550..8ad81b76d68 100644 --- a/docs/sources/enterprise/enhanced_ldap.md +++ b/docs/sources/enterprise/enhanced_ldap.md @@ -11,6 +11,8 @@ The enhanced LDAP integration adds additional functionality on top of the [LDAP > Enhanced LDAP integration is only available in Grafana Enterprise. +> Refer to [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with fine-grained permissions. + ## LDAP group synchronization for teams {{< figure src="/static/img/docs/enterprise/team_members_ldap.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}} diff --git a/docs/sources/explore/_index.md b/docs/sources/explore/_index.md index f3bd67ff6a7..cf22766c563 100644 --- a/docs/sources/explore/_index.md +++ b/docs/sources/explore/_index.md @@ -9,6 +9,8 @@ weight = 90 Grafana's dashboard UI is all about building dashboards for visualization. Explore strips away the dashboard and panel options so that you can focus on the query. It helps you iterate until you have a working query and then think about building a dashboard. +> Refer to [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with fine-grained permissions. + If you just want to explore your data and do not want to create a dashboard, then Explore makes this much easier. If your data source supports graph and table data, then Explore shows the results both as a graph and a table. This allows you to see trends in the data and more details at the same time. See also: - [Query management in Explore]({{< relref "query-management.md" >}}) diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md index cfd34b27e73..ddbbcf008f9 100644 --- a/docs/sources/http_api/admin.md +++ b/docs/sources/http_api/admin.md @@ -20,6 +20,14 @@ Refer to specific resources to understand what permissions are required. Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation. +#### Required permissions + +See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. + +Action | Scope +--- | --- | +settings:read | settings:**
settings:auth.saml:*
settings:auth.saml:enabled (property level) + **Example Request**: ```http @@ -230,6 +238,14 @@ Status codes: Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation. +#### Required permissions + +See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. + +Action | Scope +--- | --- | +server.stats:read | n/a + **Example Request**: ```http