4.20.2. Configuring Credentials for a Tool Consumer#

For each external learning management system or application (external LMS) that you want to allow access to your edX instances as an LTI tool consumer, you create OAuth1 credentials, and then configure your edX instance to allow access. Each external LMS that you configure as a tool consumer must have separate credentials.

After you complete the configuration of a tool consumer on your edX system, you can add the consumer credentials to your external LMS. For examples of how course teams might set up a course on an external LMS as a consumer of edX course content, see Using Open edX as an LTI Tool Provider in the Building and Running an edX Course guide. Configure the Tool Consumer#

To configure an LTI tool consumer to have access to your Open edX installation, follow these steps.

  1. Sign in to the Django administration console for your base URL. For example, http://{your_URL}/admin.

  2. In the LTI Provider section, next to LTI Consumers select Add.

  3. Enter the following information.

    • Consumer Name: An identifying name for the tool consumer.

    • Consumer Key: The console generates a unique key value for this tool consumer. Alternatively, you can use an external application to generate the key, and then enter it here.

    • Consumer Secret: The console generates a unique secret value for this tool consumer. Alternatively, you can use an external application to generate the secret, and then enter it here.


      Do not supply a value for the Instance guid field. The tool consumer generates and supplies a globally unique identifier.

    • Require User Account: Checking this makes the content available only for the learners who already have an account on the Open edX instance. This is useful when learners need to be linked between different LMS systems.

      By default, an anonymous Open edX system user is created and all the data is associated with that user. This flag can be used when it is desirable to associate the data, generated via LTI interactions, to actual learner accounts instead of an anonymous account. When this is checked, instead of creating an anonymous user automatically, a message requesting the learner to sign into Open edX is displayed on the first LTI launch and the content is presented after a successful sign in.


      The account linking happens only when the LTI Consumer sends the learners’ email to Open edX by setting the POST data attribute lis_person_contact_email_primary in the LTI Launch request. This feature has only been tested with Canvas LMS, with privacy setting set to “Email Only” or “Public”.

      With this flag checked, the LTI content embedded in iframes will require the following Django configuration.

      # Needed for passing user session with the LTI Request
      # Needed for showing pages in iframe
      X_FRAME_OPTIONS = "ALLOW-FROM <your-lti-consumer-domain>"
      • Setting this flag only associates future interactions of the learner. This flag cannot be used to migrate data from existing anonymous accounts to corresponding user accounts.

      • Unchecking the flag will not roll back the auto-linked users. In situations requiring rollback of this feature, it is recommended to create a new LTI Consumer with this flag turned off, and the new credentials be used in the LTI consumer application.

  4. Select Save at the bottom of the page.