組織 API - Amazon Managed Grafana
現在の組織の取得現在の組織内のすべてのユーザーの取得現在の組織内のすべてのユーザーの取得 (ルックアップ)指定ユーザーの更新現在の組織のユーザーの削除現在の組織の更新現在の組織へのユーザーの追加

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

組織 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

必要なアクセス許可: 範囲が users:* の org.users:read アクション

リクエストの例

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

必要なアクセス許可: 範囲が users:* の org.users.role:update アクション

リクエストの例

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

必要なアクセス許可: 範囲が users:* の org.users:remove アクション

リクエストの例

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

必要なアクセス許可: 範囲が users:* の org.users:add アクション

リクエストの例

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}