Configure SSO with Canvas

How to configure the Canvas Single Sign-On

This guide provides step-by-step instructions for configuring Canvas Single Sign-On (SSO) using the LTI 1.3 standard to enable secure access to the MHS Group Insights (MGI) application. By integrating with Canvas, districts can streamline educator and student login using existing credentials, simplify app deployment, and ensure accurate authentication across multiple classrooms. The setup process includes configuring a developer key, installing the MGI app, and activating the connection within the MGI platform.

Step-by-Step Instructions

  1. Sign in to Your Canvas Admin Account
    1.  Navigate to your Canvas Admin Dashboard.
    2. In the left-hand menu, go to Admin → Your Admin Account → Developer Keys.
  2. Create a New LTI Developer Key
    1. Click the + Developer Key button.
    2. Select + LTI Key as the key type.
    3. In the form that appears, set the method to Enter URL.
    4. In the JSON URL field, paste the URL provided to you by the Lead Implementation Specialist assigned to you. If you have not received this information, please contact them directly for assistance.
    5. Click Save to proceed.
  3. Activate the Developer Key
    1. On the Developer Keys list, locate the newly added key.
    2. Flip the State switch to green to activate it.
    3. Copy the Developer Key shown in the Details column.
  4. Install the MHS App
    1. Go to Admin → Your Admin Account → Settings → Apps.
    2. View App Configurations, then click + App.
    3. In the new app form, set Configuration Type to by Client ID.
    4. Paste the copied Client ID into the appropriate field.
    5. Click Submit and then Install.
  5. Retrieve Deployment ID
    1. Once installed, open the App’s Settings.
    2. Click Deployment ID.
    3. Copy the Deployment ID value—this value will be used in the MGI setup.
  6. Configure the MHS Group Insights (MGI) Application
    1. Log in to the MGI application.
    2. From the sidebar menu, click the icon that opens the Integration Settings page. (Refer to the screenshot below to identify the icon).
    3. On the Integration Settings screen, you’ll be prompted to choose between Rostering and SSO Integration.
    4. Select SSO Integration, then click Next to proceed with the setup.
  7. Add Canvas SSO Credentials
    1. In the next window, click Add New SSO Credentials.
    2. Select Canvas as the Integration Type.
    3. Paste the Deployment ID you copied in Step 5 into the External ID field.
    4. Click Save to complete the setup.
  8. Final Verification
    1. Return to the Canvas Portal.
    2. Your new SSO application should now be active and ready for student access.

Important: For students to successfully access their test through SSO, student emails must be included during rostering and a Test Plan must be created.

If either is missing, students will receive an error when attempting to log in.

Troubleshooting

If you run into any issues during setup, double-check the following:

  • The JSON URL was entered correctly during developer key creation.
  • The Client ID and Deployment ID were copied accurately.
  • Canvas credentials were entered properly in the MGI application.
  • App installation and activation were successfully completed in Canvas.

If you are experiencing problems, please contact the Implementation Team at [email protected]