Roles

List roles

Changed on

Returns a paginated list of roles scoped to the authenticated tenant.

Supports Flop pagination and filtering on name, description.

get/api/roles

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/roles
  • Auth: none required

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max: 100)

order_bystring

Field to sort by

order_directionsstring

Sort direction (asc or desc)

Response

Role list

Example response

{
  "data": [
    {
      "description": "",
      "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "inserted_at": "2020-04-20T16:20:00Z",
      "metadata": {},
      "name": "",
      "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "updated_at": "2020-04-20T16:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Changes