API de permissões de pastas - Amazon Managed Grafana
Obter permissões para uma pastaAtualizar permissões para uma pasta

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

API de permissões de pastas

Use a API de pastas para atualizar ou recuperar as permissões de uma pasta.

As permissões com folderId=-1 são as permissões padrão para usuários com as funções de Visualizador e Editor. As permissões podem ser definidas para um usuário, uma equipe ou um perfil (Visualizador ou Editor). As permissões não podem ser definidas para Administradores. Eles sempre têm acesso a tudo.

Os níveis de permissão para o campo permission são os seguintes:

  • 1 = Visualizar

  • 2 = Editar

  • 4 = Administrar

nota

Para usar uma API do Grafana com o espaço de trabalho do Amazon Managed Grafana, você deve ter um token válido da API do Grafana. Você inclui isso no campo Authorization na solicitação da API. Para obter informações sobre como criar um token para autenticar as chamadas de API, consulte Autenticação com tokens.

Obter permissões para uma pasta

GET /api/folders/:uid/permissions

Obtém todas as permissões existentes para a pasta com o uid fornecido.

Exemplo de solicitação

GET /api/folders/nErXDvCkzz/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 551

[
  {
    "id": 1,
    "folderId": -1,
    "created": "2017-06-20T02:00:00+02:00",
    "updated": "2017-06-20T02:00:00+02:00",
    "userId": 0,
    "userLogin": "",
    "userEmail": "",
    "teamId": 0,
    "team": "",
    "role": "Viewer",
    "permission": 1,
    "permissionName": "View",
    "uid": "nErXDvCkzz",
    "title": "",
    "slug": "",
    "isFolder": false,
    "url": ""
  },
  {
    "id": 2,
    "dashboardId": -1,
    "created": "2017-06-20T02:00:00+02:00",
    "updated": "2017-06-20T02:00:00+02:00",
    "userId": 0,
    "userLogin": "",
    "userEmail": "",
    "teamId": 0,
    "team": "",
    "role": "Editor",
    "permission": 2,
    "permissionName": "Edit",
    "uid": "",
    "title": "",
    "slug": "",
    "isFolder": false,
    "url": ""
  }
]

Códigos de status:

  • 200: OK

  • 401: não autorizado

  • 403: acesso negado

  • 404: pasta não encontrada

Atualizar permissões para uma pasta

POST /api/folders/:uid/permissions

Atualiza as permissões de uma pasta. Essa operação removerá as permissões existentes se elas não estiverem incluídas na solicitação.

Exemplo de solicitação

POST /api/folders/nErXDvCkzz/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
  "items": [
    {
      "role": "Viewer",
      "permission": 1
    },
    {
      "role": "Editor",
      "permission": 2
    },
    {
      "teamId": 1,
      "permission": 1
    },
    {
      "userId": 11,
      "permission": 4
    }
  ]
}

Esquema do corpo JSON:

  • itens: os itens de permissão para adicionar ou atualizar. Os itens existentes que são omitidos da lista são removidos.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message":"Folder permissions updated","id":1,"title":"Department ABC"}

Códigos de status:

  • 200: criado

  • 401: não autorizado

  • 403: acesso negado

  • 404: dashboard não encontrado