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. 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 paste values from xblock into IMS tool edit modal.

    1. Client IDClient

    2. Deployment ID -> Deployment

    3. Keyset URL -> Keyset url

    4. Access Token URL -> Oauth2 url

    5. Login URL -> Platform oidc auth url

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

    1. image-20260114-101405.png
  10. 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.

  11. You can navigate to the tool created using the URL you copied or by “claiming” the tool from unclaimed tools if you are logged in.

  12. Again edit the xblock. Set Tool Public Key Mode to Keyset URL.   

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

  14. Now copy paste values from the tool back into the XBlock config modal:

    1. Tool launch URLTool launch URL

    2. Tool launch URLRegistered Redirect URIs

    3. Tool OIDC Login Initiation URL->Tool Initiate Login URL

    4. Tool JWT Key Set URLTool Keyset URL

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

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

    1. image-20260114-120116.png

Things to consider

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

  • When performing deep linking, you need to launch the tool from the same browser that you have IMS tool opened in.

  • To test AGS and NRPS:

    • You’ll need to login to your IMS account. Its for member orgs only i think but i may be wrong.

    • You’ll need to set LTI Launch Target to New window in XBlock config. Iframe doesn’t work for logging into IMS account.