|
|
|
@ -41,3 +41,80 @@ You use the token in all requests in the `Authorization` header, like this: |
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk |
|
|
|
|
|
|
|
|
|
The `Authorization` header value should be `Bearer <your api key>`. |
|
|
|
|
|
|
|
|
|
# Auth HTTP resources / actions |
|
|
|
|
|
|
|
|
|
## Api Keys |
|
|
|
|
|
|
|
|
|
`GET /api/auth/keys` |
|
|
|
|
|
|
|
|
|
**Example Request**: |
|
|
|
|
|
|
|
|
|
GET /api/auth/keys HTTP/1.1 |
|
|
|
|
Accept: application/json |
|
|
|
|
Content-Type: application/json |
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk |
|
|
|
|
|
|
|
|
|
**Example Response**: |
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 |
|
|
|
|
Content-Type: application/json |
|
|
|
|
|
|
|
|
|
[ |
|
|
|
|
{ |
|
|
|
|
"id": 3, |
|
|
|
|
"name": "API", |
|
|
|
|
"role": "Admin" |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"id": 1, |
|
|
|
|
"name": "TestAdmin", |
|
|
|
|
"role": "Admin" |
|
|
|
|
} |
|
|
|
|
] |
|
|
|
|
|
|
|
|
|
## Create API Key |
|
|
|
|
|
|
|
|
|
`POST /api/auth/keys` |
|
|
|
|
|
|
|
|
|
**Example Request**: |
|
|
|
|
|
|
|
|
|
POST /api/auth/keys HTTP/1.1 |
|
|
|
|
Accept: application/json |
|
|
|
|
Content-Type: application/json |
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk |
|
|
|
|
|
|
|
|
|
{ |
|
|
|
|
"name": "mykey", |
|
|
|
|
"role": "Admin" |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
JSON Body schema: |
|
|
|
|
|
|
|
|
|
- **name** – The key name |
|
|
|
|
- **role** – Sets the access level/Grafana Role for the key. Can be one of the following values: `Viewer`, `Editor`, `Read Only Editor` or `Admin`. |
|
|
|
|
|
|
|
|
|
**Example Response**: |
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 |
|
|
|
|
Content-Type: application/json |
|
|
|
|
|
|
|
|
|
{"name":"mykey","key":"eyJrIjoiWHZiSWd3NzdCYUZnNUtibE9obUpESmE3bzJYNDRIc0UiLCJuIjoibXlrZXkiLCJpZCI6MX1="} |
|
|
|
|
|
|
|
|
|
## Delete API Key |
|
|
|
|
|
|
|
|
|
`DELETE /api/auth/keys/:id` |
|
|
|
|
|
|
|
|
|
**Example Request**: |
|
|
|
|
|
|
|
|
|
DELETE /api/auth/keys/3 HTTP/1.1 |
|
|
|
|
Accept: application/json |
|
|
|
|
Content-Type: application/json |
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk |
|
|
|
|
|
|
|
|
|
**Example Response**: |
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 |
|
|
|
|
Content-Type: application/json |
|
|
|
|
|
|
|
|
|
{"message":"API key deleted"} |
|
|
|
|