Kaltura LMS integration for Canvas - Deployment guide LTI 1.3

Last Modified on 10/30/2024 11:45 am IST

About

This guide explains how to add the Kaltura LMS Integration for Canvas with LTI version 1.3. The integration is implemented using a set of LTI external tools, manually added through an LTI Developer Key in Canvas. The key is populated using a JSON block to enable the LTI Tool Provider and configure tool placements within Canvas.

Prerequisites

  • A Kaltura administrator account
  • A KAF instance for Canvas, minimum version 5.99.46
  • A Canvas administrator account

 Step 1 - Enable LTI 1.3

  1. In your Configuration Management console, navigate to the Hosted module.
  2.  On the Hosted module page, locate the authMethod field and select lti1.3 from the dropdown.

    3. An additional section displays.

  3. Confirm that the three fields listed below are auto-populated.

    If the fields are NOT auto-populated then you need to set them as follows:

    • lti13PlatformOidcAuthUrl = https://{your_Canvas_Domain}/api/lti/authorize_redirect
    • lti13AuthTokenUrl = https://{your_Canvas_Domain}/login/oauth2/token
    • lti13KeysUrl = https://{your_Canvas_Domain}/api/lti/security/jwks

    Make sure the URL you enter has no spaces before, after, or within it.

  4. Scroll down to the LTI3ServicePrivateKey section and click the Generate key pair here. This will generate the keys.
  5. In the Certificate Generator frame, click Use to have the key pairs saved to the lti13ServicePrivateKey and lti13ServicePublicKey fields.
  6. Scroll to the bottom of the Hosted module page and click Save.

Step 2 - Generate LTI developer key JSON

Enter the following URL in your browser: https://{your_KAF_URL}/canvas/config/create-json-for-instance Example:https://12345.kaf.kaltura.com/canvas/config/create-json-for-instance

If you're using a KAF domain other than .kaltura.com, make sure to use it as the input for your_KAF_URL.

The JSON will be used in the next step to create the LTI developer key.

Step 3 - Create LTI developer key

  1. Log into your Canvas instance as an administrator. 
  2. Click the Admin tab.
  3. Click the Developer Keys tab.

    4. The Developer Keys page displays.

  4. Click +Developer Key and select + LTI Key from the drop-down list.

    5. The Key Settings page displays.

  5. Configure the following:
  • Key Name - Enter 'Kaltura Video Plugin'.
  • Owner email - optional
  • Redirect URIs - Enter https://{your_KAF_URL}/hosted/index/oauth2-launch Example:https://12345.kaf.kaltura.com/hosted/index/oauth2-launch

    • If you're using a KAF domain other than .kaltura.com, make sure to use it as the input for your_KAF_URL.

  • Notes - optional
  • Method - Select Paste JSON from the drop-down list.

6. In the LTI 1.3 Configuration field, copy the JSON code (not including the brackets) from the previous section (Generate LTI developer key JSON) and paste it between the brackets.

7. Scroll down and click Save.

The new LTI developer key will now be listed on the Developer Keys page. If the State is set to off (red), it means the key is disabled. To enable the key, click the toggle (green).

Step 4 - Configure the LTI developer key LTI advantage services

In order for the LTI developer key to work properly, certain LTI advantage services must be enabled.

  1. Edit the LTI developer key you created by clicking on the pencil icon to the far right of the key.

    2. The Key Settings page displays.

  2. In the Method field, change to Manual entry.

  3. Scroll down to the LTI Advantage Services section and click to expand the section.

  4. Make sure the following LTI Advantage Services are turned on in addition to others that are enabled:
  • Can create and view assignment data in the gradebook associated with the tool.
  • Can view assignment data in the gradebook associated with the tool.
  • Can view submission data for assignments associated with the tool.
  • Can create and update submissions for assignments associated with the tool.
  • Can retrieve user data associated with the context the tool is installed in.
  • Can update publish jwk for LTI services.

5. Click Save if you have made any changes.

Step 5 - Confirm the values in the LTI developer key additional settings

  1. Click Additional Settings to expand the section.

  2. Review the following fields:
  • Domain - your KAF domain without the https://
  • Tool Id - your KAF URL including https://
  • Icon Url, Text, Selection Height, Selection Width – leave blank
  • Custom Fields - include the following three custom parameters:
    • custom_canvas_user_id=$Canvas.user.id
    • custom_canvas_course_id=$Canvas.course.id
    • custom_canvas_user_login_id=$Canvas.user.loginId

Step 6 - Confirm or edit LTI developer key placement settings

Clicking on the bubble in the placements box will delete the placement. To edit a placement, click on the > icon to the left of each placement listed.

Canvas only allows each placement to be used once per developer key. The JSON file generated by Kaltura includes five placements.

Review and edit the Text field for each tool placement as needed:

  • Link Selection: For the Kaltura Browse Search and Embed tool, used to create video pages.
  • Course Navigation: For the Kaltura Course Media Gallery.
  • Global Navigation: For the Kaltura My Media tool in the global left-hand navigation.
  • Editor Button: For the Kaltura Browse Search and Embed tool in the Canvas Rich Content Editor.
  • Assignment Selection: For the Kaltura Interactive Video Quiz in the Canvas Assignment tool.

Step 7 - Set the 'lti13ClientID' value for the LTI developer key

  1. In Canvas, navigate to the Developer Keys page (https://{your_Canvas_base_URL}/accounts/1/developer_keys) .
  2. On the Developer Keys page, locate the listing for the developer key you created in Step 3 - Create LTI Developer Key and copy the Client ID from the Details column.

  3. Log into your Configuration Management page (https://{your_KAF_base_URL}/admin).
  4. Navigate to the Hosted module (https://{your_KAF_base_URL}/admin/config/tab/hosted).
  5. Scroll down to the lti13ClientID field and paste in the Client ID.

  6. Scroll to the bottom of the Hosted module and click Save.

Step 8 - Configure the Kaltura user ID value

The default Kaltura User ID is your Canvas User ID, which is often the same as the user’s email address. If your organization uses a different value for User IDs, please refer to Configuring the Kaltura User ID Value to Use with Your LMS Integration before proceeding.

With the Kaltura LMS integration, user ID records are passed from the LMS to Kaltura during the LTI Launch. When using LTI 1.3 authentication, admins can configure which LTI attribute to use for the user ID in the KAF Hosted module.

Kaltura uses a custom parameter in Canvas to store the User ID value. To set this up:

  1. Log into your Configuration Management page (https://{your_KAF_base_URL}/admin).
  2. Navigate to the Hosted module (https://{your_KAF_base_URL}/admin/config/tab/hosted).
  3. Scroll down to the ltiUserIdAttribute setting.
  4. Set ltiUserIdAttribute to custom_canvas_user_login_id.
  5. Scroll to the bottom of the Hosted module and click Save.

Step 9 - Set the API developer key 

Option 1 – Inherited API Key

If your KAF domain is on *.kaltura.com, you can use the existing inherited Kaltura key without creating a new API key. You may, however, prefer to use a Scoped API Developer Key. In that case, jump to Option 2 below. 

  1. Log into Canvas as an administrator.
  2. Navigate to the Developer Keys page. 
  3. On the Developer Keys page, click the Inherited tab.

  4. Scroll down and click Show All Keys.

  5. Scroll to the listing for the Kaltura key and click the toggle to enable it.

  6. A confirmation message displays: Are you sure you want to change the state of the developer key [name]?  

  7. Click Switch to On. When the key is enabled, it turns green.

    8. Go to Step 11 - Add Kaltura tools. 

Option 2 – Scoped API developer key

If your KAF domain is not on *.kaltura.com, or you prefer added security, you’ll need to create a Scoped API Developer Key.

  1. Log into Canvas as an administrator.
  2. Navigate to the Developer Keys page. 
  3. On the Developer Keys page, click on + Developer Key and select + API Key from the drop-down list.

    4. The Key Settings page displays.

  4. Enter the following:
    • Key Name - 'Kaltura Scoped Key'
    • Owner Email - Optional
    • Redirect URLs - Enter your KAF URL starting with https:// .Use your vanity domain if you have implemented one.
    • Redirect URL (Legacy) - Enter your KAF URL starting with https:// .Use your vanity domain if you have implemented one (the value should be the same as used in the Redirect URLs field).
    • Vendor Code (LTI 2) - Leave blank.
    • Icon URL - Optional
    • Notes - Optional
    • Test Cluster Only – Leave unchecked.
    • Client Credentials Audience – Canvas should be selected.
  5. Scroll to the top and click on Enforce Scopes to display all the available scopes.

    6. The Enforce Scopes section expands.

    Leave Allow Include Parameters unchecked

  6. Scroll down to Courses and click to expand.

  7. Check the following scopes:
    • url:GET|/api/v1/courses
    • url:GET|/api/v1/courses/:id

  8. Click Save.
  9. Click the toggle to enable the key.

    10. A confirmation message displays: Are you sure you want to change the state of the developer key [name]?

  10. Click Switch to On. When the key is enabled, it's green.

    11. Continue to Step 10.

Step 10 - Set the API developer key in the Canvas module

The lti13ClientID value in the Hosted module tells KAF which Canvas LTI developer key to connect to.

Only complete this step if you used Option 2 - Scoped API Developer Key above.

  1. Log into your Configuration Management page (https://{your_KAF_base_URL}/admin).
  2. Navigate to the Canvas module (https://{your_KAF_base_URL}/admin/config/tab/canvas).
  3. In the useScopedKey field, set to 'Yes'.

    4. This will expose the customAppId and customAppKey settings.

  4. Fill in the customAppId and the customAppKey fields using the Key ID and the Key for the API Developer Key you created in Option 2 above. You can locate the keys as follows:
  5. Copy the Client ID and paste into the customAppId field in the Canvas module.
  6. Click Show Key, copy the key and paste it into the customAppKey field.

  7. Scroll to the bottom of the Canvas module and click Save.

Step 11 - Add Kaltura tools 

Once you've completed the previous steps, you can add the Kaltura external tools.

  1. Log into Canvas as an administrator and navigate to the Developer Keys page.

  2. On the Developer Keys page, locate the LTI developer key you created and copy the Client ID from the Details column.

  3. In the left-hand navigation, click the Settings tab (https://{your_Canvas_base_URL}/accounts/1/settings#tab-settings).

    4. The Settings page displays.

  4. On the Settings page, click the Apps tab.

    5. The External Apps page displays.

  5. Click View App Configurations.

    6. A list of apps displays.

  6. Click +App.

    7. The Add App page displays.

  7. Click on the Configuration Type drop-down menu and select By Client ID.

  8. Paste the Client ID copied in Step 3 - Create LTI developer key into the Client ID field.

  9. Click Submit.

Canvas LTI tool placements

Instructure provides multiple placements for external tools in Canvas. The recommended Kaltura placements align with those used in earlier LTI versions. Note that placement limitations may apply depending on where the Kaltura tools are added within the Canvas account structure (account, sub-account, course). See Step 11 - Add Kaltura tools.

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In This Article
Related Articles
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter