Docs: Sync all doc changes in main to v8.0.x (#35333)

2021-06-07 18:38:48 +02:00
parent df42e49d06
commit 6362bb2f36
131 changed files with 4809 additions and 485 deletions
@@ -11,6 +11,9 @@ The Admin HTTP API does not currently work with an API Token. API Tokens are cur
 the permission of server admin, only users can be given that permission. So in order to use these API calls you will have to use Basic Auth and the Grafana user
 must have the Grafana Admin permission. (The default admin user is called `admin` and has permission to use this API.)

+> If you are running Grafana Enterprise and have [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, for some endpoints you would need to have relevant permissions.
+Refer to specific resources to understand what permissions are required.
+
 ## Fetch settings

 `GET /api/admin/settings`
@@ -260,6 +263,14 @@ Content-Type: application/json

 Create new user. 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
+--- | --- | 
+users:create | n/a
+
 **Example Request**:

 ```http
@@ -294,6 +305,14 @@ Content-Type: application/json
 Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
 Change password for a specific user.

+#### Required permissions
+
+See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
+
+Action | Scope
+--- | --- | 
+users.password:update | global:users:*
+
 **Example Request**:

 ```http
@@ -319,6 +338,14 @@ Content-Type: application/json

 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
+--- | --- | 
+users.permissions:update | global:users:*
+
 **Example Request**:

 ```http
@@ -344,6 +371,14 @@ Content-Type: application/json

 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
+--- | --- | 
+users:delete | global:users:*
+
 **Example Request**:

 ```http
@@ -404,6 +439,14 @@ Return a list of all auth tokens (devices) that the user currently have logged i

 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
+--- | --- | 
+users.authtoken:list | global:users:*
+
 **Example Request**:

 ```http
@@ -455,6 +498,14 @@ and will be required to authenticate again upon next activity.

 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
+--- | --- | 
+users.authtoken:update | global:users:*
+
 **Example Request**:

 ```http
@@ -487,6 +538,14 @@ and will be required to authenticate again upon next activity.

 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
+--- | --- | 
+users.logout | global:users:*
+
 **Example Request**:

 ```http
@@ -516,12 +575,22 @@ Content-Type: application/json

 `POST /api/admin/provisioning/notifications/reload`

+`POST /api/admin/provisioning/accesscontrol/reload`
+
 Reloads the provisioning config files for specified type and provision entities again. It won't return
 until the new provisioned entities are already stored in the database. In case of dashboards, it will stop
 polling for changes in dashboard files and then restart it with new configurations after returning.

 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 | Provision entity 
+--- | --- | --- 
+provisioning:reload | service:accesscontrol | accesscontrol
+
 **Example Request**:

 ```http