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/user.md
+24 -24
View File
@@ -8,8 +8,8 @@ aliases = ["/docs/grafana/latest/http_api/user/"]
# User 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.
## Search Users
`GET /api/users?perpage=10&page=1`
@@ -18,9 +18,9 @@ Refer to specific resources to understand what permissions are required.
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:read | global:users:*
| Action | Scope |
| ---------- | --------------- |
| users:read | global:users:\* |
**Example Request**:
@@ -73,9 +73,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:read | global:users:*
| Action | Scope |
| ---------- | --------------- |
| users:read | global:users:\* |
**Example Request**:
@@ -134,9 +134,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:read | users:*
| Action | Scope |
| ---------- | -------- |
| users:read | users:\* |
**Example Request**:
@@ -146,6 +146,7 @@ Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
```
Requires basic authentication and that the authenticated user is a Grafana Admin.
**Example Response**:
@@ -179,9 +180,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:read | global:users:*
| Action | Scope |
| ---------- | --------------- |
| users:read | global:users:\* |
**Example Request using the email as option**:
@@ -234,9 +235,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:write | users:*
| Action | Scope |
| ----------- | -------- |
| users:write | users:\* |
**Example Request**:
@@ -273,9 +274,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users:read | users:*
| Action | Scope |
| ---------- | -------- |
| users:read | users:\* |
**Example Request**:
@@ -311,9 +312,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
Action | Scope
--- | --- |
users.teams:read | users:*
| Action | Scope |
| ---------------- | -------- |
| users.teams:read | users:\* |
**Example Request**:
@@ -344,7 +345,6 @@ Content-Type: application/json
]
```
## User
## Actual User