Obtener información de un usuario
Este endpoint permite consultar la información de un usuario vinculado al negocio.
GET /api/v2/businesses/{businessId}/users/{userName}
Si los datos incluidos en la petición son correctos —tanto el businessId como el userName—, la respuesta contendrá la información definida para el usuario:
-
username
: nombre de usuario. -
mail
: dirección de correo electrónico vinculada al usuario. -
nodes
: nodos en los que el usuario tiene visibilidad. -
roles
: roles de usuario.
A continuación, se muestra un ejemplo de respuesta:
GET /api/v2/businesses/BUSINESSID/users/test.user@orquest.com
{
"username": "test.user@orquest.com",
"email": "test.user@orquest.com",
"nodes": [
5391, 5392
],
"roles": ["Manager"]
}
Aspectos que tener en cuenta
Si el username
indicado en la URL 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 no tiene ningún rol asignado, en este campo aparecerá un array vacío []
.