Skip to content

Roles

Roles personalizados y permisos por empresa.

Crear rol personalizado

NombreTipoRequeridoDescripción
companyIdstring
{
"name": "supervisor",
"permissions": ["employees.view","attendance.view.all"]
}

Rol creado exitosamente

{
"id": "00000000-0000-0000-0000-000000000000",
"companyId": "00000000-0000-0000-0000-000000000000",
"name": "name",
"isPredefined": true,
"permissions": [],
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

Listar roles de la empresa

NombreTipoRequeridoDescripción
companyIdstring

Lista de roles

{
"id": "00000000-0000-0000-0000-000000000000",
"companyId": "00000000-0000-0000-0000-000000000000",
"name": "name",
"isPredefined": true,
"permissions": [],
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

PATCH /api/companies/{companyId}/roles/v1/{roleId}

Section titled “PATCH /api/companies/{companyId}/roles/v1/{roleId}”

Actualizar rol

Roles predefinidos no pueden renombrarse. Los permisos se sobreescriben completamente (no se agregan).

NombreTipoRequeridoDescripción
companyIdstring
roleIdstring
{
"name": "name",
"permissions": []
}

Rol actualizado

{
"id": "00000000-0000-0000-0000-000000000000",
"companyId": "00000000-0000-0000-0000-000000000000",
"name": "name",
"isPredefined": true,
"permissions": [],
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

DELETE /api/companies/{companyId}/roles/v1/{roleId}

Section titled “DELETE /api/companies/{companyId}/roles/v1/{roleId}”

Eliminar rol

Rol eliminado

NombreTipoRequeridoDescripción
companyIdstring
roleIdstring

Rol eliminado exitosamente


CampoTipoRequeridoDescripción
namestring ej: “supervisor”
permissionsarray ej: [“employees.view”,“attendance.view.all”]
CampoTipoRequeridoDescripción
idstring (uuid)
companyIdstring (uuid)
namestring
isPredefinedboolean
permissionsarray
createdAtstring (date-time)
updatedAtstring (date-time)
CampoTipoRequeridoDescripción
namestring
permissionsarray