Vincular usuario a un empleado

Este endpoint permite vincular a un usuario existente con un empleado del mismo negocio.

PUT /api/v2/businesses/{businessId}/employees/{employeeId}/user

Además del identificador externo del negocio (businessId), en la URL habrá que especificar el identificador externo del empleado con el que se quiere vincular al usuario: employeeId. En el cuerpo de la petición, se incluye solamente el username del usuario previamente registrado en el sistema:

Cuerpo de la petición

Análisis del JSON 
{
  "username": "string"
}
Detalles

  • username*: nombre de usuario. Debe ser único y estar ya registrado en el sistema. Normalmente, se utiliza el correo electrónico.

Ejemplo de la petición

A continuación, se muestra un ejemplo de la petición:

PUT /api/v2/businesses/BUSINESSID/employees/1006350/user
{
    "username": "test.user@orquest.com"
}

Si la petición se realiza correctamente (200 OK), la respuesta contendrá la información vinculada al usuario: username, mail, nodes y roles.

Aspectos que tener en cuenta

Si el identificador de empleado introducido por parámetro en la URL no coincide con ningún empleado del negocio, la petición devolverá un error 404 Not Found, indicando en el mensaje Employee not found.

Si el usuario indicado en el cuerpo de la petición no coincide con ningún usuario del negocio, la petición devolverá un error 404 Not Found, indicando en el mensaje User not found.

Si el usuario estaba vinculado a otro empleado, la información se actualiza y el usuario se vincula al empleado indicado en la URL.

Enlaces de interés

¿Qué es un usuario?

¿Qué es un empleado?