From 53072bcad12a252f316cb515b945c06283beed90 Mon Sep 17 00:00:00 2001 From: Vardan Torosyan Date: Fri, 30 Jul 2021 13:04:13 +0200 Subject: [PATCH] Update Settings Update documentation with the information about fine-grained access control (#37300) --- docs/sources/enterprise/settings-updates.md | 14 +++++++++++--- docs/sources/http_api/admin.md | 8 ++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/sources/enterprise/settings-updates.md b/docs/sources/enterprise/settings-updates.md index 21a0ecc8ced..f270a512afd 100644 --- a/docs/sources/enterprise/settings-updates.md +++ b/docs/sources/enterprise/settings-updates.md @@ -36,9 +36,12 @@ For example, if you provide the following `updates`: ```json { - "auth.saml": { - "enabled": "true", - "single_logout": "false" + "updates": { + "auth.saml": { + "enabled": "true", + "single_logout": "false" + } + } } ``` it would enable SAML and disable single logouts. And, if you provide the following `removals`: @@ -78,3 +81,8 @@ settings updates. If there are updates, it reloads the Grafana services affected The background job synchronizes settings between instances in high availability set-ups. So, after you perform some changes through the HTTP API, then the other instances are synchronized through the database and the background job. + +## Control access with fine-grained access control + +If you have [Fine-grained access Control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, you can control who can read or update settings. +Refer to the [Admin API]({{< relref "../http_api/admin.md#update-settings" >}}) for more information. diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md index ddbbcf008f9..fec802f73e5 100644 --- a/docs/sources/http_api/admin.md +++ b/docs/sources/http_api/admin.md @@ -192,6 +192,14 @@ Updates / removes and reloads database settings. You must provide either `update This endpoint only supports changes to `auth.saml` configuration. +#### Required permissions + +See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. + +Action | Scope +--- | --- | +settings:write | settings:**
settings:auth.saml:*
settings:auth.saml:enabled (property level) + **Example request:** ```http