API de sincronização de grupos externos

nota

Para usar uma API Grafana com seu espaço de trabalho Amazon Managed Grafana, você deve ter uma chave de API Grafana válida. Você inclui essa chave noAuthorization campo da solicitação da API. Para obter informações sobre como criar uma chave de API do Grafana, consulteUsando APIs HTTP do Grafana.

Obtenha grupos externos

GET /api/teams/:teamId/groups

Exemplo de solicitação

GET /api/teams/1/groups HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk]

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "teamId": 1,
    "groupId": "cn=editors,ou=groups,dc=grafana,dc=org"
  }
]

HTTP Status Codes

• 200 — Ok

• 401 — Não autorizado

• 403 — Acesso negado

Adicionar grupo externo

POST /api/teams/:teamId/groups

Exemplo de solicitação

POST /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk]

{
  "groupId": "cn=editors,ou=groups,dc=grafana,dc=org"
}

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{"message":"Group added to Team"}

HTTP Status Codes

• 200 — Ok

• 400 — O grupo já foi adicionado a esta equipe

• 401 — Não autorizado

• 403 — Permissão negada

• 404 — Equipe não encontrada

Remover grupo externo

DELETE /api/teams/:teamId/groups/:groupId

Exemplo de solicitação

DELETE /api/teams/1/groups/cn=editors,ou=groups,dc=grafana,dc=org HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk]

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{"message":"Team Group removed"}

HTTP Status Codes

• 200 — Ok

• 401 — Não autorizado

• 403 — Permissão negada

• 404 — Equipe não encontrada ou grupo não encontrado