Qwickly Attendance for Canvas: Developer Key Scopes

Enforcing scopes is not required to use Qwickly Attendance with Canvas.

By default, Qwickly Attendance will function correctly without enabling Enforce 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 Enforce Scopes, you must ensure that the Qwickly Attendance 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 Attendance 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 Attendance Developer Key:

Accounts

1. Scope: url:GET|/api/v1/accounts/:account_id/sub_accounts 
   • Description: List accounts that are sub-accounts of the given account.
2. Scope: url:GET|/api/v1/accounts/:account_id/courses
   • Description: Retrieve a paginated list of courses in this account.

Users

1. Scope: url:GET|/api/v1/users/:id
   • Description: Shows details for a specified user.
2. Scope: url:GET|/api/v1/users/:user_id/profile
   • Description: Returns user profile data, including user ID, name, and avatar image url

Admins

1. Scope: url:GET|/api/v1/accounts/:account_id/admins
   • Description: A paginated list of the admins in the account.

Grade Change Log

1. Scope: url:GET|/api/v1/audit/grade_change/courses/:course_id
   • Description: List grade change events for a given course.

Courses

1. Scope: url:GET|/api/v1/courses/:id
   • Description: Return Information on a single course.
2. Scope: url:GET|/api/v1/courses/:course_id/users
   • Description: Returns a paginated list of users in a course.

Roles

1. Scope: url:GET|/api/v1/accounts/:account_id/roles
   • Description: A paginated list of the roles available to an account.

Enrollments

1. Scope: url:GET|/api/v1/courses/:course_id/enrollments
   • Description: Returns a paginated list of all of the enrollments in a course.

Groups

1. Scope: url:GET|/api/v1/courses/:course_id/groups
   • Description: Returns the paginated list of active groups in the given context that are visible to user.
2. Scope: url:GET|/api/v1/groups/:group_id/users
   • Description: Returns a paginated list of users in the group.

Sections

1. Scope: url:GET|/api/v1/courses/:course_id/sections
   • Description: A paginated list of the list of sections for this course.

Assignments 

1. Scope: url:GET|/api/v1/courses/:course_id/assignments
   • Description: Returns the paginated list of assignments for the current course or assignment group.
2. Scope: url:GET|/api/v1/courses/:course_id/assignments/:id
   • Description: Returns the assignment with the given id.
3. Scope: url:POST|/api/v1/courses/:course_id/assignments
   • Description: Create a new assignment for this course. The assignment is created in the active state.
4. Scope: url:PUT|/api/v1/courses/:course_id/assignments/:id
   • Description: Modify an existing assignment.
5. Scope: url:DELETE|/api/v1/courses/:course_id/assignments/:id
   • Description: Delete the given assignment.

Submissions

1. Scope: url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
   • Description: Returns a paginated list of all existing submissions for an assignment.
2. Scope: url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
   • Description: Comment on and/or update the grading for a student's assignment submission. If any submission or rubric_assessment arguments are provided, the user must have permission to manage grades in the appropriate context (course or section).

Discussion Topics

1. Scope: url:GET|/api/v1/courses/:course_id/discussion_topics
   • Description: Returns the paginated list of discussion topics for this course or group.
2. Scope: url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries
   • Description: Retrieve the (paginated) top-level entries in a discussion topic.

Quizzes

1. Scope: url:GET|/api/v1/courses/:course_id/quizzes
   • Description: Returns the paginated list of Quizzes in this course.

Quiz Submissions

1. Scope: url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions
   • Description: Get a list of all submissions for this quiz. Users who can view or manage grades for a course will have submissions from multiple users returned. A user who can only submit will have only their own submissions returned. When a user has an in-progress submission, only that submission is returned. When there isn’t an in-progress quiz_submission, all completed submissions, including previous attempts, are returned.

Additionally, users of the Qwickly Attendance Student Mobile App should also enforce the following scope:
 

Courses

1. Scope: url:GET|/api/v1/users/:user_id/courses
   • Description: Returns a paginated list of courses for the given student.

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 Attendance 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 Attendance 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.