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.
| Endpoint | /api/v1/users |
|---|
| Method | POST |
|---|
Parâmetros
| display_name | opcional | Nome humanamente legível do usuário. |
|---|
| user_name | obrigatório | Utilizado na ação de login. |
|---|
| email | 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 | {
"meta":{
"status": 201,
"message":"Created"
},
"data":{
"id": 5,
"display_name": "Teste",
"user_name": "teste",
"email": "teste@dominio.com",
"user_group": 4,
"extension_groups": []
}
} |
|---|
| 400 | {
"meta": {
"status": 400,
"message": "Missing email param."
}
} |
|---|
| 409 | {
"meta": {
"status": 409,
"message": "User teste already exists!"
}
} |
|---|
Leitura de muitos
Recupera uma lista de usuários.
| Endpoint | /api/v1/users |
|---|
| Method | GET |
|---|
Exemplos de retorno
| 200 | {
"meta": {
"status": 200,
"message": "OK"
},
"data": [
{
"id": 5,
"display_name": "Teste",
"user_name": "teste",
"email": "teste@dominio.com",
"user_group": 4,
"extension_groups": []
},
{
"id": 6,
"display_name": "Teste2",
"user_name": "teste2",
"email": "teste2@dominio.com",
"user_group": 4,
"extension_groups": []
}
]
} |
|---|
Leitura individual
Recupera um único usuário.
| Endpoint | /api/v1/users/{user_id} |
|---|
| Method | GET |
|---|
Parâmetros
No endpoint da URL
| user_id | obrigatório | Id de um usuário já existente |
|---|
Exemplos de retorno
| 200 | {
"meta": {
"status": 200,
"message": "Created"
},
"data": {
"id": 5,
"display_name": "Teste",
"user_name": "teste",
"email": "teste@dominio.com",
"user_group": 4,
"extension_groups": []
}
} |
|---|
| 404 | {
"meta": {
"status": 404,
"message": "User not found."
}
} |
|---|
Edição
Recupera uma lista de filas.
| Endpoint | /api/v1/users/{user_id} |
|---|
| Method | PUT |
|---|
Parâmetros
No endpoint da URL
| user_id | obrigatório | Id de um usuário já existente |
|---|
Corpo em JSON
Os parâmetros são o mesmo de criar usuário, com a diferença de que são todos opcionais. Pode ser informado apenas o campo que deseja alterar.
| display_name | opcional | Nome humanamente legível do usuário. |
|---|
| user_name | opcional | Utilizado na ação de login. |
|---|
| email | 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 | {
"meta": {
"status": 200,
"message": "User updated successfully"
}
} |
|---|
| 400 | {
"meta": {
"status": 400,
"message": "User teste already exists"
}
} |
|---|
| 404 | {
"meta": {
"status": 404,
"message": "User not found."
}
} |
|---|
| 422 | {
"meta": {
"status": 422,
"message": "Archived queue can not be edited"
}
} |
|---|
Deleção
Deleta um único usuário.
| Endpoint | /api/v1/users/{user_id} |
|---|
| Method | DELETE |
|---|
Parâmetros
No endpoint da URL
| user_id | obrigatório | Id de um usuário já existente |
|---|
Exemplos de retorno
| 200 | {
"meta": {
"status": 200,
"message": "User deleted successfully"
},
"data": {
"id": 5,
"display_name": "Teste",
"user_name": "teste",
"email": "teste@dominio.com",
"user_group": 4,
"extension_groups": []
}
} |
|---|
| 404 | {
"meta": {
"status": 404,
"message": "User not found."
}
} |
|---|