Skip to main content

LTI 1.3 For Administrators: Setting Up the External Tool in Canvas

This article explains the instructions for administrators who wish to set up the LTI 1.3 tool in Canvas.

Sara Jenis avatar
Written by Sara Jenis
Updated this week

💡 If you had previously set up an LTI 1.1 Tool, please delete that tool prior to following these steps. If you had not previously set up a CodeHS tool, you can skip to Step 1.

Screenshot of the Canvas Admin's Settings page. We're on the Apps tab in the Settings page and deleting an external app.

★ Video Instructions

★ Step by Step Instructions

➤ Step 1: Create a new LTI 1.3 Developer Key

  1. In Canvas, click Admin → Developer Keys → + Developer Key → + LTI Key

Screenshot of the Developer Keys page highlighting the button for adding a new developer key.

  1. Enter the following to configure the tool:

Screenshot of the JWK method input field.

  1. Under LTI Advantage Services make sure to enable everything possible

Screenshot of the LTI Advantage services and all of the services you can toggle.

❗ Please enter everything exactly as listed below.

For example, the domain should only be codehs.com – do not include https://

1. Under Additional Settings, you must enter:

Screenshot of the additional settings section with the fields listed above highlighted.

2. Press Save

➤ Step 2: Get the Client ID

  1. Switch the new LTI 1.3 Developer Key to On

  2. Copy the Client ID in the Details column (do not click Show Key), and save it to send to CodeHS (Note: the client ID should only consist of numbers. If you see any letters, you might be looking in the wrong place.)

Screenshot of the Developer Keys table headers
Screenshot of the Developer keys table highlighting the Client ID under the Details column and the On state in the State column.

➤ Step 3: LTI 1.3 Tool Deployment

  1. Go to Admin → Settings → Apps → View App Configurations → + App

    Screenshot of Canvas Apps screen with an arrow pointing to the View App Configurations button
Screenshot of the Canvas Admin's Settings page. We are on the Apps tab, and there is a button in the top right corner to add an external app.

2. Select Configuration Type: By Client ID

3. Paste the Client ID from Step 2 and click Submit

Screenshot of the popup window for adding a new app with a Client ID input field.

💡 If you receive the below error message, please refer to Step 2 and

ensure you have copied the proper Client ID.

Screenshot of the error saying Could not find an LTI configuration for client ID

4. Install the CodeHS app by clicking Install.
​

5. On the View App Configurations page, find the CodeHS tool, click the gear icon,

and click Deployment ID.
​

6. Copy the Deployment ID to send to CodeHS

Screenshot of the External Apps page. To access the deployment ID, we click on the gear icon to the right of a tool's name, and then click Deployment ID.

💡 You should only see one CodeHS tool on this page. If you see two, the one without the Deployment Id should be deleted.

➤ Step 4: Send the following to CodeHS

  1. Client ID

  2. Deployment ID

  3. Canvas Instance URL (https://example.instructure.com)

Once we complete the setup on our end, we will send a confirmation email with follow-up instructions. Direct any questions to your Customer Success Manager or support@codehs.com.

A video walkthrough of these instructions can be found above and at codehs.com/canvas/ltiadvantage/setup/demo

Still have questions? Contact our team at support@codehs.com to learn more!

Did this answer your question?