In order to enable a Vocareum Course to be accessible through LTI 1.3, refer to the LTI 1.3 Vocareum Course Configuration guide.

Canvas Setup Guide

1. Creating a LTI Key

NOTE: In order to create an LTI Key, 'Developer Keys - Manage' and 'LTI - add/edit/delete' permissions are required. Contact your account admin about setting up an LTI Developer Key if permissions are not met.

On Canvas, go to 'Admin' then select the Account the LTI Key will be under.

Go to 'Developer Keys' on the left navigation menu which will then bring up a list of Pre-existing Developer Keys. On the top right, click '+ Developer Key' then select '+ LTI Key'.

The Key Settings Form should then show up. Name the Key to any name you'd like and set an owner email. Now, Set the 'Method' to 'Enter URL' and enter the following URL: https://labs.vocareum.com/lti1.3/config.json and save it.

Using the configuration URL above enables the following placements:
- Assignment Selection
- Link Selection
- Course Navigation
(enabling 'Show All Assignments' is ideal for Course
Navigation)

Ensure the key was set up properly editing the newly created key. The Key settings should look similar to the following image:

The 'OpenID Connect Initiation Url', 'Redirect URIs'/'Target Link URI', and 'Public JWK URL' should have automatically been filled with the details previously seen within the 'LTI Details' window during the initial Course Configuration.

After verifying that the LTI Key was correctly set up, change the key's state to "ON". The Client ID will be used to add Vocareum as an external tool (Tool Provider) to Canvas Courses. Save the Client ID somewhere as you'll need it again.

2. Adding Vocareum as an external Tool to a Canvas Course

We can use the Client ID in order to add Vocareum as a tool provider by first creating/going to a desired course, then 'Settings'->'Apps'->'View App Configurations'.

Click '+ App', set the Configuration Type to 'By Client ID' and enter the Client ID from the LTI Key.

A new External App titled 'Vocareum LTI 1.3 Content' will show up. Click the cog icon on the right of the External App and click 'Deployment Id'. Similar to the Client ID, save the deployment Id somewhere safe as both the Client ID and Deployment ID will be required.

Continue with the setup by following ONLY one of Setup Guides below:

Regular Vocareum Setup: HERE

If the desire is to setup the LTI 1.3 App to be allowed to access all courses under the org, follow this setup guide.

Course-Specific Access Setup: HERE

If the desire is to setup the LTI 1.3 App to only be allowed to access a specific course, follow this setup guide.


Regular Vocareum Setup Guide

Once we have both Client ID and Deployment ID, go back to Vocareum and go to

Organization Settings (Org Admins only) and under the 'LTI' section, click 'Issuers' to the right of the 'LTI 1.3' label.

Click 'New Issuer' on the top-right hand side of the page and fill in the Issuer entry form with the following information.

Issuer: https://canvas.instructure.com

Client ID: The Client ID copied from Canvas Developer Keys

• Platform KeySet URL: https://canvas.instructure.com/api/lti/security/jwks

• OIDC Authentication: <your organization canvas URL>/api/lti/authorize_redirect

e.g. https://vocareum.instructure.com/api/lti/authorize_redirect

• OAuth Token URL: <your organization canvas URL>/login/oauth2/token

e.g. https://vocareum.instructure.com/login/oauth2/token

• OAuth Server URL: <Leave Blank for Canvas Issuer Registration>

• Name/Identifier: <name of your choice>

After saving, click 'Deployments' on the top-right of the page. Click 'New Deployment' and enter the deployment ID from Canvas and save it. Vocareum can now be used as an LTI 1.3 Tool Provider within Canvas!


Course-Level Access Setup Guide

Key Notes

  • A single client ID should only have access to a single Vocareum course.

    • A new client ID would need to be generated for every unique Canvas course.

  • Ensure that the LTI 1.3 App is installed at the course-level and not at the instance level.

Course-Level Access Settings

On Vocareum, navigate to the course you'd like for the previously generated client/deployment ID to specifically access. Navigate to the course's settings and under the 'LMS Integrations' section, locate the 'Course-Level Access' option and click 'Manage'.

A modal (as shown above) will then pop up which would allow for the addition or selection of an issuer. To proceed, navigate to the 'Add New Issuer' tab within the modal which should then present a fillable form (as shown below).

Alternatively, if the desire is to reuse an issuer that was already previously defined/given course-level access to, navigate to the 'Use Existing Issuer' tab within the modal which should then allow you to select an existing issuer.

Important Notes:

  • Assigning the same issuer to multiple courses will allow that issuer/app to access all the courses that permits that issuer to access (provisioning subsets of courses).

  • A top-level view of any and all courses a course-level issuer is able to access can be found in the 'LTI Issuers' page within the Organization Settings (Org Admin role required)

When adding a new issuer, the entry form can be filled in with the following information:

Issuer: https://canvas.instructure.com

Client ID: The Client ID copied from Canvas Developer Keys

• Platform KeySet URL: https://canvas.instructure.com/api/lti/security/jwks

• OIDC Authentication: <your organization canvas URL>/api/lti/authorize_redirect

e.g. https://vocareum.instructure.com/api/lti/authorize_redirect

• OAuth Token URL: <your organization canvas URL>/login/oauth2/token

e.g. https://vocareum.instructure.com/login/oauth2/token

• OAuth Server URL: <Leave Blank for Canvas Issuer Registration>

• Name/Identifier: <name of your choice>

For more information regarding Canvas issuer information, refer to this link.

After the issuer has been successfully registered, the deployment ID will now need to be added which can be done by, again, locating the 'Course-Level Access' option, clicking 'Manage' > 'Manage Deployments' (next to the recently added issuer) then entering deployment ID from Canvas and adding it.

Did this answer your question?