curl --request GET \
--url https://api.ctrl-hub.com/v3/roles \
--header 'X-Session-Token: <api-key>'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"domain": "<string>",
"role": "<string>",
"name": "<string>",
"description": "<string>",
"available_scopes": {
"attributes": [
{
"name": "<string>",
"type": "uuid",
"operations": [
"="
],
"resource_type": [
"folders",
"users"
]
}
],
"patterns": [
{
"type": "contains",
"field": "<string>",
"operations": [
"="
]
}
]
}
},
"relationships": {
"permissions": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
}
}
}
],
"meta": {
"pagination": {
"counts": {
"pages": 123,
"resources": 123
},
"current_page": 123,
"offsets": {
"next": 123,
"previous": 123
},
"requested": {
"limit": 123,
"offset": 123
}
},
"features": {
"include": {
"options": [
"<string>"
]
}
}
},
"jsonapi": {
"version": "<string>"
}
}Retrieve a list of roles
curl --request GET \
--url https://api.ctrl-hub.com/v3/roles \
--header 'X-Session-Token: <api-key>'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"domain": "<string>",
"role": "<string>",
"name": "<string>",
"description": "<string>",
"available_scopes": {
"attributes": [
{
"name": "<string>",
"type": "uuid",
"operations": [
"="
],
"resource_type": [
"folders",
"users"
]
}
],
"patterns": [
{
"type": "contains",
"field": "<string>",
"operations": [
"="
]
}
]
}
},
"relationships": {
"permissions": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
}
}
}
],
"meta": {
"pagination": {
"counts": {
"pages": 123,
"resources": 123
},
"current_page": 123,
"offsets": {
"next": 123,
"previous": 123
},
"requested": {
"limit": 123,
"offset": 123
}
},
"features": {
"include": {
"options": [
"<string>"
]
}
}
},
"jsonapi": {
"version": "<string>"
}
}Session token for authentication.
Limit the number of resources returned by the API
x >= 1Offset the resources returned by the API
x >= 0