Set Up an LTI 1.3 Component#
This document explains how to configure an LTI 1.3 tool using the LTI Consumer XBlock.
The LTI 1.3 capability supports tool launch and grade passback from the tool to the Open edX platform. It also supports the three LTI Advantage services: Deep Linking, Assignment and Grade Services (AGS), and Names and Role Provisioning Services (NRPS).
Note
If your instance has LTI Store enabled, a site operator can create a reusable LTI 1.3 configuration for you using the Django admin panel. See Set Up an LTI Component Using a Reusable Configuration.
Before You Start#
Configuring an LTI 1.3 tool is a two-way process. You need to configure the tool in your Open edX instance and get your instance configured in the tool.#
LTI 1.3 setup requires exchanging configuration values between your Open edX instance and the external tool.
Before you configure the tool, ask the tool vendor or review the tool’s documentation for the following information.
For the basic LTI 1.3 launch:
Tool’s Launch URL.
Tool’s Login URL, sometimes called the OIDC login URL.
Redirect URIs.
For LTI Advantage services:
Public key or public keyset URL.
Deep Linking launch URL if the tool supports Deep Linking.
Whether the tool uses Names and Role Provisioning Services (NRPS).
Whether the tool uses Assignment and Grade Services (AGS) to return scores.
For grading:
Whether the tool or activity returns scores to the Open edX platform.
If the tool uses AGS to return scores, whether the tool needs to manage gradebook columns.
For user information:
Whether the tool requires the learner’s username, full name, or email address during launch.
After you configure and save the LTI Consumer XBlock, Studio shows values that the tool will need to register your Open edX instance.
Step 1: Add and Configure the LTI Consumer XBlock#
Add the LTI Consumer XBlock from the Advanced component list in the course unit.#
In Studio, open the course unit where you want to add the external tool.
In the Add New Component area, click Advanced.
Select LTI Consumer. Studio adds the LTI Consumer XBlock to the course unit.
Edit the XBlock to configure the tool.
Note
For Teak and later releases, the LTI Consumer component is visible by
default. If you do not see LTI Consumer in Studio, add
"lti_consumer" to the Advanced Module List on the Advanced
Settings page. If the list already includes other tools, separate each
value with a comma.
If both LTI Consumer and the older LTI XBlocks appear in Studio, select LTI Consumer.
Configure the Setup Tab#
Use the Setup tab to enter the LTI 1.3 launch values provided by the tool.#
Note
The values in this section come from the LTI tool. After you save the XBlock, it will display a different set of values that you will need to register with the external tool.
Configure the Setup tab as per the following table:
Setting |
Guidance |
|---|---|
Configuration Type |
Selects whether the tool configuration is entered directly in this XBlock or an existing configuration is loaded from LTI Store. Leave Configuration Type set to New unless your site operator has already created a reusable configuration in LTI Store. |
LTI Version |
Set LTI Version to LTI 1.3. |
Launch URL |
The URL for the specific tool activity or content the user is trying to open. Enter the launch URL you obtained from the tool vendor/documentation. |
Tool Initiate Login URL (OIDC) |
The URL where the LMS starts the secure sign-in with the tool. Enter the login URL you obtained from the tool vendor/documentation. |
Registered Redirect URIs |
The approved URLs where the LMS is allowed to send the user back to the tool after the secure sign-in is complete. Enter the values as a JSON list, such as
If the tool does not require separate redirect URIs, leave this field blank. The Open edX platform uses the launch URL and, when configured, the Deep Linking Launch URL as defaults. If you enter redirect URIs, include every URI that the tool might request. Entering this field replaces the default list. Redirect URIs must match exactly, including the path and any trailing slash. |
Next |
Click Next to continue. |
Configure the Advantage Settings Tab#
The Advantage Settings tab appears only for LTI 1.3 tools.
Use the Advantage Settings tab only when the LTI 1.3 tool supports LTI Advantage services.#
Configure the Advantage Settings tab as per the following table:
Setting |
Guidance |
|---|---|
Deep linking |
Deep linking enables course teams to select content offered by the tool from within Studio. By default, Deep linking is Disabled. Enable this setting if the tool supports it. |
Deep Linking Launch URL |
Enter the Deep Linking launch URL provided by the tool. This field is required and only appears when Deep linking is Enabled. |
Assignment and Grades |
Assignment and Grade Services (AGS) allows the tool to send grades to the LMS and manage gradebook columns. Declarative (default): The Open edX platform creates a gradebook column (line item) automatically and shares it with the tool during launch. Programmatic: The Open edX platform does not create a gradebook column automatically but allows the tool to create and manage columns (line items). Set to Disabled if the tool does not support AGS. |
Names & Roles (NRPS) |
Names and Role Provisioning Services (NRPS) allow the tool to access enrollment and role information. It is disabled by default. Enable this setting only if the tool requires enrollment or role information from the Open edX platform. |
Tool Public Key Mode |
Appears when any LTI Advantage service is enabled. Choose how the Open edX platform gets the tool’s public key for validating LTI Advantage requests from the tool. Select Keyset URL if the tool provides a JWKS or keyset URL. Use Public Key only when the tool provides a static public key. |
Tool Public Key |
Appears when Tool Public Key Mode is set to Public Key. Enter the public key provided by the tool. The key usually starts with
|
Tool Keyset URL |
Appears when Tool Public Key Mode is set to Keyset URL. Enter the tool’s JWKS or keyset URL. Use this option when available because it supports key rotation without updating the component. |
Next |
Click Next to continue. |
Configure the Review Options Tab#
On the Review Options tab, configure the learner-facing behavior for the LTI component, such as the display name, grading, information sharing, custom parameters, and appearance.
Use the Review Options tab to configure learner-facing settings for the LTI component.#
Configure the Review Options tab as per the following table:
Setting |
Guidance |
|---|---|
Display Name |
Enter a title for this component so users can identify the activity in the course. |
This activity is graded |
Controls whether the component can receive a numerical score from the LTI tool. Set this to Graded if you are expecting the tool to return scores to your Open edX instance. |
Grade Weight |
Sets the number of points possible for the activity. |
Accept grades after due date |
Controls whether the LTI tool can send grades after the due date. |
Share Username, Share Full Name, and Share Email |
These settings control whether the learner’s username, full name, or email address is sent to the tool during LTI launch. They appear only when a site operator has enabled PII sharing for the course. For more information, see Allow Sharing PII to LTI Components. |
Data Sharing Notice |
A notice that appears before launch when any information-sharing setting is enabled. For more information, see Allow Sharing PII to LTI Components. |
Custom Parameters |
Sends custom parameters during tool launch. If the tool requires custom parameters, enter each parameter as
|
Send extra parameters |
Sends additional information configured by the site administrator during the tool launch. Unlike Custom Parameters, this information is generated automatically and can vary by learner, for example cohort or team membership. The default is Disabled. Enable this setting only when instructed by the site administrator because the information might include personally identifiable information (PII). |
Hide External Tool |
Controls whether the LTI tool is visible to learners. Set this to True for hidden tool launches, such as launches used only for grade synchronization. Leave this to False to display the tool to learners. |
Open tool in |
Controls how the course page opens and displays the LTI tool. Options include Inline, Modal, and New Window. |
Inline Height (px) |
Sets the height of the inline tool frame in pixels when Open tool in is set to Inline. |
Modal Height (%) |
Sets the height of the modal window as a percentage of the visible browser window height. Appears when Open tool in is set to Modal. |
Modal Width (%) |
Sets the width of the modal window as a percentage of the browser window width. Appears when Open tool in is set to Modal. |
Launch Button Text |
Sets the custom label for the button that opens the LTI tool. Appears when Open tool in is set to Modal or New Window. |
Save |
Click Save to save all configurations. |
Step 2: Register Your Open edX Instance with the Tool#
LTI 1.3 setup requires registration in both systems. You enter the tool’s values in the LTI Consumer XBlock, and the external tool also needs values from your Open edX instance.
After you save the LTI Consumer XBlock, Studio shows the Open edX instance values that the external tool will need.
The LTI Consumer XBlock provides these registration values:
Client ID
Deployment ID
Keyset URL
Access Token URL
Login URL
Important
Most LTI tools also require an Issuer. The XBlock does not display the
Issuer as a separate value. Derive it from the Keyset URL or
Access Token URL by removing the /api/lti_consumer/... path. Do not
add a trailing slash.
For example, if the Keyset URL is
https://openedx.io/api/lti_consumer/v1/public_keysets/..., the
Issuer is https://openedx.io. An Authoring URL such as
https://apps.openedx.io/authoring/... is not the Issuer.
Optional: Select Tool Content with Deep Linking#
Use the configure tool link to launch the external tool’s content selection workflow.#
If you enabled Deep linking for the component, use these steps to select content:
In Studio, open the unit containing the XBlock you just configured.
Click the Deep Linking Launch - Configure tool link on the XBlock.
Select the content in the external tool.
When the tool redirects back to Studio, confirm that the selected content is configured for the XBlock. Details of the content will appear on the XBlock in Studio.
After Deep Linking succeeds, Studio displays the selected content configuration on the LTI Consumer XBlock.#
Publish and Test#
Publish the unit.
Open the unit in the LMS and launch the LTI tool as a learner and, if relevant, as staff or admin.
Confirm that the tool opens correctly and shows the content selected in deep linking.
If the component is graded, confirm that scores return to the Open edX platform as expected.
Note
LTI 1.3 launches work only with published blocks and only from the LMS, not Studio. Publish the unit before launching the tool.
See also
About the LTI Component (concept)
Set Up an LTI 1.1 Component (how-to)
Set Up an LTI Component Using a Reusable Configuration (how-to)
LTI Advantage Services (reference)
Maintenance chart
Review Date |
Working Group Reviewer |
Release |
Test situation |
2026-07-13 |
Aamir Ayub |
Verawood |
Pass |