v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-2381210.5 KB
roles

Returns a list of all roles

Returns a paginated list of all roles. By default all roles are returned, but a subset can be returned by providing offset and limit query parameters.

get/roles

Query parameters

limitinteger

Maximum number of items that will be returned. A value of zero will return an empty items array. The default value is 20, with a maxiumum cap of 1000.

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

Successfully returned a json object containing a list of all roles

countinteger

The number of roles returned

total_countinteger

The total number of roles

offsetinteger

The first row of resources to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

limitinteger

The number of items returned per request

Example response

{
  "items": [
    {
      "id": "1b",
      "role": "admin",
      "permissions": [
        "legacy:read"
      ]
    }
  ]
}