This article provides specific instructions for configuring Zoom’s LTI Pro with Canvas.
Note: Please ensure that LTI Pro has been installed and you are signed in to configure LTI Pro.
This article covers:
Configuring LTI Pro on Canvas
Creating new credentials
- Create a new LTI credential.
- (Optional) Update a credential from LTI 1.1. to LTI 1.3. in the configuration page by choosing LTI 1.3 under Select which LTI version to use.
- Click Save.
Configure the Approved domains
- In the Zoom Marketplace as an admin.
- Click Manage, then click Apps on Account.
- Find the LTI Pro App.
- Under the Action column, click the
More icon, then click Configure. - Find your LTI credentials and click Edit.
- Under the LTI Credentials tab, navigate to Approved Domains.
- Enter the domains that will be utilized to access the LMS.
Creating a Client Id in Canvas
- Log in to Canvas.
- Click Admin, then click Developer Keys.
- Click Developer Key + LTI Key
![canvas-developer-lti-key.png](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/developer-lti-key.png)
- There are two methods to create the integration, Manual Key Entry or the JSON method:
- Manual Key Entry method
- In the Key Name field, enter the name of the key.
- Copy the Tool Redirect URL in the LTI Pro configuration page, and paste it in the Redirect URIs field.
- For Method choose Manual Entry.
- Enter the Title for the app.
- Enter the Description for the app.
- Copy the Target Link URL in the LTI Pro configuration page, and paste it in the Target Link URI field.
- Copy the Login Initiation URL in the LTI Pro configuration page, and paste it in the OpenID Connect Initiation Url field.
- For JWK Method choose Public JWK URL.
- Copy the Public JWK URL in the LTI Pro configuration page, and paste it in the Public JWK URL field.
- Open Additional Settings and for Privacy Level choose PUBLIC.
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/canvas-open-additional-settings.png)
- JSON method
- In the Zoom LTI Pro configuration page, copy the Tool Redirect URL, and paste it in the Canvas Redirect URLs field.
- Change the Method, to Paste JSON.
- In the following JSON script, for the oidc_intiation_url, replace <YOUR LTI PRO 'Login Initiation URL'>, with the Login Initiation URL found on the Zoom LTI Pro configuration page.
{
"title": "Zoom",
"scopes": [
"https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly"
],
"extensions": [
{
"platform": "canvas.instructure.com",
"settings": {
"platform": "canvas.instructure.com",
"placements": [
{
"placement": "account_navigation",
"message_type": "LtiResourceLinkRequest"
},
{
"placement": "link_selection",
"message_type": "LtiResourceLinkRequest"
},
{
"placement": "course_navigation",
"message_type": "LtiResourceLinkRequest",
"default": "disabled",
"enabled": "true"
}
]
},
"privacy_level": "public"
}
],
"description": "Zoom LTI Pro",
"custom_fields": {
"canvas_course_id": "$Canvas.course.id"
},
"public_jwk_url": "https://applications.zoom.us/lti/advantage/jwks",
"target_link_uri": "https://applications.zoom.us/lti/advantage",
"oidc_initiation_url": "<YOUR LTI PRO 'Login Initiation URL'>"
}
- Click Save.
Note:
- The Scopes line (line 3) of the JSON script, lists the LTI Advantage scopes that Zoom LTI Pro will have access to.
- If you would like to have a link to the Zoom LTI Tool in all courses, change the default value (line 23) to enabled.
- If you need to provide LTI parameters for your LTI Pro configuration, you can add them to the custom_fields section of the JSON script (line 32).
Adding the Client Id to LTI Pro Canvas configuration
- Find the LTI Key that was just created in the “Developer Keys“ list
- Set the State of the LTI Key to ON
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/set-lti-on.png)
- Go to LTI Pro Configuration Page.
- Click 3rd Party Credentials, LTI Canvas, then Add Instance.
- Add domain used to access Canvas to LTI Canvas Site Domain
- Copy the Client ID of LTI Key (number in Details column) to Client ID
- Click Save.
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/client-id-save.png)
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/canvas-instance-added.png)
Note: If multiple domains are used to access Canvas (like https://school.instructure.com and https://canvas.school.edu), then repeat Steps 3.3.1 through 3.3.3 for each domain that is used to access Canvas.
How to create and install the canvas app
Creating a Canvas app
-
- In Canvas, click Admin, then Settings.
- Click Apps, then View App Configuration.
- Click + App
- For Configuration Type, choose By Client ID.
- Copy the LTI Key Client Id from earlier, and paste it into the Client ID field.
- Click Submit.
- Click Install.
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/add-app-paste-client-id.png)
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/add-app-install.png)
Installing the app in a course
-
- On Canvas go to a course and click Modules.
- Click + in Module in which Zoom LTI will be added
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/canvas-add-module.png)
- Click dropdown selection next to Add and select External Tool.
- Find and select the app/tool made created earlier.
- Click Add Item.
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/canvas-add-item.png)
How to configure the tool placements
Once the tool has been installed, its placement can be configured. Below are the different options for configuring the placement of the tool:
Adding the tool to Course Navigation
To provide a link to the LTI from course navigation modify the key setting as follows:
Note: This will automatically add the Zoom tool link in all courses.
- Within the Canvas LTI Developer key configuration created in the previous steps, select and add Course Navigation in the Placements field.
- Copy the Target Link URL from LTI Pro configuration page, and paste it in the Target Link URI field.
- Enter a description for the Text field.
- Click Save.
Adding the tool to the Module Group Menu
To provide a link to the LTI from a module group:
- In the Canvas LTI Developer Key configuration created in the previous steos, select and add Module Group Menu in the Placements field.
- Within the Zoom LTI Pro configuration page, copy the Target Link URL and paste it into the Canvas Target Link URI field.
- In the Text field, enter the description of the tool.
- Click Save.
How to launch the LTI Pro 1.3 tool
-
- Click the App/Tool that was added to a Module in created earlier.
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/click-added-module.png)
- If the app is successfully launched, the page will show as below:
![](https://assets.zoom.us/images/en-us/integration/lti-lms/canvas/app-successfully-launched.png)