身份驗證 API

使用身份驗證 API 在 Amazon 受管的 Grafana 工作區中使用身份驗證金鑰。

注意

若要將 Grafana API 與您的 Amazon 受管理工作區搭配使用，您必須擁有有效的 Grafana API 權杖。您可以在 API 要求的Authorization欄位中包含此項目。如需如何建立權杖以驗證 API 呼叫的相關資訊，請參閱使用令牌進行身。

取得 API 金鑰

GET /api/auth/keys

範例請求

GET /api/auth/keys HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

查詢參數：

• IncludeEx ptional — (選用) 布林參數，指定是否在傳回的結果中包含過期的金鑰。預設值為 false。

回應範例

HTTP/1.1 200
Content-Type: application/json

[
  {"id": 3,"name": "API","role": "Admin"},
  {"id": 1,"name": "TestAdmin","role": "Admin","expiration": "2019-06-26T10:52:03+03:00"}
]

建立 API 金鑰

POST /api/auth/keys

範例請求

POST /api/auth/keys HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "name": "mykey",
  "role": "Admin",
  "secondsToLive": 86400
}

主體結構定義：

• 名稱 — 金鑰的名稱。

• 角色 — 設定金鑰的存取層級 (Grafana 角色)。有效值為 Admin、Editor 或 Viewer。

• secondsToLive— 設定金鑰到期前的時間量。它必須在 2592000（30 天）或更短時間內。

回應範例

{"name":"mykey","key":"eyJrIjoiWHZiSWd3NzdCYUZnNUtibE9obUpESmE3bzJYNDRIc0UiLCJuIjoibXlrZXkiLCJpZCI6MX1=","id":1}

錯誤狀態：

• 四百 — secondsToLive 大於

• 500 — 金鑰無法儲存在資料庫中。

刪除 API 金鑰

DELETE /api/auth/keys/:id

範例請求

DELETE /api/auth/keys/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

回應範例

HTTP/1.1 200
Content-Type: application/json

{"message":"API key deleted"}