API d'organisation

Utilisez l'API Organization pour travailler avec des organisations dans un espace de travail Amazon Managed Grafana.

Note

Pour utiliser une API Grafana avec votre espace de travail Amazon Managed Grafana, vous devez disposer d'un jeton d'API Grafana valide. Vous l'incluez dans le Authorization champ de la demande d'API. Pour plus d'informations sur la création d'un jeton pour authentifier vos appels d'API, consultezAuthentifiez-vous avec des jetons.

Afficher l'organisation actuelle

GET /api/org/

Exemple de demande

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

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

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

Associer tous les utilisateurs de l'organisation actuelle

GET /api/org/users

Autorisations requises : l'org.users:readaction avec le champ d'application users:*

Exemple de demande

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

Exemple de réponse

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

Obtenir tous les utilisateurs de l'organisation actuelle (recherche)

GET /api/org/users/lookup

Renvoie tous les utilisateurs de l'organisation actuelle, mais avec des informations moins détaillées. Accessible aux utilisateurs ayant le rôle d'administrateur de l'organisation, d'administrateur de n'importe quel dossier ou d'administrateur de n'importe quelle équipe. Utilisé principalement par l'interface utilisateur de Grafana pour fournir une liste d'utilisateurs lors de l'ajout de membres de l'équipe et lors de la modification des autorisations de dossier/tableau de bord.

Exemple de demande

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

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

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

Met à jour l'utilisateur indiqué

PATCH /api/org/users/:userId

Autorisations requises : l'org.users.role:updateaction avec le champ d'application users:*

Exemple de demande

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

{
  "role": "Viewer",
}

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}

Supprime un utilisateur dans l'organisation actuelle

DELETE /api/org/users/:userId

Autorisations requises : l'org.users:removeaction avec le champ d'application users:*

Exemple de demande

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

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

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

Mettre à jour l'organisation actuelle

PUT /api/org

Exemple de demande

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

{
  "name":"Main Org."
}

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}

Ajouter un utilisateur à l'organisation actuelle

POST /api/org/users

Autorisations requises : l'org.users:addaction avec le champ d'application users:*

Exemple de demande

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

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

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

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