latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
roles

Get Roles

Get all roles with optional filtering based on client compliance status.

  • Non-compliance managed clients: Returns only Client Admin and User roles
  • Compliance managed clients: Returns all roles
  • No client_id: Returns all roles
get/api/v1/admin/roles

Query parameters

client_idstring nullable

Filter roles by client's compliance status

Filter roles by client's compliance status

filterstring nullable
sortstring nullable
rangestring nullable

Response

Successful Response

namestring required
descriptionstring nullable
parent_idstring uuid4 nullable
idstring uuid4 required