Configuring Zoom App for Canvas (Deprecated) Follow

Note: The Canvas App integration has been deprecated. This article is provided for organizations that have already configured the Canvas App with Zoom. If you are integrating Zoom and Canvas for the first time, learn more about the Canvas Enhanced LTI

Overview

The Zoom for Canvas Integration supports the ability to schedule meeting, list upcoming meeting, list history meeting and join meeting within the Canvas account. Users can leverage Zoom meetings from within a Canvas course. Features include creating, joining and deleting a Zoom meeting; as well as creating Calendar Event and creating Canvas Conversation.

This article covers:

Instructions

The Canvas Admin must generate a Developer Key for OAuth authentication, and then enter the Developer ID and Developer Key into the Zoom Integration for LTI Canvas.

How to generate the Developer Key

  1. Sign into Canvas as an Admin.
  2. Click the Admin tab, then click Developer KeysScreen_Shot_2017-09-01_at_10.49.16_AM.png
  3. Click Add Developer Key to display the Key Settings dialog.
  4. Enter a value (such as Zoom) in the Key Name field.
  5. Enter the email address of the Zoom account owner in the Owner Email field.
  6. Enter the value https://zoom.us/canvas/oauth/complete in the Redirect URIs field.
    Note: The site domain is zoom.us; Do not use www.zoom.us
  7. Click Save Key.
    Screen_Shot_2017-09-01_at_10.53.32_AM.png
    Screen_Shot_2017-09-01_at_10.56.36_AM.png
    The Developer Keys section displays the Developer ID and Developer Key. In this example, the Developer ID is 1117590000000000002 and the Developer Key is Q8s4EGhZZ6gNNXcfVPcrV1IlaayIX4DPBqYENIRSoosgeU4J5UisrG2T9tgGwvw8.

How to enter the Developer ID and Developer Key in Zoom

  1. Login to your Zoom web portal and navigate to Integration
  2. Next to LTI Canvas, click Configure.
    Screen_Shot_2018-05-30_at_3.13.11_PM.png
  3. Click Add Instance.
    Screen_Shot_2018-05-30_at_3.18.03_PM.png
  4. In the Canvas Zoom App fields, input the Developer ID and the Developer Key values that were generated by Canvas in the previous procedure.Screen_Shot_2018-05-30_at_3.18.12_PM.png
  5. Click Save.
  6. Next to LTI, Click Configure.
    Screen_Shot_2018-05-30_at_3.19.56_PM.png
  7. Note the values of the LTI Key and LTI Secret in the LTI section of the Integration menu. These values will be used in the Installation section of this document.
    Screen_Shot_2017-09-01_at_11.21.25_AM.png

    In this example, the LTI Key is n6y7x14iSFKRbfUgWXwHQg and the LTI Secret is 8483XNDHFNAp0yXw2NyNwDTGHr5DwawkuCV6.

How to Install the Canvas App
The Canvas App must be added by a Canvas admin.

  1. Sign in to Canvas and click Admin, then Account
  2. Click Settings
  3. Click the Apps tab and click View App Configuration.
  4. Choose Configuration Type – By URLL.
  5. Specify the name – ZOOM.
  6. Specify the Config URL - https://www.zoom.us/canvas/lti-config.xml
    Note: 
    This configuration URL automatically displays the Zoom link in course navigation. If you would like to hide the course link by default, you can install with the following URL instead: https://www.zoom.us/canvas/lti-config.xml?CNE=false
  7. Specify the Consumer Key - the Zoom LTI Key from the previous section.
  8. Specify the Shared Secret - the Zoom LTI Secret from the previous section.
  9. Click Submit.
    The app named ZOOM is added. When you go to the course, you see the ZOOM link in the Course Navigation.Screen_Shot_2017-09-01_at_11.29.05_AM.png
    Screen_Shot_2017-09-01_at_11.29.45_AM.png

How to Install Zoom in the Course Navigation

If you chose to install Zoom with the https://www.zoom.us/canvas/lti-config.xml?CNE=false URL, the Zoom link will hidden from your course navigation by default. Complete the following steps to add it to the navigation.

  1. Login to Canvas as the course instructor or administrator and navigate to the course where you would like to add the Zoom link.
  2. Click Settings
    Screen_Shot_2018-02-21_at_12.56.57_AM.png
  3. Click Navigation.
    Screen_Shot_2018-05-31_at_5.19.23_PM.png
  4. Drag Zoom from the hidden items to the place where you would like it to appear in the navigation.
    canvas-addtocoursenav.gif
  5. Click Save.

How to Grant Access to Zoom

When the Canvas Admin configures the Canvas App and installs the Canvas App, a Teacher/TA/Course Designer sees the Zoom menu link in a Course Navigation. A Student/Observer does not see the Zoom menu link.

Screen_Shot_2017-09-01_at_11.35.01_AM.png

When a user clicks the Zoom link, the Authentication page displays. The user clicks the Authenticate button to begin the authorization process.

Screen_Shot_2017-09-01_at_11.39.26_AM.png

Screen_Shot_2017-09-01_at_11.39.37_AM.png

Only a Canvas user who has a Zoom account with the same email address as their Canvas email address is authorized to use Zoom within Canvas. If Zoom does not have a user with this email address, the user sees an error message stating “The user xxx@xxx is not a Zoom user.”

Screen_Shot_2017-09-01_at_11.40.46_AM.png

Auto Provisioning Zoom Users

You can allow Canvas to automatically provision Zoom users when they login the first time. If you have installed multiple instances of Canvas, enabling auto provisioning will apply for all accounts. 

  1. Login to your Zoom web portal and navigate to Integration
  2. Next to LTI Canvas, click Configure.
    Screen_Shot_2018-05-30_at_3.13.11_PM.png
  3. Click Auto Provision.
    Screen_Shot_2018-05-30_at_3.13.19_PM.png
  4. Check Enable Auto Provision.
  5. Enter a default password.
  6. Click Save Changes.

Possible Errors

  • If the Consumer Key was not configured correctly during the installation process for External Apps, users see the following error message instead of the Authentication page.Screen_Shot_2017-09-01_at_11.41.56_AM.png
  • If the Shared Secret was not configured correctly during the installation process for External Apps, users see the following error message instead of the Authentication page.
    Screen_Shot_2017-09-01_at_11.43.05_AM.png

Information for using Canvas as a meeting host can be found here

 

Was this article helpful?
Have more questions? Submit a request