ユーザー API - Amazon Managed Grafana

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ユーザー API

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

注記

Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。これは API リクエストの Authorizationフィールドに含めます。API コールを認証するトークンを作成する方法については、「」を参照してくださいトークンによる認証

ユーザーがメンバーであるチームを取得する

GET /api/user/teams

リクエストの例

GET /api/user/teams HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200 Content-Type: application/json [ { "id": 1, "orgId": 1, "name": "MyTestTeam", "email": "", "avatarUrl": "\/avatar\/3f49c15916554246daa714b9bd0ee3", "memberCount": 1 } ]

スナップショットのリストを取得する

実際のユーザーの指定されたダッシュボードをスターします。

POST /api/user/stars/dashboard/:dashboardId

リクエストの例

POST /api/user/stars/dashboard/1 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200 Content-Type: application/json {"message":"Dashboard starred!"}

ダッシュボードのスターリングを解除する

実際のユーザーの特定の Dashboard のスターリングを削除します。

DELETE /api/user/stars/dashboard/:dashboardId

リクエストの例

DELETE /api/user/stars/dashboard/1 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200 Content-Type: application/json {"message":"Dashboard unstarred"}

実際のユーザーの認証トークンを取得する

GET /api/user/auth-tokens

リクエストの例

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

レスポンスの例

HTTP/1.1 200 Content-Type: application/json [ { "id": 361, "isActive": true, "clientIp": "127.0.0.1", "browser": "Chrome", "browserVersion": "72.0", "os": "Linux", "osVersion": "", "device": "Other", "createdAt": "2019-03-05T21:22:54+01:00", "seenAt": "2019-03-06T19:41:06+01:00" }, { "id": 364, "isActive": false, "clientIp": "127.0.0.1", "browser": "Mobile Safari", "browserVersion": "11.0", "os": "iOS", "osVersion": "11.0", "device": "iPhone", "createdAt": "2019-03-06T19:41:19+01:00", "seenAt": "2019-03-06T19:41:21+01:00" } ]

実際のユーザーの認証トークンを取り消す

POST /api/user/revoke-auth-token

実際のユーザーの指定された認証トークン (デバイス) を取り消します。発行された認証トークン (デバイス) のユーザーはログインしなくなり、次のアクティビティで再度認証する必要があります。

リクエストの例

POST /api/user/revoke-auth-token HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "authTokenId": 364 }

レスポンスの例

HTTP/1.1 200 Content-Type: application/json { "message": "User auth token revoked" }