Qwickly Course Tools for Canvas: Developer Key Scopes

Enforcing scopes is not required to use Qwickly Course Tools for Canvas.

By default, Qwickly Course Tools will function correctly without enabling Enforced Scopes on the Canvas Developer Key. Most institutions can complete their integration without modifying scope settings.

Some institutions choose to enforce scopes as part of their internal security policies. If your institution has enabled Enforced Scopes, you must ensure that the Qwickly Course Tools Developer Key includes all required permissions. Without the required scopes, users may encounter an “invalid_scope” error when launching the application.

1. How Do I Know if Scopes are Enforced?

2. Required Permissions

3. Troubleshooting “invalid_scope” Error

 

How Do I Know if Scopes are Enforced?

In Canvas, navigate to Admin > Developer Keys > Qwickly Course Tools API Key > pencil icon to edit. If scopes are enabled, you will see the 'Enforce Scopes' slider toggled on: 

Important Note: If you are using a developer key with scopes enforced, please make sure to check the box labeled "Allow Include Parameters"

 

Required Permissions

If your institution enforces scopes, the following permissions must be enabled in the Qwickly Course Tools Developer Key:

Users

url:GET|/api/v1/users/:id

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

url:GET|/api/v1/users/:user_id/courses

Courses

url:GET|/api/v1/courses

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

url:POST|/api/v1/courses/:course_id/files

url:GET|/api/v1/courses/:course_id/modules

url:POST|/api/v1/courses/:course_id/modules

url:GET|/api/v1/courses/:course_id/modules/:module_id/items

url:POST|/api/v1/courses/:course_id/modules/:module_id/items

url:GET|/api/v1/courses/:course_id/modules/:module_id/items/:id

url:PUT|/api/v1/courses/:course_id/modules/:module_id/items/:id

url:POST|/api/v1/courses/:course_id/pages

url:POST|/api/v1/courses/:course_id/discussion_topics

url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id

url:GET|/api/v1/courses/:course_id/assignments

url:POST|/api/v1/courses/:course_id/assignments

url:GET|/api/v1/courses/:course_id/assignment_groups

url:GET|/api/v1/courses/:course_id/users

url:GET|/api/v1/courses/:course_id/enrollments

url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions

Calendar

url:POST|/api/v1/calendar_events

Sections

url:POST|/api/v1/sections/:section_id/assignments/:assignment_id/submissions

Conversations

url:POST|/api/v1/conversations

Accounts

url:GET|/api/v1/accounts

url:GET|/api/v1/accounts/:account_id/terms

url:GET|/api/v1/accounts/:account_id/roles

url:GET|/api/v1/accounts/:account_id/admins

Troubleshooting: “invalid_scope” Error

If your institution enforces LTI scope restrictions and one or more required scopes are not enabled, you may encounter an “invalid_scope” error when launching the application.

This error indicates that Canvas has not granted all of the permissions required for the integration to function properly.

Example error message:

How to resolve this issue

1. Review the error message displayed on the page.

2. Locate the underlined scope URL (for example: url:GET|/api/v1/accounts/:account_id/courses).

3. This URL identifies the specific permission that is missing.

4. Update your LTI Developer Key or integration settings in Canvas to include the missing scope:
    

   1. Log in to Canvas as an administrator.

   2. Navigate to Admin → Developer Keys.

   3. Locate the Developer Key used for the Qwickly Course Tools integration.

   4. Select Edit Key.

   5. Under the Scopes section, ensure the missing scope shown in the error message is enabled.

   6. Save the changes.

   7. Relaunch the Qwickly Course Tools tool.
       

5. Save your changes and relaunch the application.

 

Additional notes

• The underlined scope URL provides precise information about which permission must be enabled.

• Your Canvas administrator may need to update these settings if you do not have access.

• If you are unsure how to update scopes, please contact your Canvas administrator or your Qwickly support representative.