Organization API

Organization API を使用して、Amazon Managed Grafana ワークスペース内の組織と連携します。

注記

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

現在の組織を取得する

GET /api/org/

リクエストの例

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

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "name":"Main Org."
}

現在の組織内のすべてのユーザーを取得する

GET /api/org/users

必要なアクセス許可: スコープを持つ org.users:readアクション users:*

リクエストの例

GET /api/org/users HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "userId": 1,
    "email": "admin@localhost",
    "avatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae",
    "login": "admin",
    "role": "Admin",
    "lastSeenAt": "2019-08-09T11:02:49+02:00",
    "lastSeenAtAge": "< 1m"
  }
]

現在の組織内のすべてのユーザーを取得する (検索）

GET /api/org/users/lookup

現在の組織内のすべてのユーザーを返しますが、詳細情報は少なくなります。組織の管理者ロール、任意のフォルダ内の管理者、または任意のチームの管理者を持つユーザーがアクセスできます。主に Grafana UI によって使用され、チームメンバーを追加したり、フォルダ/ダッシュボードのアクセス許可を分割したりするときに、ユーザーのリストを提供します。

リクエストの例

GET /api/org/users/lookup HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

[
  {
    "userId": 1,
    "login": "admin",
    "avatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae"
  }
]

指定されたユーザーを更新します。

PATCH /api/org/users/:userId

必要なアクセス許可: スコープを持つ org.users.role:updateアクション users:*

リクエストの例

PATCH /api/org/users/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "role": "Viewer",
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}

現在の組織のユーザーを削除します

DELETE /api/org/users/:userId

必要なアクセス許可: スコープを持つ org.users:removeアクション users:*

リクエストの例

DELETE /api/org/users/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"User removed from organization"}

現在の組織を更新する

PUT /api/org

リクエストの例

PUT /api/org HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "name":"Main Org."
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}

現在の組織にユーザーを追加する

POST /api/org/users

必要なアクセス許可: スコープを持つ org.users:addアクション users:*

リクエストの例

POST /api/org/users HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "role": "Admin",
  "loginOrEmail": "admin"
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"User added to organization","userId":1}