API dell'organizzazione

Usa l'API Organization per lavorare con le organizzazioni in uno spazio di lavoro Amazon Managed Grafana.

Nota

Per utilizzare un'API Grafana con il tuo spazio di lavoro Amazon Managed Grafana, devi disporre di un token API Grafana valido. Lo includi nel Authorization campo della richiesta API. Per informazioni su come creare un token per autenticare le chiamate API, consultaAutenticazione con token.

Ottieni l'organizzazione attuale

GET /api/org/

Richiesta di esempio

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

Example response

HTTP/1.1 200
Content-Type: application/json

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

Ottieni tutti gli utenti all'interno dell'organizzazione attuale

GET /api/org/users

Autorizzazioni richieste: l'org.users:readazione con l'ambito users:*

Richiesta di esempio

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

Example response

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

Richiama tutti gli utenti all'interno dell'organizzazione corrente (ricerca)

GET /api/org/users/lookup

Restituisce tutti gli utenti all'interno dell'organizzazione corrente, ma con informazioni meno dettagliate. Accessibile agli utenti con ruolo di amministratore dell'organizzazione, amministratore in qualsiasi cartella o amministratore di qualsiasi team. Utilizzato principalmente dall'interfaccia utente di Grafana per fornire un elenco di utenti quando si aggiungono membri del team e quando si modificano le autorizzazioni di cartelle/dashboard.

Richiesta di esempio

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

Example response

HTTP/1.1 200
Content-Type: application/json

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

Aggiorna l'utente specificato

PATCH /api/org/users/:userId

Autorizzazioni richieste: l'org.users.role:updateazione con l'ambito users:*

Richiesta di esempio

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

{
  "role": "Viewer",
}

Example response

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}

Elimina l'utente nell'organizzazione corrente

DELETE /api/org/users/:userId

Autorizzazioni richieste: l'org.users:removeazione con l'ambito users:*

Richiesta di esempio

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

Example response

HTTP/1.1 200
Content-Type: application/json

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

Aggiorna l'organizzazione corrente

PUT /api/org

Richiesta di esempio

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

{
  "name":"Main Org."
}

Example response

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}

Aggiungi utente all'organizzazione corrente

POST /api/org/users

Autorizzazioni richieste: l'org.users:addazione con l'ambito users:*

Richiesta di esempio

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

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

Example response

HTTP/1.1 200
Content-Type: application/json

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