IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update Settings Update documentation with the information about fine-grained access control (#37300)

Browse Source
This commit is contained in:
Vardan Torosyan 2021-07-30 13:04:13 +02:00 committed by GitHub
parent 88c11f1cc0
commit 53072bcad1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/sources/enterprise/settings-updates.md
View File

@ -36,10 +36,13 @@ For example, if you provide the following `updates`:
```json ```json
{ {
"updates": {
"auth.saml": { "auth.saml": {
"enabled": "true", "enabled": "true",
"single_logout": "false" "single_logout": "false"
} }
}
}
``` ```
it would enable SAML and disable single logouts. And, if you provide the following `removals`: it would enable SAML and disable single logouts. And, if you provide the following `removals`:
```json ```json
@ -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 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. 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.

8
docs/sources/http_api/admin.md
View File

@ -192,6 +192,14 @@ Updates / removes and reloads database settings. You must provide either `update
This endpoint only supports changes to `auth.saml` configuration. 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:**<br>settings:auth.saml:*<br>settings:auth.saml:enabled (property level)
**Example request:** **Example request:**
```http ```http