Roles

Listing all Roles

Changed on

Currently, there are no paging or filtering options, so listing Roles will get you every Role in the system, every time. There are no authorization restrictions upon this endpoint: anybody is allowed to list all Role information at any time.

get/v1/roles

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/roles
  • Auth
    none declared

Response

OK

idnumber

The numerical ID of the Role.

namestring

The human-readable name for the Role.

systemstring

The system name of the Role. Roles that have system names may not be modified.

verbsstring[]

The array of string verbs this Role confers.

createdAtstring

ISO date format

updatedAtstring

ISO date format

Example response

[
  {
    "id": 4,
    "name": "Project Manager",
    "system": "manager",
    "verbs": [
      "project.update",
      "project.delete"
    ],
    "createdAt": "2018-04-18T23:42:11.406Z",
    "updatedAt": "2018-09-18T23:42:11.406Z"
  }
]

Changes