Roles

Roles are named groups of permissions. A role is typically assigned to a user to grant a user permissions.

Get a single role

URL

GET /roles/:role HTTP/1.1

• role - Required The role identifier.

Request

GET /roles/Student HTTP/1.1
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Student",
  "permissions": [
        "CHOICE_CHALLENGE_CREATE",
        "CHOICE_CHALLENGE_DELETE"
    ]
}

List roles

URL

GET /roles HTTP/1.1

Request

GET /roles HTTP/1.1
Accept: application/json

Response

HTTP/1.1 201 Created
Content-Type: application/json

[
  {
    "name": "Admin",
    "permissions": [
        "CHOICE_CHALLENGE_CREATE",
        "CHOICE_CHALLENGE_DELETE"
    ]
  },
  {
    "name": "Student",
    "permissions": [
        "CHOICE_CHALLENGE_List"
    ]
  }
]