Endpoints / Configuración

GET

Listar configuraciones

Obtiene todas las configuraciones de una empresa, ordenadas por clave, desde administración central.

GET/configs

Caso de Uso

Se usa cuando un administrador necesita cargar todas las claves de configuración de una empresa para una pantalla de administración o para inicializar ajustes internos. Al usarlo, el usuario obtiene un arreglo con todas las configuraciones de la empresa indicada, ordenadas alfabéticamente por clave.

Autenticación

Requiere token JWT en el header `Authorization: Bearer <token>`. Solo permite acceso a usuarios con rol administrador. La empresa del usuario autenticado debe estar activa y ser empresa padre.

Parámetros de ruta

Este endpoint no recibe parámetros de ruta.

Query params

companyIdstring opcional

Identificador de la empresa. Si no se envía, se usa la empresa del usuario autenticado.

Body

No aplica.

Reglas de negocio

1

Solo un usuario con rol administrador puede consultar configuraciones.

2

La empresa del usuario autenticado debe ser empresa padre.

3

La empresa del usuario autenticado debe estar activa.

4

El usuario autenticado debe estar activo.

5

Si no se envía companyId, se consultan las configuraciones de la empresa del usuario autenticado.

6

Si se envía companyId, se consultan las configuraciones de la empresa indicada.

7

La respuesta no usa paginación; devuelve todas las configuraciones en un arreglo.

8

Los resultados se ordenan por cfclave en orden ascendente.

9

Si no existen configuraciones para la empresa, se devuelve un arreglo vacío.

Errores esperados

401No autorizado

No se envió un token JWT válido o el token no contiene información válida del usuario.

500El id de empresa es requerido

El companyId fue enviado vacío.

500La empresa no existe

La empresa asociada al usuario autenticado no fue encontrada.

500La empresa no está activa

La empresa asociada al usuario autenticado está inactiva.

500El usuario no existe

El usuario autenticado no fue encontrado dentro de su empresa.

500El usuario no pertenece a la empresa

El usuario autenticado no pertenece a la empresa indicada por su sesión.

500El usuario no es administrador

El usuario autenticado no tiene el rol requerido para consultar configuraciones.

500El usuario no está activo

El usuario autenticado está inactivo y no puede usar el sistema.

500La empresa no es empresa padre

La empresa del usuario autenticado no es empresa padre.

Notas de uso

1

Este endpoint no recibe parámetros de ruta ni body.

2

companyId es un query param opcional; si no se envía, se usa la empresa del usuario autenticado.

3

La respuesta es un arreglo simple, no un objeto paginado.