Canvas has the ability to limit Developer Keys to specific endpoints, which is called a "scoped" developer key. Using an inherited developer key greatly simplifies the setup process, and provides the same level of security.

This page will provide information about what scopes we use for the the TidyUP inherited developer key.

Scoped 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_or_id
url:PUT|/api/v1/courses/:course_id/pages/:ur_or_id
url:DELETE|/api/v1/courses/:course_id/pages/:url_or_id

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