List roles

GET 
/roles

Returns a paginated list of roles. A Super Admin sees every role on the platform; any other caller sees only the roles they are attached to.

Pagination: read next_available in the response. While it is "yes", request the next page by advancing offset by limit. When it is "no" this was the last page and the client must stop. total_count is the number of roles matching the filter and count is the size of the current page.

Request

Responses

200

Page of roles. Check next_available to decide whether to request a further page.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

Input validation or authorization failure. Body is {"Message": " - "}. Codes: IPV-1050 (limit above 1000), AUTH-1001 (role_id header missing), AUTH-1003 (caller not attached to the role), AUTH-1030 (role lacks the required permission), IPV-1002 (role_id header names an unknown role).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Backend failure. Also returned for a non-numeric offset or limit, and for a sortby naming an attribute that is missing from some role or is not a string. Body is {"Message": " - "}.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers