public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Prettify markdown in docs in v8.1.x (#37647)

Browse Source
This commit is contained in:
Connor Lindsey
2021-08-06 09:20:26 -06:00
committed by GitHub
parent b3570b823d
commit 45c67c5b82
304 changed files with 3230 additions and 2994 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/http_api/admin.md
+34 -34
View File
@@ -12,7 +12,7 @@ the permission of server admin, only users can be given that permission. So in o
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.
> Refer to specific resources to understand what permissions are required.
## Fetch settings
@@ -24,9 +24,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
settings:read | settings:**<br>settings:auth.saml:*<br>settings:auth.saml:enabled (property level)
| Action | Scope |
| ------------- | ----------------------------------------------------------------------------------- |
| settings:read | settings:\*_<br>settings:auth.saml:_<br>settings:auth.saml:enabled (property level) |
**Example Request**:
@@ -196,9 +196,9 @@ This endpoint only supports changes to `auth.saml` configuration.
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)
| Action | Scope |
| -------------- | ----------------------------------------------------------------------------------- |
| settings:write | settings:\*_<br>settings:auth.saml:_<br>settings:auth.saml:enabled (property level) |
**Example request:**
@@ -250,9 +250,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
server.stats:read | n/a
| Action | Scope |
| ----------------- | ----- |
| server.stats:read | n/a |
**Example Request**:
@@ -292,9 +292,9 @@ Create new user. Only works with Basic Authentication (username and password). S
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:create | n/a
| Action | Scope |
| ------------ | ----- |
| users:create | n/a |
**Example Request**:
@@ -334,9 +334,9 @@ Change password for a specific user.
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users.password:update | global:users:*
| Action | Scope |
| --------------------- | --------------- |
| users.password:update | global:users:\* |
**Example Request**:
@@ -367,9 +367,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users.permissions:update | global:users:*
| Action | Scope |
| ------------------------ | --------------- |
| users.permissions:update | global:users:\* |
**Example Request**:
@@ -400,9 +400,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:delete | global:users:*
| Action | Scope |
| ------------ | --------------- |
| users:delete | global:users:\* |
**Example Request**:
@@ -468,9 +468,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users.authtoken:list | global:users:*
| Action | Scope |
| -------------------- | --------------- |
| users.authtoken:list | global:users:\* |
**Example Request**:
@@ -527,9 +527,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users.authtoken:update | global:users:*
| Action | Scope |
| ---------------------- | --------------- |
| users.authtoken:update | global:users:\* |
**Example Request**:
@@ -567,9 +567,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope
--- | --- |
users.logout | global:users:*
| Action | Scope |
| ------------ | --------------- |
| users.logout | global:users:\* |
**Example Request**:
@@ -612,9 +612,9 @@ Only works with Basic Authentication (username and password). See [introduction]
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
Action | Scope | Provision entity
--- | --- | ---
provisioning:reload | service:accesscontrol | accesscontrol
| Action | Scope | Provision entity |
| ------------------- | --------------------- | ---------------- |
| provisioning:reload | service:accesscontrol | accesscontrol |
**Example Request**: