Workspace
List Roles
- Changelog
- Community
- Introduction
Lua Module
- GETRetrieve Orders
- GETSearch Orders
- GETRetrieve Order Timeline
- POSTCreate Order
- PATCHUpdate Order
- GETRetrieve a Workspace
- POSTUpdate a Workspace
- GETList Games
- POSTCreate Game
- DELDelete a Game
- GETList Roles
- POSTCreate a Role
- PUTUpdate Role
- DELDelete a Role
- GETList logbook templates
- GETRetrieve Logbook Template
- POSTCreate a Logbook Template
- PATCHUpdate a Logbook Template
- DELDelete a Logbook Template
API Documentation
Order Logging
Workspace
Workspace
List Roles
Get all roles in a workspace
GET
/
workspace
/
{workspaceId}
/
roles
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
workspaceId
string
*
workspaceId
Required
string
group
boolean
group
boolean
curl --request GET \
--url https://api.hyra.io/workspace/{workspaceId}/roles \
--header 'Authorization: Bearer <token>'
{
"roles": [
{
"name": "<string>",
"group_roles": [
"<string>"
],
"permissions": [
"<string>"
],
"_id": "<string>",
"manual_users": [
"<string>"
]
}
],
"group_roles": [
{
"id": "<string>",
"name": "<string>",
"rank": 123
}
]
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
workspaceId
string
requiredQuery Parameters
group
boolean
Response
200 - application/json
roles
object[]
requiredroles.name
string
requiredroles.group_roles
string[]
requiredroles.permissions
string[]
requiredroles._id
string
requiredroles.manual_users
string[]
group_roles
object[]
group_roles.id
string
group_roles.name
string
group_roles.rank
number
curl --request GET \
--url https://api.hyra.io/workspace/{workspaceId}/roles \
--header 'Authorization: Bearer <token>'
{
"roles": [
{
"name": "<string>",
"group_roles": [
"<string>"
],
"permissions": [
"<string>"
],
"_id": "<string>",
"manual_users": [
"<string>"
]
}
],
"group_roles": [
{
"id": "<string>",
"name": "<string>",
"rank": 123
}
]
}