Members
(route) DELETE /users
Route:
Elimina una usuaria
Authentication
Requiere token de autenticación y que la usuaria sea admin o la usuaria a eliminar
Route Parameters:
| Name |
Type |
Description |
| :uid |
String |
id o email de la usuaria a modificar
|
Response:
| Name |
Type |
Description |
| user |
Object |
|
| user._id |
String |
|
| user.email |
Object |
|
| user.roles |
Object |
|
| user.roles.admin |
Boolean |
|
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es ni admin o la misma usuaria |
| 404 |
si la usuaria solicitada no existe |
(route) GET /users
Route:
Lista usuarias
Authentication
Requiere token de autenticación y que la usuaria sea admin
Header Parameters:
| Name |
Type |
Description |
| link |
Object |
Parámetros de paginación |
| link.first |
String |
Link a la primera página |
| link.prev |
String |
Link a la página anterior |
| link.next |
String |
Link a la página siguiente |
| link.last |
String |
Link a la última página |
Query Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| page |
String |
optional |
1 |
Página del listado a consultar |
| limit |
String |
optional |
10 |
Cantitad de elementos por página |
Response:
| Name |
Type |
Description |
| users |
Array |
|
| users[]._id |
String |
|
| users[].email |
Object |
|
| users[].roles |
Object |
|
| users[].roles.admin |
Boolean |
|
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es ni admin |
(route) GET /users/:uid
Route:
| Method | Path |
|---|
| GET |
/users/:uid |
Obtiene información de una usuaria
Authentication
Requiere token de autenticación y que la usuaria sea admin o la usuaria a consultar
Route Parameters:
| Name |
Type |
Description |
| :uid |
String |
id o email de la usuaria a consultar
|
Response:
| Name |
Type |
Description |
| user |
Object |
|
| user._id |
String |
|
| user.email |
Object |
|
| user.roles |
Object |
|
| user.roles.admin |
Boolean |
|
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es ni admin o la misma usuaria |
| 404 |
si la usuaria solicitada no existe |
(route) POST /users
Route:
Crea una usuaria
Authentication
Requiere token de autenticación y que la usuaria sea admin
Body Parameters:
| Name |
Type |
Attributes |
Description |
| email |
String |
|
Correo |
| password |
String |
|
Contraseña |
| roles |
Object |
optional |
|
| roles.admin |
Boolean |
optional |
|
Response:
| Name |
Type |
Description |
| user |
Object |
|
| user._id |
String |
|
| user.email |
Object |
|
| user.roles |
Object |
|
| user.roles.admin |
Boolean |
|
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 400 |
si no se proveen `email` o `password` o ninguno de los dos |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si ya existe usuaria con ese `email` |
(route) PUT /users
Route:
Modifica una usuaria
Authentication
Requiere token de autenticación y que la usuaria sea admin o la usuaria a modificar
Body Parameters:
| Name |
Type |
Attributes |
Description |
| email |
String |
|
Correo |
| password |
String |
|
Contraseña |
| roles |
Object |
optional |
|
| roles.admin |
Boolean |
optional |
|
Route Parameters:
| Name |
Type |
Description |
| :uid |
String |
id o email de la usuaria a modificar
|
Response:
| Name |
Type |
Description |
| user |
Object |
|
| user._id |
String |
|
| user.email |
Object |
|
| user.roles |
Object |
|
| user.roles.admin |
Boolean |
|
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 400 |
si no se proveen `email` o `password` o ninguno de los dos |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es ni admin o la misma usuaria |
| 403 |
una usuaria no admin intenta de modificar sus `roles` |
| 404 |
si la usuaria solicitada no existe |