Roles

Crear o editar un rol

Crea un nuevo rol o actualiza uno existente según el negocio del usuario autenticado.

  • Si el body incluye un campo _id válido que coincide con un rol del negocio, actualiza el rol.
  • Si no se proporciona _id, crea un nuevo rol.

El campo business se asigna automáticamente desde el token del usuario; no es necesario enviarlo. Se registra historial del cambio (creación o actualización) y se notifica por WebSocket a los usuarios conectados del negocio.

Permiso requerido: RO_POST

post/roles

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/roles
  • Auth
    HTTP bearer

Request body

_idstring

ID del rol a actualizar. Si no se envía, se crea uno nuevo.

namestring required

Nombre del rol

Example request

{
  "_id": "507f1f77bcf86cd799439050",
  "name": "Supervisor",
  "permissions": [
    {
      "code": "PR_GET_ALL",
      "name": "Ver productos"
    }
  ]
}

Response

Rol creado o actualizado exitosamente

_idstring

ID único del rol

businessstring

ID del negocio al que pertenece el rol (asignado automáticamente desde el token)

namestring

Nombre del rol

deletedboolean

Indica si el rol fue eliminado lógicamente (soft delete)

modifiedOnstring date-time

Fecha de última modificación (se actualiza automáticamente al guardar)

createdOnstring date-time

Fecha de creación del rol

Example response

{
  "_id": "507f1f77bcf86cd799439050",
  "business": "507f1f77bcf86cd799439012",
  "name": "Administrador",
  "permissions": [
    {
      "code": "RO_GET_ALL",
      "name": "Ver todos"
    },
    {
      "code": "RO_POST",
      "name": "Crear/Editar"
    },
    {
      "code": "PR_GET_ALL",
      "name": "Ver productos"
    }
  ],
  "modifiedOn": "2025-08-04T10:30:00.000Z",
  "createdOn": "2025-01-15T08:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.