🔍 ¿Qué hace este endpoint?

Este endpoint permite consultar la información completa de un Usuario registrado en Aleluya, utilizando el identificador único (id) indicado en la ruta. La información incluye: Datos personales, información de la empresa asociada, rol, permisos y configuraciones de acceso.

🎯 ¿Cuándo usar este endpoint?

Cuando se requiere obtener la información completa de un usuario para realizar operaciones administrativas.
Para verificar el rol y permisos de un usuario en una empresa específica.
Para obtener información sobre si el usuario está activo o inactivo en la empresa.
Para verificar si el usuario tiene acceso a múltiples empresas o solo a una.

📌 Consideraciones importantes

Permisos y autenticación

Solo puedes consultar tu propia información de usuario. Debes ser el usuario autenticado y tener un acceso de usuario activo para poder consultar tu información.
Si intentas consultar un usuario al que no tienes permiso, recibirás un error indicando que el acceso está prohibido 403 No autorizado.

Requisitos previos:

Debes proporcionar el identificador único del usuario (id) en la URL. El usuario debe existir; de lo contrario, se responde 404 Usuario no existe.

Variaciones en la respuesta:

La información que recibes puede cambiar según si la empresa del usuario está asociada al distribuidor Arus:

Sin distribuidor Arus

La respuesta no incluye los campos distributor y sign_up. Estos campos simplemente no aparecen en el objeto JSON.

Ejemplo de respuesta:

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Juan Pérez",
    "email": "juan@example.com",
    "phone": "3001234567",
    "picture": "https://storage.example.com/profiles/photo.jpg",
    "role": "admin",
    "active": true,
    "area": "accounting",
    "company_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "company_name": "Waystar Royco",
    "company_access": true,
    "company_created_at": "1640000000",
    "premium": true,
    "multicompany": false,
    "is_new_invited_admin_user": false,
    "worker_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "worker_with_benefits": true,
    "workers_handle_novelties": true,
    "workers_income_certificate_access": true,
    "workers_labor_certificate_access": true,
    "workers_payslips_access": true
  }
}

Con distribuidor Arus

La respuesta incluye los campos adicionales distributor (con valor "Arus") y sign_up (es true si es el primer inicio de sesión del usuario, false en caso contrario).

Ejemplo de respuesta:

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Juan Pérez",
    "email": "juan@example.com",
    "phone": "3001234567",
    "picture": "https://storage.example.com/profiles/photo.jpg",
    "role": "admin",
    "active": true,
    "area": "accounting",
    "company_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "company_name": "Waystar Royco",
    "company_access": true,
    "company_created_at": "1640000000",
    "premium": true,
    "multicompany": false,
    "is_new_invited_admin_user": false,
    "worker_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "worker_with_benefits": true,
    "workers_handle_novelties": true,
    "workers_income_certificate_access": true,
    "workers_labor_certificate_access": true,
    "workers_payslips_access": true,
    "distributor": "Arus",
    "sign_up": false
  }
}