API Organisasi

Gunakan API Organisasi untuk bekerja dengan organisasi di ruang kerja Grafana yang Dikelola Amazon.

catatan

Untuk menggunakan Grafana API dengan ruang kerja Grafana Amazon Managed, Anda harus memiliki token Grafana API yang valid. Anda menyertakan ini di Authorization bidang dalam permintaan API. Untuk informasi tentang cara membuat token untuk mengautentikasi panggilan API Anda, lihatOtentikasi dengan token.

Dapatkan organisasi saat ini

GET /api/org/

Permintaan contoh

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

Contoh respon

HTTP/1.1 200
Content-Type: application/json

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

Dapatkan semua pengguna dalam organisasi saat ini

GET /api/org/users

Izin yang diperlukan: org.users:read tindakan dengan ruang lingkup users:*

Permintaan contoh

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

Contoh respon

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

Dapatkan semua pengguna dalam organisasi saat ini (pencarian)

GET /api/org/users/lookup

Mengembalikan semua pengguna dalam organisasi saat ini, tetapi dengan informasi yang kurang rinci. Dapat diakses oleh pengguna dengan peran admin org, admin di folder atau admin tim mana pun. Sebagian besar digunakan oleh Grafana UI untuk menyediakan daftar pengguna saat menambahkan anggota tim dan saat membuang izin folder/dasbor.

Permintaan contoh

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

Contoh respon

HTTP/1.1 200
Content-Type: application/json

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

Memperbarui pengguna yang diberikan

PATCH /api/org/users/:userId

Izin yang diperlukan: org.users.role:update tindakan dengan ruang lingkup users:*

Permintaan contoh

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

{
  "role": "Viewer",
}

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}

Menghapus pengguna di organisasi saat ini

DELETE /api/org/users/:userId

Izin yang diperlukan: org.users:remove tindakan dengan ruang lingkup users:*

Permintaan contoh

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

Contoh respon

HTTP/1.1 200
Content-Type: application/json

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

Perbarui organisasi saat ini

PUT /api/org

Permintaan contoh

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

{
  "name":"Main Org."
}

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}

Tambahkan pengguna ke organisasi saat ini

POST /api/org/users

Izin yang diperlukan: org.users:add tindakan dengan ruang lingkup users:*

Permintaan contoh

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

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

Contoh respon

HTTP/1.1 200
Content-Type: application/json

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