...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Info |
|---|
Disponível a partir da versão 6.9.0 |
Operações básicas para manipulação de usuários.
Nos cabeçalhos dos requests, é necessário incluir uma chave "token" cujo valor seja um token de API.
Criação
Cria um novo usuário.
...
| display_name | opcional | Nome humanamente legível do usuário. |
|---|---|---|
| user_name | obrigatório | Utilizado na ação de login. |
| obrigatório | Necessário para receber alertas e notificações. | |
| password | obrigatório | Utilizado na ação de login. |
| user_group | obrigatório | Id do grupo de usuário. |
| extension_groups | opcional | Grupos de extensões gerenciados pelo usuário. |
Exemplos de retorno
| 201 | { |
|---|---|
| 400 | { |
| 409 | { |
Leitura de muitos
Recupera uma lista de usuários.
| Endpoint | /api/v1/users |
|---|---|
| Method | GET |
Exemplos de retorno
| 200 | { |
|---|
Leitura individual
Recupera um único usuário.
...
| user_id | obrigatório | Id de um usuário já existente |
|---|
Exemplos de retorno
| 200 | { |
|---|---|
| 404 | { |
Edição
Recupera uma lista de filas.
...
| display_name | opcional | Nome humanamente legível do usuário. |
|---|---|---|
| user_name | opcional | Utilizado na ação de login. |
| opcional | Necessário para receber alertas e notificações. | |
| password | opcional | Utilizado na ação de login. |
| user_group | opcional | Id do grupo de usuário. |
| extension_groups | opcional | Grupos de extensões gerenciados pelo usuário. |
Exemplos de retorno
| 200 | { |
|---|---|
| 400 | { |
| 404 | { |
| 422 | { |
Deleção
Deleta um único usuário.
...
| user_id | obrigatório | Id de um usuário já existente |
|---|
Exemplos de retorno
| 200 | { |
|---|---|
| 404 | { |