Skip to main content
GET
A cada usuario compartido se le asigna un rol — el panel de Scanova los llama internamente “access levels” (niveles de acceso), y el mismo término aparece a lo largo de este endpoint. Usa este endpoint para consultar los roles disponibles antes de invitar a un compañero de equipo mediante POST /multi-users/, o para crear un rol personalizado desde tus propios sistemas.
Este endpoint no estaba documentado anteriormente. Requiere una clave de la API de gestión con cuota MANAGEMENT_API (o MANAGEMENT_API_SANDBOX) — consulta el resumen de la API de gestión. Para saber qué otorga realmente cada rol a un compañero de equipo, consulta la guía orientada a personas Roles y permisos — esta página solo documenta el formato de transmisión.
Verificado en vivo: una cuenta nueva devuelve exactamente estos 6 roles de sistema (Viewer, Analyst, Billing Manager, Manager, Admin, Full Access) — coincidiendo con el selector de Roles y permisos en el panel lateral de Invite Users del panel. Los IDs mostrados arriba son ilustrativos; los arrays de permisos se han truncado por brevedad en este ejemplo — una respuesta real incluye todos los permisos que otorga el rol, en su totalidad.
Los resultados están paginados (tamaño de página 10 por defecto) y pueden incluir roles personalizados que la cuenta haya creado, junto con los 6 predeterminados del sistema.
string
Filtra a system (los roles integrados, user es nulo en estos) o custom (roles que esta cuenta ha creado).
Coincidencia de subcadena con el nombre del rol.
string
name o -name.

Campos de la respuesta (por rol)

integer
ID del rol — pásalo como access_level al invitar o actualizar un usuario compartido.
string
Nombre para mostrar del rol, p. ej. Manager.
string | null
Slug estable para los roles de sistema (p. ej. manager); null para roles personalizados.
boolean
false para los 6 roles de sistema integrados, true para un rol que esta cuenta haya creado por sí misma.
array
Todos los permisos que otorga este rol.

Relacionado

Autorizaciones

Authorization
string
header
requerido

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

Parámetros de consulta

type
enum<string>
Opciones disponibles:
system,
custom
ordering
string

Respuesta

200 - application/json

Paginated list of roles, each with its permission set.