Skip to content

Canvas - Manual Registration

Summary

To set up LTIAAS with Canvas you need to:

  1. Add a developer LTI Key in Canvas
  2. Install the LTIAAS tool into Canvas
  3. Register the Canvas provided details into LTIAAS
  4. Do a test launch

1) Add a Developer Key in Canvas

  1. Login to your Canvas LMS as an administrator.
  2. Navigate to 'Admin' -> [your account name] -> 'Developer Keys'
  3. Click the '+ Developer Key' button followed by the '+ LTI Key' dropdown
  4. In the resulting form, enter the following information:

    • Key name: Your Tool Name
    • Method: Manual Entry
    • Redirection URI(s): https://your.ltiaas.com/lti/launch
    • Title: Your Title
    • Description: Your Tool Description
    • Target Link URI: https://your.ltiaas.com/lti/launch
    • OpenID Connect Initiation Url: https://your.ltiaas.com/lti/login
    • JWK Method: Public JWK URL
    • Public JWK URL: https://your.ltiaas.com/lti/keys

    5. Further down in the form, select the services your tool needs. The screenshot belos shows an example of a tool that uses assignments, grades, and the launch context (i.e. the course ID). 6. Toward the bottom of the form, add placements for your tool. These are the locations in the LMS where your tool can be added. If you are using Deep Linking, select LtiDeepLinkingRequest. Otherwise, select LtiResourceLinkRequest for a basic LTI launch. 7. Click the 'Save' button at the bottom when the form is filled.
    8. After saving, find the newly registered tool's key on the list of keys and make sure the State is switched to 'ON' 9. Note the number in the details column. It will be used as the Client ID in the next steps

2) Install The LTIAAS Tool into Canvas

  1. In the Canvas Admin menu, navigate to 'Settings' -> 'Apps'
  2. Click the '+ App' button
  3. In the resulting form choose:
    • Configuration Type: By Client ID
    • Client ID: [The Client ID number you found in the previous series of steps]
  4. Click the 'Submit' button
  5. In the resulting dialog, click 'Install'
  6. The tool will now show up in the 'External Apps' table.

3) Register The Canvas Provided Details Into LTIAAS

Follow the steps on the Registering Your First Platform page. Use the table below to help translate the information provided by the LMS to values needed in the LTIAAS registration process.

LTIAAS Registration API Name Canvas Provided Name (Instructure Cloud) Canvas Provided Name (Self Hosted)
name Any name you would like that helps you identify your LMS
clientId The client ID found in the first sequence of steps
url https://canvas.instructure.com https://[YOUR_CANVAS_URL]
authConfig.method
JWK_SET
authConfig.key https://[YOUR_CANVAS_URL]/api/lti/security/jwks
accesstokenEndpoint https://[YOUR_CANVAS_URL]/login/oauth2/token
authenticationEndpoint https://[YOUR_CANVAS_URL]/api/lti/authorize_redirect

Replace [YOUR_CANVAS_URL] with the base URL of your canvas instance. For example: canvas.my-university.edu or canvas.instructure.com. More information about the Canvas LTI 1.3 endpoints can be found on Instructure's website.

4) Do A Test Launch

Note that you may need to add placements for the newly installed tool before adding it to certain places within the LMS.

  1. Follow the instructions on the Canvas website to add an external tool assignment to a course: How do I add an assignment using an external app?
  2. When choosing an external tool, choose the newly registered tool from step 1.