TABLE OF CONTENTS
- Getting Set Up in Canvas
- Common Questions
Getting Set Up in Canvas
Have your Organization's Canvas Admin submit a Help Desk Ticket Here
LTI 1.3 must be installed by the Site Administrator and the LMS Administrator. It can’t be installed by teachers or course managers. For more information about LTI 1.3’s security features, refer to Why Platforms and Tools Should Adopt LTI 1.3 by IMS Global.
Install and Configure the App in Canvas
As the LMS Administrator, your Site Administrator will provide you with setup URLs and these instructions. Follow these steps to create a new LTI Tool in Canvas.
As the LMS Administrator, log in to Canvas and select Admin from the left navigation.
Click Developer Keys from the inner left navigation.
Select the blue Developer Keys button. Choose LTI Key from the dropdown menu.
On the Key Settings screen, enter the required information.
For Redirect URI, enter the value provided by your Site administrator.
For Method, choose Manual Entry.
Title is the name of the LTI 1.3 tool that you will send to instructors so they can add use the tool in their course.
For the Target Link URI, enter the Redirect URI again.
For OpenID Connection Initiation Url, enter the value provided by your Site administrator.
For JWK Method, choose Public JWK.
For Public JWKS, enter the value provided by your
Now scroll down to Placements.
Delete Account Navigation, which is populated by default.
Begin entering Editor and then select Editor Button to add it beside Link Selection.
Select > next to Link Selection to expand the page.
In the Target Link URI field, copy and paste the Target Link URI that you entered earlier on this page.
In the Icon URI field, enter the value provided by your administrator.
For Select Message Type, choose LtiDeepLinkingRequest.
For Text, enter the name of the LTI tool.
Select > next to Editor Button to expand the page and enter the same values as you did for Link Selection.
Click Save below the completed Link Selection and Editor Button sections.
LMS Admin Sends the Client ID to the Site Administrator
After you save the Key Settings screen, you will go back to the Developer Keys screen. Alternatively, log in to Canvas, select Admin from the left navigation, and select Developer Keys from the inner left navigation.
Copy the Client ID from the Details column and start an email to the Site administrator who will complete the setup. Copy the value directly above Show Key. Don't click Show Key to see and copy a longer ID. You want the shorter version. To avoid configuration errors, please email the text instead of a screenshot.
Note: The State button for the Developer Key you created should be Off (red button) until the Site Administrator notifies you that the setup is complete. If the State button is On before the setup is complete, instructors attempting to add content to their courses will receive the error message “Client ID not found.”
The Site Administrator also needs the Deployment ID as explained in the next section in this article, so don’t send the email yet.
Install the Tool in Each Canvas Account and Get the Deployment ID
To complete this operation, you need the Client ID as explained in the previous section of this article.
Log in to Canvas, select Admin from the left navigation, and choose the appropriate account.
Select Settings from the inner left navigation.
Click to copy the shorter Client ID as explained in the previous section of this article.
Select Settings from the inner left navigation, and then select the Apps tab at the top of the screen.
Click View App Configurations.
Click + App.
Select By Client ID.
Enter the Client ID and select Submit.
Go back to the External Apps screen to get the Deployment ID for the Site administrator. Select the gear icon associated with the new LTI tool, and choose Deployment ID.
Copy the Deployment ID and paste it into your email with the Client ID. Send the email to the Site Administrator.
Deploy the Tool to Instructors
After the Site Administrator notifies you that the setup is complete, log in to Canvas, select Admin from the left navigation, and click Developer Keys from the inner left navigation.
Change the State button on the Developer Keys screen to On (green button) in Canvas. Note: A delay may occur between this State change and when the tool appears in the list of available tools for instructors to use. Test before communicating with instructors.
Inform Instructors that the LTI Tool is ready to be used!
What does the LTI Tool do?
The LTI 1.3 tool allows any educator to find learning activities that have been published to Featured Collections on your site, and embed them within assignments, modules, or other Canvas pages. If educators are members of Groups or already have a Personal Account account on your site where they have been authoring or curating content, educators will be able to access and embed content from Group Shared Folders and personal My Items libraries using this tool.
Do I need an existing account on this site to use the LTI Tool?
When a course instructor launches the LTI tool, a new account will be automatically generated if the instructor doesn't already have one. This gives the Instructor access to all Featured Collections.
If I do have an existing account on this site, how do I connect it to my Canvas account?
If a user has previously created an account on the platform, and then later launches the LTI Tool in the LMS, the user will be asked for a one-time identity verification to confirm linking their accounts. The user should click the Link Accounts button to verify their identity.
For example, the user will see a message that looks similar to the message below:
How do Students Access Content?
Account information for student users is not collected or stored. Instead, students have view-only access to content that their instructors have embedded in Canvas courses.
How Do I use the LTI Tool?
Below are preview images of the content provided by the LTI tool. When an instructor adds a new activity using the LTI tool, the instructor will be able to search and browse items in Featured Collections, their own personal saved My Items, and their Group folders.
This screen shows what browsing My Collections looks like in the LTI 1.3 tool.
This screen shows what browsing My Items looks like in the LTI 1.3 tool.
This screen shows what browsing My Group folders looks like in the LTI 1.3 tool.