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

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/roles
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Query parameters

client_idstring nullable

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

Changes

No recorded changes to this operation across all 4 revisions of this API.