2. Usuarios
Este modulo es el encargado de gestionar los usuarios del sistema, se exponen los siguientes recursos:
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/users | Lista de usuarios del sistema |
| POST | /api/users | Creación de usuarios |
| GET | /api/users/{userId} | Visualización de usuario |
| PATCH | /api/users/{userId} | Modificación de datos de un usuario |
| DELETE | /api/users/{userId} | Eliminación de un usuario |
Ejemplo de cuerpo json POST
{
"code": "nw_002",
"role": "Super Admin",
"client_id": 2,
"provider_id": 3,
"first_name": "Usuario2 ",
"last_name": "Prueba2",
"email": "user2@test2.com",
"is_active": "1",
"password": "12345678",
"password_confirmation": "12345678",
"contact_data": {
"email": null,
"web": null,
"phone_1": null,
"phone_2": null,
"address": null
},
"custom_properties": {
"custom_13": null,
"custom_15": null,
"custom_24": null
}
}
2.1 Parámetros
| Nombre | Modo | Tipo | Descripción |
|---|---|---|---|
| code | Optional | String | Admite letras, números, guiones y guiones bajos pero no espacios |
| client_id | Optional | Numeric | id foráneo de cliente existente |
| first_name | Required | String | Nombres |
| last_name | Required | String | Apellidos |
| Required | String - Email | Email diferente a los ya registrados | |
| password | Required | String | contraseña con un minimo de 8 caracteres |
| password_confirmation | Required | String | contraseña de confirmación de password para su validación |
| role | Required | String | nombre de rol ya existente |
| is_active | Required | Boolean | Se encuentra activo el usuario? si está en "true", puede ingresar al sistema, caso contrario no. |
| provider_id | Optional | Numeric | id foráneo de proveedor |
| contact_data.email | Optional | String - Email | Email de contacto |
| contact_data.web | Optional | Url | Dirección Web |
| contact_data.phone_1 | Optional | String | Teléfono 1 |
| contact_data.phone_2 | Optional | String | Teléfono 2 |
| contact_data.address | Optional | String | Dirección |
| custom_properties | Optional | Array | Parámetros custom adicionales |