Skip to main content
GET
/
roles
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/roles' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "roles": [
{
    "alias": "administrator",
    "name": "Administrator"
},
{
    "alias": "manager",
    "name": "Manager"
},
{
    "alias": "expert",
    "name": "Expert"
},
{
    "alias": "learner",
    "name": "Learner"
},
{
    "alias": "1",
    "name": "Custom Role Title"
}
    ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.konstantly.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of all available roles in the system. Roles define user permissions and access levels within your platform.

​
Request Headers

​
X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

​
Response

​
roles
array
required
Array of role objects

​
Role Types

  1. Built-in Roles:
  • administrator: Full system access
  • manager: Can manage users and content
  • expert: Can create and assess content
  • learner: Basic access to assigned content
  1. Custom Roles:
  • Identified by numeric alias
  • Have custom display names
  • Permissions configured in web interface

​
Usage Notes

  1. Role Assignment:
  • Roles are required when creating users
  • Users can only have one role
  • Role changes require user re-authentication
  1. Best Practices:
  • Audit role assignments regularly
  • Use least-privilege principle
  • Document custom role configurations
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/roles' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "roles": [
{
    "alias": "administrator",
    "name": "Administrator"
},
{
    "alias": "manager",
    "name": "Manager"
},
{
    "alias": "expert",
    "name": "Expert"
},
{
    "alias": "learner",
    "name": "Learner"
},
{
    "alias": "1",
    "name": "Custom Role Title"
}
    ]
}