AdminAccess

Un permiso de acceso de un Admin a una entidad (relatedAccess: una Company, un BranchGroup o una Branch). is_owner marca el acceso del administrador propietario, que no se puede quitar. Un acceso a una entidad de nivel superior (company o grupo) implica acceso a las de nivel inferior.

Estructura de Datos

Atributo Tipo Descripción
id int
is_owner bool Si es el acceso del administrador propietario (no se puede quitar)
admin_id int {@link Admin} al que pertenece el acceso
access_id int Id de la entidad a la que se da acceso
access_type string Tipo de la entidad (Company, BranchGroup o Branch); en la respuesta se expone en snake_case
created_at datetime\|null
updated_at datetime\|null
admin Admin {@link Admin} al que pertenece el acceso
allLogs ApiLog>
logs ApiLog>
relatedAccess EloquentModel\|Eloquent Entidad a la que el acceso da permiso (Company, BranchGroup o Branch) 
{
    "id": 1,
    "is_owner": true,
    "admin_id": 1,
    "access_id": 1,
    "access_type": "company",
    "created_at": "2020-04-17 01:07:47",
    "updated_at": "2020-04-17 01:07:47"
}

Endpoints

Insertar AdminAccess

Insertar AdminAccess de Admin

Dar acceso a un administrador

Crea un AdminAccess para el Admin sobre una Company, un BranchGroup o una Branch. Al crear el primer acceso a una sucursal se notifica por correo.

Método URI Cabeceras
POST /companies/{companyId}/admins/{adminId}/admin-accesses Authorization 
{
    "access_type": "required|string|in:company,branch,branch_group",
    "access_id": "required|integer"
}

Listar AdminAccess

{info} Soporta: Paginación Filters Carga dinámica

Listar accesos de la compañía

Devuelve los AdminAccess sobre la Company indicada (qué admins tienen acceso a nivel company).

Método URI Cabeceras
GET /companies/{companyId}/admin-accesses Authorization

Listar AdminAccess de BranchGroup

{info} Soporta: Paginación Filters Carga dinámica

Listar accesos de un grupo de sucursales

Devuelve los AdminAccess sobre el BranchGroup indicado.

Método URI Cabeceras
GET /companies/{companyId}/branch-groups/{branchGroupId}/admin-accesses Authorization

Listar AdminAccess de Branch

{info} Soporta: Paginación Filters Carga dinámica

Listar accesos de una sucursal

Devuelve los AdminAccess que dan acceso a la Branch indicada, incluidos los heredados de su grupo y de la company.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/admin-accesses Authorization

Listar AdminAccess de Admin

{info} Soporta: Paginación Filters Carga dinámica

Listar accesos de un administrador

Devuelve los AdminAccess del Admin indicado.

Método URI Cabeceras
GET /companies/{companyId}/admins/{adminId}/admin-accesses Authorization

Eliminar AdminAccess

Quitar acceso a un administrador

Elimina el AdminAccess indicado. No se permite quitar el acceso del administrador propietario (is_owner).

Método URI Cabeceras
DELETE /companies/{companyId}/admin-accesses/{adminAccessId} Authorization

Relaciones