Canvas Guides (en)Canvas GuidesCanvas Admin Guide External Apps (LTI)How do I configure an LTI key for an account?

How do I configure an LTI key for an account?

As an admin, you can configure an LTI key from the Developer Keys page. LTI keys can be used to enable an external app that supports IMS Global LTI 1.3 and LTI Advantage.

When supported by a tool provider, this framework allows admins to manage all LTI tool configuration data directly in the Developer Keys page. The LTI can then be added to an account or a course via an associated client ID.

LTI keys can only be configured in accounts that have enabled the LTI 1.3 and LTI Advantage feature option. This feature option should only be enabled by Canvas admins to configure tools that include LTI Advantage services. Specific questions about a provider's integration or potential integration with the LTI 1.3 and LTI Advantage framework should be sent directly to the tool provider.

Note: Developer Keys is an account permission. If you cannot view the Developer Keys link in Account Navigation, this permission has not been enabled for your user account.

Open Account

Open Account

In Global Navigation, click the Admin link [1], then click the name of the account [2].

Open Developer Keys

Open Developer Keys

In Account Navigation, click the Developer Keys link.

Add LTI Key

Add LTI Key

Click the Add Developer Key button [1]. Then click the Add LTI Key option [2].

Note: If you cannot view the Add LTI Key option, the LTI 1.3 and LTI Advantage feature option has not been enabled in your account.

Enter LTI Settings

Enter LTI Settings

Enter the settings for the LTI key:

  • Key Name [1]: The name of the company or external tool.
  • Owner Email [2]: The email of the person who owns the external tool.
  • Redirect URIs [3]: Redirect URI data should be provided by the tool provider.
  • Notes [4]: Any notes about the LTI key, such as the reason it was created.

To create an LTI key that can only be used in the Canvas test environment, click the Test Cluster Only checkbox [5].

 

Select Configuration Method

To select the method you want to use to configure your LTI tool, click the Method drop-down menu.

 

Enter Manual Entry Details

To manually enter the details for your LTI key, click the Manual Entry option [1].

If the tool provider requests that their tool be set up via manual entry, they will need to provide the details to fill the required fields. Required fields are title [2], description [3], target link URL [4], OpenID connect initiation URL [5], and public JWL [6].

You can also enter non-required details for LTI Advantage services [7], additional settings [8] and placements [9]. Any items selected in the Placements field will display as LTI setting items [10].

Note: If the LTI vendor is unable to provide the information for the required fields, you may want to configure the tool via the Paste JSON or Enter URL option.

Enter JSON Details

To paste JSON formatting for your LTI 1.3 configuration, click the Paste JSON option [1].

Then enter the JSON formatting in the LTI 1.3 Configuration field [2].

Enter JSON URL

To enter a JSON URL, click the Enter URL option [1]. Then enter the JSON URL in the JSON URL field [2].

Save LTI Key

Save LTI Key

To save your LTI key, click the Save button.

View LTI Key

View your LTI key [1]. LTI keys are indicated by the External Tool icon [2].

Each LTI key includes a client ID [3]. Copy or write down the client ID to enable the external tool from your Account Settings or to share it with users to enable the tool in a course.