Configuring LTI Pro 1.3 for Canvas

Last Updated:

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

  1. Create a new LTI credential.
  2. (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.
  3. Click Save.

Creating a Client Id in Canvas

  • Log in to Canvas. 
  • Click Admin, then click Developer Keys.
  • Click Developer Key + LTI Key
  • There are two methods to create the integration, Manual Key Entry or the JSON method:
    • Manual Key Entry method 
      1. In the Key Name field, enter the name of the key.
      2. Copy the Tool Redirect URL in the LTI Pro configuration page, and paste it in the Redirect URIs field.
      3. For Method choose Manual Entry.
      4. Enter the Title for the app.
      5. Enter the Description for the app.
      6. Copy the Target Link URL in the LTI Pro configuration page, and paste it in the Target Link URI field.
      7. Copy the Login Initiation URL in the LTI Pro configuration page, and paste it in the OpenID Connect Initiation Url field.
      8. For JWK Method choose Public JWK URL.
      9. Copy the Public JWK URL in the LTI Pro configuration page, and paste it in the Public JWK URL field.
      10. Open Additional Settings and for Privacy Level choose PUBLIC.
    • JSON method
      1. In the Zoom LTI Pro configuration page, copy the Tool Redirect URL, and paste it in the Canvas Redirect URLs field.
      2. Change the Method, to Paste JSON.
      3. 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

  1. Find the LTI Key that was just created in the “Developer Keys“ list
  2. Set the State of the LTI Key to ON
  3. Go to LTI Pro Configuration Page.
  4. Click 3rd Party Credentials, LTI Canvas, then Add Instance.
  5. Add domain used to access Canvas to LTI Canvas Site Domain
  6. Copy the Client ID of LTI Key (number in Details column) to Client ID
  7. Click Save.

    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

    1. In Canvas, click Admin, then Settings.
    2. Click Apps, then View App Configuration.
    3. Click + App
    4. For Configuration Type, choose By Client ID.
    5. Copy the LTI Key Client Id from earlier,  and paste it into the Client ID field.
    6. Click Submit.
    7. Click Install.

Installing the app in a course

    1. On Canvas go to a course and click Modules.
    2. Click + in Module in which Zoom LTI will be added
    3. Click dropdown selection next to Add and select External Tool.
    4. Find and select the app/tool made created earlier.
    5. Click Add Item.

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.

  1. Within the Canvas LTI Developer key configuration created in the previous steps, select and add Course Navigation in the Placements field.
  2. Copy the Target Link URL from LTI Pro configuration page, and paste it in the Target Link URI field.
  3. Enter a description for the Text field.
  4. Click Save.

     

     

Adding the tool to the Module Group Menu

To provide a link to the LTI from a module group:

  1. In the Canvas LTI Developer Key configuration created in the previous steos, select and add Module Group Menu in the Placements field.
  2. Within the Zoom LTI Pro configuration page,  copy the Target Link URL and paste it into the Canvas Target Link URI field.
  3. In the Text field, enter the description of the tool.
  4. Click Save.

How to launch the LTI Pro 1.3 tool

    1. Click the App/Tool that was added to a Module in created earlier.
    2. If the app is successfully launched, the page will show as below:

Zoom Community

Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.