認証 API

認証 API を使用して、Amazon Managed Grafana ワークスペースの認証キーを操作します。

注記

Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な 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

クエリパラメータ：

• includeExpired — (オプション) 返される結果に期限切れキーを含めるかどうかを指定するブールパラメータ。デフォルトは 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
}

JSON 本文スキーマ：

• name — キーの名前。

• role — キーのアクセスレベル (Grafana ロール) を設定します。有効な値は Admin、Editor、または Viewer です。

• secondsToLive— キーの有効期限が切れるまでの時間を設定します。2592000 (30 日) 以下である必要があります。

レスポンスの例

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

エラーステータス：

• 400 - secondsToLiveが 2592000 より大きい

• 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"}