Documentación API
User
POST/users
Descripción:
Este endpoint permite crear un nuevo usuario dentro de la plataforma. La información requerida incluye datos básicos como nombre, apellidos, correo electrónico, y una contraseña segura. También se puede asociar el usuario a una empresa mediante el parámetro businessName.
Request
Json
Response
Json
Propiedades del registro
| Propiedad | Tipo | Descripción |
|---|---|---|
| businessName | string | Nombre de la empresa o razón social | solo para el primer registro |
| name | string | Primer nombre del usuario o contacto principal |
| lastName | string | Apellido del usuario o contacto principal |
| string | Correo electrónico del usuario o contacto principal | |
| password | string | Contraseña del usuario para acceder al sistema |
Propiedades de la respuesta
| Propiedad | Tipo | Descripción |
|---|---|---|
| lastAction | string | Última acción realizada en el sistema (ej. "/user") |
| success | boolean | Indica si la petición fue exitosa (true) o fallida (false) |
| titleResponse | string | Título descriptivo de la respuesta (ej. "Petición realizada con éxito") |
| textResponse | string | Texto adicional explicativo de la respuesta (vacío si no aplica) |
| data | object | Objeto que contiene los datos relevantes del usuario o entidad solicitada |
| data.companyId | string | Identificador único de la empresa asociada al usuario |
| data.firstName | string | Primer nombre del usuario |
| data.lastName | string | Apellido del usuario |
| data.email | string | Correo electrónico del usuario |
| data.username | string | Nombre de usuario o correo electrónico utilizado para el inicio de sesión |
| data.identification | string | null | Número de identificación del usuario (puede ser null) |
| data.dateOfBirth | string | null | Fecha de nacimiento del usuario (puede ser null) |
| data.lastLogin | string | null | Fecha y hora del último inicio de sesión del usuario (puede ser null) |
| data.accessIp | string | null | IP desde la cual el usuario accedió por última vez (puede ser null) |
| data.photoPath | string | null | Ruta de la foto del perfil del usuario (puede ser null) |
| data.roles | array | null | Lista de roles asociados al usuario (puede ser null) |
| data.confirmationToken | string | null | Token de confirmación de cuenta (puede ser null) |
| data.id | string | Identificador único del usuario |
| data.phone | string | Número de teléfono del usuario (ej. "0" si no tiene) |
| data.note | string | Nota asociada al usuario (ej. "no note") |
| data.enabled | boolean | Indica si la cuenta del usuario está habilitada (true) o deshabilitada (false) |
| data.admin | boolean | Indica si el usuario tiene privilegios de administrador (true) o no (false) |
| data.isDeleted | boolean | Indica si la cuenta del usuario está eliminada o desactivada |
| pagination | object | Objeto que contiene información de paginación (vacío si no aplica) |
| totalCounts | object | Total de registros asociados a la petición (vacío si no aplica) |
| extra | object | Información adicional relevante para la respuesta (vacío si no aplica) |