Scoping Canvas Developer Keys

by Zeke Cirilli

Hey School Admin! To connect your Canvas to Edlink, you'll need to create a developer API key in your Canvas.

During this process, you may want to scope the key so Edlink has limited access to your Canvas. The following are the scopes that Edlink needs:

  • Allow include parameters
  • All read-only scopes:
  • url:POST|/api/v1/courses/:course_id/assignments
  • url:PUT|/api/v1/courses/:course_id/assignments/:id
  • url:DELETE|/api/v1/courses/:course_id/assignments/:id
  • url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
  • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

Once you create the scoped developer key, you'll follow the same Edlink onboarding guide, with one difference. Select "Scopes Enabled" before connecting your account.

Note: Applying scopes can break integrated functionalities in apps. We recommend that you test your integration before fully releasing it to your school or district.