PUT role/{roleId}

Related
GETPUTDELETE

Update or create a role. Note: some roles are protected from modification, namely: all, anonymous, user, and admin. Attempts to alter them will fail.

Example

PUT /api/v1/role/student HTTP/1.1
Accept: application/json
Authorization: Bearer ...

{
  "description": "A student.",
  "type": "role"
}
----------------------------------------
HTTP/1.1 204 No Content

Security

Authentication is required and access is limited to admins.

URL Parameters

NameDescriptionValue
roleIdthe identifier of the role to update or create; IDs must contain only lower-case letters, numbers, and hyphens.string

Query Parameters

NONE

Request Body

NameDescriptionValue
descriptionthe description of the rolestring
typethe type of the role
one of:
  • role
  • group

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE