Skip to content

API: Content permissions endpoints

/class:permission

GET

Info

Check if a user has permission on a class.

Input:

  • [!] string class: class identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be class
    • string code: the class identification string
  • status
    • boolean permission: the user has permission on this class
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string class: class identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be class
    • string code: the class identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string class: class identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be class
    • string code: the class identification string
  • boolean success: operation was successful

/course:permission

GET

Info

Check if a user has permission on a course.

Input:

  • [!] string course: course identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be course
    • string code: the course identification string
  • status
    • boolean permission: the user has permission on this course
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string course: course identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be course
    • string code: the course identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string course: course identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be course
    • string code: the course identification string
  • boolean success: operation was successful

/event:permission

GET

Info

Check if a user has permission on an event.

Input:

  • [!] string event: event identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / finances / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be event
    • string code: the event identification string
  • status
    • boolean permission: the user has permission on this event
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string event: event identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / finances / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be event
    • string code: the event identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string event: event identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / finances / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be event
    • string code: the event identification string
  • boolean success: operation was successful

/exam:permission

GET

Info

Check if a user has permission on an exam.

Input:

  • [!] string exam: exam identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be exam
    • string code: the exam identification string
  • status
    • boolean permission: the user has permission on this exam
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string exam: exam identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be exam
    • string code: the exam identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string exam: exam identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be exam
    • string code: the exam identification string
  • boolean success: operation was successful

/integration:permission

GET

Info

Check if a user has permission on an integration.

Input:

  • [!] string integration: integration identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be integration
    • string code: the integration identification string
  • status
    • boolean permission: the user has permission on this integration
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string integration: integration identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be integration
    • string code: the integration identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string integration: integration identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be integration
    • string code: the integration identification string
  • boolean success: operation was successful

/organization:permission

GET

Info

Check if a user has permission on an organization.

Input:

  • [!] string organization: organization identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be organization
    • string code: the organization identification string
  • status
    • boolean permission: the user has permission on this organization
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string organization: organization identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be organization
    • string code: the organization identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string organization: organization identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be organization
    • string code: the organization identification string
  • boolean success: operation was successful

/quiz:permission

GET

Info

Check if a user has permission on a Quiz.

Input:

  • [!] string quiz: Quiz identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be quiz
    • string code: the Quiz identification string
  • status
    • boolean permission: the user has permission on this Quiz
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string quiz: Quiz identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be quiz
    • string code: the Quiz identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string quiz: Quiz identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be quiz
    • string code: the Quiz identification string
  • boolean success: operation was successful

/video:permission

GET

Info

Check if a user has permission on a video.

Input:

  • [!] string video: video identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be video
    • string code: the video identification string
  • status
    • boolean permission: the user has permission on this video
    • boolean rule: there is a permission rule with these parameters

POST

Info

Create new permission for a user.

Input:

  • [!] string video: video identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be video
    • string code: the video identification string
  • boolean success: operation was successful

DELETE

Info

Remove a user permission.

Input:

  • [!] string video: video identification string (code or [{tag}])
  • [!] string user: user identification string
  • [!] string permission: permission level
    • possible values: view / control / modify / grant / admin

Output:

  • string user: the user identification string
  • content
    • string type: will be video
    • string code: the video identification string
  • boolean success: operation was successful

Last update: August 26, 2019