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.

Ejemplo de respuesta

{
    "username": "test.user@orquest.com",
    "email": "test.user@orquest.com",
    "nodes": [
        5391, 5392
    ],
    "roles": ["Manager"]
}
Detalles
  • 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.

Consideraciones

Si el usuario no tiene ningún rol asignado, en este campo aparecerá un array vacío [].

Cualquier usuario con acceso al negocio puede consultar la información de cualquier otro usuario del negocio, sin que se comprueben los nodos sobre los que cada uno tiene visibilidad.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

404 Not Found

-

El userName indicado no coincide con ningún usuario del negocio.

Este endpoint tiene un manejo de errores propio que no sigue el formato general de la API: el 401 Forbidden del catálogo común (sin permiso sobre el negocio) se devuelve aquí como 404 Not Found sin cuerpo, igual que el caso de usuario no encontrado. Solo 401 Business forbidden (negocio inexistente) conserva el formato habitual, con el literal en message. Este endpoint no comprueba nodo, así que 401 Service or node forbidden no aplica.

Enlaces de interés

¿Qué es un usuario?

¿Qué es un nodo?

¿Cuál es la diferencia entre rol de empleado y rol de usuario?