From 1bbc149089e415309ef321dd2b588168a79bdc9c Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Thu, 20 Apr 2017 13:59:36 +0200 Subject: [PATCH] docs: document API calls for /auth/keys --- docs/sources/http_api/auth.md | 77 +++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md index ef62f271715..d8ded124ac5 100644 --- a/docs/sources/http_api/auth.md +++ b/docs/sources/http_api/auth.md @@ -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 `. + +# 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"}