

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 organização
<a name="Grafana-API-Organization"></a>

Use a API de organização para trabalhar com organizações em um espaço de trabalho do Amazon Managed Grafana.

**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](authenticating-grafana-apis.md).

## Obter a organização atual
<a name="Grafana-API-Organization-getcurrent"></a>

```
GET /api/org/
```

**Exemplo de solicitação**

```
GET /api/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

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

## Obter todos os usuários da organização atual
<a name="Grafana-API-Organization-getusers"></a>

```
GET /api/org/users
```

Permissões necessárias: a ação `org.users:read` com o escopo `users:*`

**Exemplo de solicitação**

```
GET /api/org/users 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,
    "userId": 1,
    "email": "admin@localhost",
    "avatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae",
    "login": "admin",
    "role": "Admin",
    "lastSeenAt": "2019-08-09T11:02:49+02:00",
    "lastSeenAtAge": "< 1m"
  }
]
```

## Obter todos os usuários da organização atual (pesquisa)
<a name="Grafana-API-Organization-getuserslookup"></a>

```
GET /api/org/users/lookup
```

Retorna todos os usuários da organização atual, mas com informações menos detalhadas. Acessível a usuários com um perfil de administrador da organização, administrador em qualquer pasta ou administrador de qualquer equipe. Usado principalmente pela interface do usuário do Grafana para fornecer uma lista de usuários ao adicionar membros da equipe e ao editar folder/dashboard permissões.

**Exemplo de solicitação**

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

**Exemplo de resposta**

```
HTTP/1.1 200
Content-Type: application/json

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

## Atualiza o usuário especificado
<a name="Grafana-API-Organization-updateuser"></a>

```
PATCH /api/org/users/:userId
```

Permissões necessárias: a ação `org.users.role:update` com o escopo `users:*`

**Exemplo de solicitação**

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

{
  "role": "Viewer",
}
```

**Exemplo de resposta**

```
HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}
```

## Exclui usuário na organização atual
<a name="Grafana-API-Organization-deleteuser"></a>

```
DELETE /api/org/users/:userId
```

Permissões necessárias: a ação `org.users:remove` com o escopo `users:*`

**Exemplo de solicitação**

```
DELETE /api/org/users/1 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":"User removed from organization"}
```

## Atualizar a organização atual
<a name="Grafana-API-Organization-update"></a>

```
PUT /api/org
```

**Exemplo de solicitação**

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

{
  "name":"Main Org."
}
```

**Exemplo de resposta**

```
HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}
```

## Adicionar usuário à organização atual
<a name="Grafana-API-Organization-adduser"></a>

```
POST /api/org/users
```

Permissões necessárias: a ação `org.users:add` com o escopo `users:*`

**Exemplo de solicitação**

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

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

**Exemplo de resposta**

```
HTTP/1.1 200
Content-Type: application/json

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