Canvas SSO Integration Setup
This article is directed towards IT administrators looking to set up Canvas Single Sign On (SSO) access to QuaverEd resources for their district.
QuaverEd can be set up as an External App in Canvas to allow Single Sign On access to QuaverEd resources directly from Canvas via LTI using the instructions below.
Step 1: District requests integration
Your district IT team should contact Quaver’s integration team at firstname.lastname@example.org to get started!
Step 2: Quaver configures our system to support your district’s Canvas SSO integration
We’ll need to set things up on our side first. We’ll generate unique keys and secrets for your district, configure your LTI parameters and more. Once we have everything ready, we’ll provide you with the key, secret, and launch link you need to set up Quaver as an External App in Canvas.
Step 3: Set up External App in Canvas
1. In your Canvas Admin account, add a new app to the External Apps.
You should be able to find this area via Admin > (Name of the Account) > Settings > Apps > View App Configurations > Add App. Please see Canvas’s instructions on this for details.
2. On the app configuration panel, use the following settings:
- Configuration Type: Manual Entry
- Name: QuaverEd (or QuaverMusic/QuaverSEL/etc. as preferred)
- Privacy: Public
- Consumer key, Shared secret, and Launch URL will be provided by our integrations team. They may be specific to your integration and should not be copied from another source.
- Domain, custom fields, and description may be left blank unless otherwise specified by our integrations team.
Note that by default Quaver will use the Canvas user’s email address as their unique identifier and key value to roster data. If your users do not all have unique email addresses in Canvas, please notify the Quaver integrations team during the setup process.
Step 4: Testing
Once you have Quaver set up as an External App in your district’s Canvas instance, we’ll proceed to testing. Please note that your SSO integration will be set up in a restricted testing state so only a limited number of users can come through. Once we confirm everything seems to be working as expected, we’ll go ahead and release it for everyone to use.
To test the integration, please have a licensed Quaver teacher add the External App to their Canvas course and click the link to log into Quaver through Canvas. They should land at our SSO account provisioning page.
Note: The first time a user logs into Quaver via Canvas, they will have to go through a one-time account provisioning step. This process allows users who have used Quaver in the past to link their existing Quaver accounts with their Canvas SSO account. This is particularly important for teachers who have registered licenses or customized resources to an existing Quaver account.
If you are setting up automated rostering with us as well, when a licensed Quaver teacher has successfully logged in through Canvas and reached their Quaver account they should see their rosters activated in Quaver.
Step 5: Release
When we have confirmed everything is working as expected, we will go ahead and release your integration on our end. Teachers can then add the Quaver External App to any Canvas course to support SSO from Canvas.