TidyUP has recently added support for scoped developer keys. This is an important security feature for limiting the use of the Canvas API to its intended purposes. Developer keys are used to create tokens which grant access to the Canvas API. By scoping the developer key we are telling Canvas which API calls users have access to.


Setting up the scoped developer key requires the following steps:

  • Enabling scopes on the Cidi Labs developer key
  • Selecting the API calls needed for TidyUP to function
  • Deleting existing user tokens in the TidyUP database which are not scoped


This last step is not something an institution can do on its own, which is why this installation is best done on a call with Cidi Labs. Please submit a support ticket if you are interested in setting up scoped developer keys at your institution.


TidyUP API Endpoints


Assignments:

  • url:GET|/api/v1/courses/:course_id/assignments
  • url:PUT|/api/v1/courses/:course_id/assignments/:id
  • url:DELETE|/api/v1/courses/:course_id/assignments/:id

Courses:

  • url:GET|/api/v1/courses/:id
  • url:PUT|/api/v1/courses/:id

Discussion Topics:

  • url:GET|/api/v1/courses/:course_id/discussion_topics 
  • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id
  • url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id
  • url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries

Files:

  • url:GET|/api/v1/courses/:course_id/files
  • url:GET|/api/v1/courses/:course_id/folders
  • url:GET|/api/v1/users/:user_id/files 
  • url:GET|/api/v1/users/:user_id/folders 
  • url:DELETE|/api/v1/files/:id 
  • url:PUT|/api/v1/files/:id
  • url:DELETE|/api/v1/folders/:id 
  • url:PUT|/api/v1/folders/:id

Modules:

  • url:GET|/api/v1/courses/:course_id/modules
  • url:PUT|/api/v1/courses/:course_id/modules/:id
  • url:DELETE|/api/v1/courses/:course_id/modules/:id

Pages:

  • url:GET|/api/v1/courses/:course_id/pages 
  • url:GET|/api/v1/courses/:course_id/pages/:url 
  • url:PUT|/api/v1/courses/:course_id/pages/:url
  • url:DELETE|/api/v1/courses/:course_id/pages/:url

Quiz Questions:

  • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions 

Quizzes:

  • url:GET|/api/v1/courses/:course_id/quizzes
  • url:PUT|/api/v1/courses/:course_id/quizzes/:id
  • url:DELETE|/api/v1/courses/:course_id/quizzes/:id 

Users:

  • url:GET|/api/v1/users/:user_id/profile