Crear o actualizar usuario
Este endpoint permite añadir o actualizar la información de un usuario dentro del negocio.
PUT /api/v2/businesses/{businessId}/users/{username}A continuación, se expone una explicación detallada de cada uno de los campos que pueden conformar el cuerpo de la petición, siendo algunos de ellos obligatorios para que esta se realice de manera exitosa.
|
Los campos obligatorios están marcados con un asterisco (*). |
Cuerpo de la petición
| Análisis del JSON |
|---|
Detalles
|
Ejemplo de la petición
Una vez realizado el análisis de los distintos campos, se muestra un ejemplo de la petición:
PUT /api/v2/businesses/BUSINESSID/users/test.user@orquest.com{
"username": "test.user@orquest.com",
"email": "test.user@orquest.com",
"nodes": [
5391, 5392
],
"roles": ["Manager"]
}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 nombre de usuario introducido por parámetro en la URL no coincide con el que se especifica en el campo username, la petición devolverá un error 400 Bad Request.
Si se intenta vincular un usuario a un mail perteneciente a un usuario previamente registrado en el sistema, la petición devolverá un error 400 Bad Request indicando en el mensaje error.email_already_exists. [email].
Es posible actualizar la dirección de correo electrónico vinculada a un usuario: solo hay que especificar en el cuerpo de la petición el email actualizado.
Si el formato de la dirección de correo electrónico no es válido, la petición devolverá un error 400 Bad Request indicando User email is not valid.
En nodes, deben especificarse los identificadores internos de los nodos en Orquest.
Si no se incluye ningún identificador, la petición devolverá un error 400 Bad Request indicando en el mensaje Nodes cannot be null.
En roles, el nombre del rol debe coincidir exactamente con el que está configurado en el sistema: Configuración de negocio > Roles.
Si alguno de los roles no coincide con los que están definidos a nivel de negocio, la petición devolverá un error 400 Bad Request indicando en el mensaje error.role_not_found. [rol].
Si hubiera algún rol definido previamente para el usuario, en la actualización debe enviarse también esta información.
Si no se envía el campo, se envía como null o un array vacío [], se eliminan todos los roles.