FAQs
Is enforcing scopes required?
No. By default, Qwickly products function correctly without enabling
"Enforce Scopes" on the Canvas Developer Key. It is typically only enabled
if your institution has specific internal security policies requiring
it.
How do I check if scopes are enforced?
Navigate to Admin Developer Keys in Canvas, locate the Qwickly API Key,
and click the pencil icon to edit. If the Enforce Scopes slider is toggled
on, scopes are being enforced.
What is the "Allow Include Parameters" setting?
If you choose to enforce scopes, you must also check the box labeled
"Allow Include Parameters" to ensure the tool can request additional
necessary data fields.
What does the "invalid_scope" error mean?
This error occurs when Canvas has not granted a specific permission required
for the tool to function.
How do I fix an "invalid_scope" error?
1. Review the error message on the screen.
2. Identify the underlined scope URL (e.g., url:GET|/api/v1/accounts/:account_id/courses).
3. Go to the Developer Key settings in Canvas and ensure that specific endpoint is checked/enabled.
4. Save and relaunch the tool.
2. Identify the underlined scope URL (e.g., url:GET|/api/v1/accounts/:account_id/courses).
3. Go to the Developer Key settings in Canvas and ensure that specific endpoint is checked/enabled.
4. Save and relaunch the tool.
Why are these two scopes needed?
Admins
1. Scope: url:GET|/api/v1/accounts/:account_id/admins
* Description: A paginated list of the admins in the account.
Roles
1. Scope: url:GET|/api/v1/accounts/:account_id/roles
* Description: A paginated list of the roles available to an account.for
Qwickly?
These particular 2 scopes are used for
1. url:GET|/api/v1/accounts/:account_id/admins:
This scope is used to check if the currently logged in user is a Canvas administrator. Admins have access to the Attendance instructor view and may perform the same actions as an instructor in all courses even if they are not enrolled as an instructor.
2.url:GET|/api/v1/accounts/:account_id/roles:
This scope is used to retrieve a list of custom course roles that may have been created by a client institution. Qwickly Attendance allows custom roles to be used instead of or alongside the default Teacher or Student roles. This functionality can be found in the Qwickly Dashboard (www.qwickly.tools) Manage Attendance Settings Permissions.
NOTE* Qwickly does not permanently store a list of Administrators obtained from the url:GET|/api/v1/accounts/:account_id/admins endpoint. This data is only stored for the duration of the active user session. All client communication is sent through a client management system that is separate from the Qwickly Attendance application.
1. url:GET|/api/v1/accounts/:account_id/admins:
This scope is used to check if the currently logged in user is a Canvas administrator. Admins have access to the Attendance instructor view and may perform the same actions as an instructor in all courses even if they are not enrolled as an instructor.
2.url:GET|/api/v1/accounts/:account_id/roles:
This scope is used to retrieve a list of custom course roles that may have been created by a client institution. Qwickly Attendance allows custom roles to be used instead of or alongside the default Teacher or Student roles. This functionality can be found in the Qwickly Dashboard (www.qwickly.tools) Manage Attendance Settings Permissions.
NOTE* Qwickly does not permanently store a list of Administrators obtained from the url:GET|/api/v1/accounts/:account_id/admins endpoint. This data is only stored for the duration of the active user session. All client communication is sent through a client management system that is separate from the Qwickly Attendance application.
Comments
0 comments
Please sign in to leave a comment.