Zoom LTI 1.3 Tool Provider Integration
OpenLearning supports multiple technologies to provide interoperability with other systems, tools, and apps. In this article we will be covering the Learning Tools Interoperability (LTI 1.3) integration with Zoom, a cloud-based video conference tool that allows you to set up virtual video and audio conferencing, webinars, live chats, screen-sharing, and other collaborative capabilities.
LTI 1.3 is based upon LTI 1.1 but uses the IMS Security Framework, which is based on the industry-standard protocol IETF OAuth 2.0 for authentication services along with JSON Web Tokens (JWT) for secure message signing and the Open ID Connect workflow paradigm. For more details, please refer to the ZOOM FAQ here.
Pre-requisite
- This integration is only available to education providers who have an Institution Plan subscription with OpenLearning
- Zoom Pro, Business, or Enterprise Plan
- Zoom account user with admin role permissions
Setting up Zoom with LTI 1.3
Step 1
Head over to the Zoom App Marketplace and download the LTI Pro app which will allow you to schedule/join/manage meetings within OpenLearning.
Step 2
Click on Sign In to Add and sign in with your Zoom administrator account to authorise and add this application to your account.
Step 3
Once installed toggle the option to Pre-Approve the integration installation for users within your plan to set up the integration. (this includes your own account).
Note: This option may not be required anymore, depending on the Zoom updates on their marketplace.
Step 4
Navigate to the Manage tab and click on Configure App
Step 5
Click on Create New Credentials and select LTI 1.3.
Enter a title for this and click Save.
Step 6
Take note of the LTI Credentials as you need this later when setting up the integration on the platform.
Step 7
Scroll down to the Approved Domain section and please ensure to include:
- https://www.openlearning.com
- your custom domain (if you have one)
Do make sure that the domains entered do not include a trailing /.
Note: For more information on setting up the Approved Domain on your LTI Pro configuration, please visit:
https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059624#configure-approved-domains
You don't need to change any other default settings.
Setting up Zoom Integration in the Portal
Step 1
Log in to OpenLearning and navigate to your Institution Settings > Integrations.
Step 2
Scroll down to the LTI Tool Providers section and click on + Add LTI tool provider.
Step 3
Enter the tool provider name, and on the Tool provider registration section, select LTI 1.3 for the LTI version.
Step 4
Enter the links taken from Zoom
- Launch URL: Target link URL from Zoom
- OIDC Launch URL Key: Login Initiation URL from Zoom
- Key set URL: Public JWK URL from Zoom
- Tool deep link service URL (optional) : Enter the Target link URL from Zoom
Step 5
Scroll down and enter a Key pair name and click on Generate keys to get a public/ private key pair
Step 6
In order for Zoom to verify administrator accounts, a valid email address must be passed from OpenLearning to the Zoom application.
Scroll down and select the option Personal Email Address under Email Settings.
This option will prompt each user on their first launch to confirm an email address that will be sent to Zoom to complete the sign-on process.
Leave everything else as it is for now and click Save.
Finalising set up on Zoom
Step 1
Enter into the LTI Tool that you've just created again and scroll down to the Registration details.
Step 2
Keep this tab open or copy the details here as you will need to add these into Zoom settings again.
Step 3
Head back to the Zoom credentials page and click on Edit on the LTI 1.3 credentials column that you set earlier.
Step 4
Click on the 3rd party credentials tab and select Others.
Step 5
Click on Add instance.
Step 6
Enter the details that are taken from the LTI Tool setting in OpenLearning from Step 2 into this section.
Site Domain : https://www.openlearning.com
Client ID: taken from OpenLearning zoom configuration
App configuration
Issuer URL: https://www.openlearning.com
Public Key URL : this is Keyset URL from OpenLearning
OIDC Authentication URL: this is OIDC Auth URL from OpenLearning
Access Token URL: this is OAuth2 Access Token URL from OpenLearning
Example:
Click Save to complete the set up.
Adding the Zoom LTI tool to a course
Step 1
On your preferred course page, click on the Edit button to go into Edit mode.
Step 2
Go to the Widget menu and select Integration from the category dropdown.
Step 3
Click or drag the Zoom widget icon onto your page as with any other widget.
Step 4
Click on the View button to save the changes. On the first launch, it will request to use your email address, which will be sent to Zoom to complete the sign-on process.
Administrator's View
As an administrator or facilitator of the course that has been included in the Zoom plan, it will give you these functionalities:
- Schedule and manage meetings
- Start or join meetings
- View upcoming meetings
- View and manage previous meetings and recordings
- Auto-provision a Zoom License for instructors
Learner's View
As a learner, you can then join the meeting which has been scheduled from the same OpenLearning page and able to:
- View upcoming meetings
- Join meetings
- View previous meetings and recordings
