GET role/{roleId}

Related

Get the details of a specific role.

Example

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

{
  "id": "admin",
  "description": "Universal administrator.",
  "type": "role"
}

Security

Authentication is required and access is limited to admins.

URL Parameters

NameDescriptionValue
roleIdthe identifier of the role to getstring

Query Parameters

NONE

Request Body

NONE

Response

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

Response Body

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