GET roles

Get the list of roles available in the system.

Example

GET /api/v1/roles HTTP/1.1
Accept: application/json
Authorization: Bearer ...
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "admin",
    "description": "Universal administrator.",
    "type": "role"
  },
  {
    "id": "anonymous",
    "description": "Anonymous user.",
    "type": "role"
  },
  {
    "id": "user",
    "description": "Authenticated user.",
    "type": "role"
  },
  {
    "id": "all",
    "description": "All users.",
    "type": "group"
  }
]

Security

Authentication is required and access is limited to admins.

URL Parameters

NONE

Query Parameters

NONE

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

The response body is an Array of Role objects.

Role