API de organización - Amazon Managed Grafana
Obtenga la organización actualObtenga todos los usuarios de la organización actualObtenga todos los usuarios de la organización actual (búsqueda)Actualiza el usuario indicadoElimina el usuario de la organización actualActualiza la organización actualAñadir un usuario a la organización actual

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de organización

Usa la API de organización para trabajar con organizaciones en un espacio de trabajo de Grafana gestionado por Amazon.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de API de Grafana válido. Lo incluyes en el Authorization campo de la solicitud de API. Para obtener información sobre cómo crear un token para autenticar tus llamadas a la API, consultaAutenticarse con fichas.

Obtenga la organización actual

GET /api/org/

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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

Obtenga todos los usuarios de la organización actual

GET /api/org/users

Permisos necesarios: la org.users:read acción con el alcance users:*

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Obtenga todos los usuarios de la organización actual (búsqueda)

GET /api/org/users/lookup

Devuelve todos los usuarios de la organización actual, pero con información menos detallada. Accesible para los usuarios con el rol de administrador de la organización, el administrador de cualquier carpeta o el administrador de cualquier equipo. Se utiliza principalmente en la interfaz de usuario de Grafana para proporcionar una lista de usuarios al añadir miembros del equipo y al editar los permisos de la carpeta/panel de control.

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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

Actualiza el usuario indicado

PATCH /api/org/users/:userId

Permisos necesarios: la org.users.role:update acción con el alcance users:*

Ejemplo de solicitud

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

{
  "role": "Viewer",
}

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}

Elimina el usuario de la organización actual

DELETE /api/org/users/:userId

Permisos necesarios: la org.users:remove acción con el alcance users:*

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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

Actualiza la organización actual

PUT /api/org

Ejemplo de solicitud

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

{
  "name":"Main Org."
}

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}

Añadir un usuario a la organización actual

POST /api/org/users

Permisos necesarios: la org.users:add acción con el alcance users:*

Ejemplo de solicitud

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

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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