Permissions CRUD

List permissions

GET /api/permisos Returns a paginated list of permission records joined with profile and module names. Results are ordered by id ascending with a fixed page size of 5 records.

Query parameters

number

default:"1"

Page number to retrieve. Defaults to 1.

Response

boolean

required

true when the query completes without error.

object[]

required

Array of permission records for the requested page.

Show permission object properties

number

Primary key of the permission record.

number

Foreign key referencing the perfil table.

number

Foreign key referencing the modulo table.

string

Profile name resolved from the perfil join (strNombrePerfil).

string

Module name resolved from the modulo join (strNombreModulo).

boolean

Whether the profile may create records in this module.

boolean

Whether the profile may edit records in this module.

boolean

Whether the profile may view records in this module.

boolean

Whether the profile may delete records in this module.

boolean

Whether the profile may view the detail view of records in this module.

number

required

Total number of pages calculated as ceil(totalRows / 5). Returns 1 when the table is empty.

Error response

500

{
  "statusCode": 500,
  "message": "Error al consultar permisos"
}

Examples

curl --request GET \
  --url 'https://your-domain.com/api/permisos?page=1' \
  --cookie 'auth_token=<your-jwt>'

const response = await fetch('/api/permisos?page=1', {
  credentials: 'include',
});

const { success, data, totalPages } = await response.json();

Success response

200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "idPerfil": 2,
      "idModulo": 3,
      "nombrePerfil": "Supervisor",
      "nombreModulo": "Usuario",
      "bitAgregar": false,
      "bitEditar": true,
      "bitConsulta": true,
      "bitEliminar": false,
      "bitDetalle": true
    }
  ],
  "totalPages": 4
}

Create permission

POST /api/permisos Creates a single permission record linking a profile to a module with specific action flags.

Request body

number

required

ID of the profile to assign permissions to.

number

required

ID of the module the permissions apply to.

boolean

default:"false"

Grant create access.

boolean

default:"false"

Grant edit access.

boolean

default:"false"

Grant read/list access.

boolean

default:"false"

Grant delete access.

boolean

default:"false"

Grant detail-view access.

Response

boolean

required

true when the record is inserted successfully.

object

required

The newly created permisos_perfil row as returned by the database RETURNING clause.

Error responses

Status	Message	Cause
`400`	`Perfil y Módulo son obligatorios`	`idPerfil` or `idModulo` is missing from the request body.

Examples

curl --request POST \
  --url https://your-domain.com/api/permisos \
  --header 'Content-Type: application/json' \
  --cookie 'auth_token=<your-jwt>' \
  --data '{
    "idPerfil": 2,
    "idModulo": 3,
    "bitAgregar": false,
    "bitEditar": true,
    "bitConsulta": true,
    "bitEliminar": false,
    "bitDetalle": true
  }'

const response = await fetch('/api/permisos', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  credentials: 'include',
  body: JSON.stringify({
    idPerfil: 2,
    idModulo: 3,
    bitAgregar: false,
    bitEditar: true,
    bitConsulta: true,
    bitEliminar: false,
    bitDetalle: true,
  }),
});

const { success, data } = await response.json();

Success response

200

{
  "success": true,
  "data": {
    "id": 42,
    "idPerfil": 2,
    "idModulo": 3,
    "bitAgregar": false,
    "bitEditar": true,
    "bitConsulta": true,
    "bitEliminar": false,
    "bitDetalle": true
  }
}

Update permission

PUT /api/permisos/:id Replaces all fields on an existing permission record. You must supply the full set of fields — any boolean omitted is coerced to false.

Path parameters

number

required

Primary key of the permisos_perfil row to update.

Request body

number

required

ID of the profile.

number

required

ID of the module.

boolean

Grant create access.

boolean

Grant edit access.

boolean

Grant read/list access.

boolean

Grant delete access.

boolean

Grant detail-view access.

Response

boolean

required

true when the update completes.

object

required

The updated permisos_perfil row as returned by the database RETURNING clause.

Examples

curl --request PUT \
  --url https://your-domain.com/api/permisos/42 \
  --header 'Content-Type: application/json' \
  --cookie 'auth_token=<your-jwt>' \
  --data '{
    "idPerfil": 2,
    "idModulo": 3,
    "bitAgregar": true,
    "bitEditar": true,
    "bitConsulta": true,
    "bitEliminar": false,
    "bitDetalle": true
  }'

const response = await fetch('/api/permisos/42', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  credentials: 'include',
  body: JSON.stringify({
    idPerfil: 2,
    idModulo: 3,
    bitAgregar: true,
    bitEditar: true,
    bitConsulta: true,
    bitEliminar: false,
    bitDetalle: true,
  }),
});

const { success, data } = await response.json();

Success response

200

{
  "success": true,
  "data": {
    "id": 42,
    "idPerfil": 2,
    "idModulo": 3,
    "bitAgregar": true,
    "bitEditar": true,
    "bitConsulta": true,
    "bitEliminar": false,
    "bitDetalle": true
  }
}

Delete permission

DELETE /api/permisos/:id Permanently removes a single permission record from the permisos_perfil table.

Path parameters

number

required

Primary key of the permisos_perfil row to delete.

Response

boolean

required

true when the delete completes.

string

required

Always "Eliminado correctamente".

Examples

curl --request DELETE \
  --url https://your-domain.com/api/permisos/42 \
  --cookie 'auth_token=<your-jwt>'

const response = await fetch('/api/permisos/42', {
  method: 'DELETE',
  credentials: 'include',
});

const { success, message } = await response.json();

Success response

200

{
  "success": true,
  "message": "Eliminado correctamente"
}

Authentication

Users

Profiles

Modules

Permissions

List permissions

Query parameters

Response

Error response

Examples

Success response

Create permission

Request body

Response

Error responses

Examples

Success response

Update permission

Path parameters

Request body

Response

Examples

Success response

Delete permission

Path parameters

Response

Examples

Success response

​List permissions

​Query parameters

​Response

​Error response

​Examples

​Success response

​Create permission

​Request body

​Response

​Error responses

​Examples

​Success response

​Update permission

​Path parameters

​Request body

​Response

​Examples

​Success response

​Delete permission

​Path parameters

​Response

​Examples

​Success response

List permissions

Query parameters

Response

Error response

Examples

Success response

Create permission

Request body

Response

Error responses

Examples

Success response

Update permission

Path parameters

Request body

Response

Examples

Success response

Delete permission

Path parameters

Response

Examples

Success response