Get role
GET/roles/:roleKey
Get a role by its key
Request
Path Parameters
The role key.
Responses
- 200
- 401
- 404
- 500
The role is successfully returned.
- application/json
- Schema
- Example (from schema)
Schema
The role key.
The role name.
The set of keys of members assigned to the role.
{
"roleKey": 0,
"name": "string",
"assignedMemberKeys": [
0
]
}
The request lacks valid authentication credentials.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The role with the given key was not found.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}