This LTI® v1.3 Reference Implementation Test Tool is provided by IMS Global Learning Consortium. Limited functionality is provided free of charge. IMS Members have access to the complete functionality of the tool including services and message types. Join now to experience full functionality of the tool, technical support and certification. If you are an existing member login here for full access.

Instructions

We will open various configuration pages in new tabs as part of these instructions. These instructions will guide you through setting up a Tool and Platform, culminating in a launch from RI Platform to RI Tool.

If you wish to setup only a Tool or Platform for use with your software, it is still recommended to set up both in RI and verify setup is good. Once verified, you can replace the Tool or Platform in the RI with your own.

Step 1: Generate public / private key pair

Keep this page open while configuring both the Tool and Platform because you will need to copy/paste both the public + private key.

Note: These will only show one time. If you refresh the page, it will generate a new public + private key.

Step 2: Create Platform (LMS)
  1. Open Manage Platforms in a new tab
  2. Click Add Platform.
  3. Add a unique name for your Platform.
  4. Provide a OAuth2 client id. (ex: 12345)
  5. Add a audience (ex: https://lti-ri.imsglobal.org)
  6. Copy Public key from Generate Keys tab and paste into Platform Public Key field
  7. Copy Private key from Generate Keys tab and paste into Platform Private Key field
  8. Refresh Generate Keys tab to generate a new set

    9. optionally: you may choose to use a Tool JWT Key Set URL (recommended) instead of providing the Tool's public key to the Platform directly, if you choose this path - add the private key that you generated in previous step to the Tool in Step 4 and the tool will expose a Tool JWT Key Set URL that you can update the Platform with in the Platform's JWT Key Set URL field. If you choose this path, you can leave the Tool Public Key blank.

  9. Copy Public key from Generate Keys tab and paste into Tool Public Key field
  10. Click Save
Step 3: Add Deployment to Platform
  1. Find your Platform in the list of Platforms
  2. View your Platform
  3. Click Platform Keys
  4. Click Add Platform Key.
  5. Create a name for your Platform Key (ex: Key 1)
  6. Add Deployment ID (ex: 1, you may set up multiple later)
  7. Click Save
Step 4: Add a Tool
  1. Open Manage Tools in a new tab
  2. Click Add Tool.
  3. Add a unique name for your Tool.
  4. Add OAuth2 client id, same value as Platform above (ex: 12345)
  5. Copy the Private key from Generate Keys tab and paste into Private key field
  6. Add Deployment, same value as Platform Key above (ex: 1)

  7. In Platform tab, navigate to your platform
  8. Click View Platform
  9. Click Platform Keys
  10. Copy well-known/jwks URL endpoint
  11. Paste into Tool's Keyset url field

  12. In Platform tab, navigate to your platform
  13. Copy the OAuth2 Access Token URL value
  14. Paste into Tool's Oauth2 url
  15. Copy the OIDC Auth URL from Platform Page
  16. Paste into the Tool's Platform oidc auth url
  17. Click Save
  18. Click the back link so you are now viewing tool
Step 5: In Platform tab, view your Platform
  1. Click Courses
  2. Click Add Course
  3. Populate course values in form
  4. Click save

  5. Navigate back and view your Platform
  6. Click Resource Links
  7. Populate resource link values in form
  8. For Tool link url, copy Tool launch URL url from your tool
  9. For Login initiation url, copy Tool OIDC Login Initiation URL endpoint from your tool
  10. Click Save

  11. Navigate and view your Platform
  12. Click Courses
  13. Click View Line Items
  14. Click Add Line Items
  15. Populate line item values in form
  16. Click Save

  17. Navigate and view your Platform
  18. Edit your Platform
  19. For Tool Deep Link Service Endpoint, copy Tool Deep Link URL endpoint from your tool

  20. Navigate and view your Platform
  21. Click Resource Links
  22. Click Select User for Launch
  23. Click Launch with New User
  24. Scroll to bottom and click Perform Launch
  25. If configuration is setup correctly, you should see Successful Launch at top of page

You should now be comfortable with Tool and Platform setup, and can replace one or the other with your Tool or Platfrom