Guide: IMS 1.3 test tool integration

Guide: IMS 1.3 test tool integration

Here are the steps that i’ve used to configure xblock with LTI 1.3 test tool offered by IMS:

  1. Visit LTI v1.3 Reference Implementation Test Tool to by IMS here https://lti-ri.imsglobal.org/lti/tools.

  2. Click on “Add Tool”.

    1. image-20260114-093835.png
  3. It’ll show you a lot of input fields.

    1. image-20260114-094214.png
  4. Name: Add anything here.

  5. For Private key, visit https://lti-ri.imsglobal.org/keygen/index. You’ll find public and private keys here. Copy/paste the private key.

    1. image-20260114-094716.png
  6. Go to Open edX Studio. Create an xblock with type “LTI Consumer”.

    1. image-20260114-095153.png
  7. Edit the xblock. Add anything in Display Name and LTI Application Information. Select LTI Version as LTI 1.3. Click “Save”. LTI xblock will be saved and will show a bunch of information like in the image below.

    1. image-20260114-100139.png
  8. Copy Client ID value from xblock and paste in Client field in IMS tool.

  9. Copy Deployment ID from xblock and paste in Deployment field in IMS tool.

  10. Copy Keyset URL from xblock and paste in Keyset url field in IMS tool.

  11. Copy Access Token URL from xblock and paste in Oauth2 url field in IMS tool.

  12. Copy Login URL from xblock and paste in Platform oidc auth url field in IMS tool.

  13. Click on “Create tool”. You should see a message saying “Tool was created successfully”.

    1. image-20260114-101405.png
  14. Take note of the URL of the page you are redirected to. It should be like https://lti-ri.imsglobal.org/lti/tools/5852. The number at the end, 5852, is the tool ID.

  15. Again edit the xblock. Set Tool Public Key Mode to Public Key   

  16. Copy public key from https://lti-ri.imsglobal.org/keygen/index and paste in Tool Public Key.

  17. Create tool launch URL as https://lti-ri.imsglobal.org/lti/tools/<tool_id>/launches where tool_id is what we extracted above. Paste the URL in Tool Launch URL.

  18. Create tool initiate login URL as https://lti-ri.imsglobal.org/lti/tools/<tool_id>/login_initiations. Again, replace the tool_id with what we extracted above. Paste the URL in Tool Initiate Login URL.

  19. Click “Save”. Publish the unit. View unit in LMS. You should see the IMS tool interface.

    1. image-20260114-112651.png
  20. Click on “Send GET Request”. If launch is successful, you should receive a message like in the image below.

    1. image-20260114-120116.png

You need to launch the tool from the LMS, not from Studio.

Points to incorporate:

  • Launch from new window.

  • User same browser session for IMS and Open edX for logged-in testing.