Canvas Guides (en)Canvas GuidesCanvas Admin Guide External Apps (LTI)How do I configure an external app for an account using a client ID?

How do I configure an external app for an account using a client ID?

External apps that support LTI 1.3 and LTI Advantage require configuration using a client ID. The client ID can be found by configuring an LTI key from the Developer Keys page.

Notes:

  • External apps cannot be configured using a client ID in sub-accounts.
  • Manually configuring an external app is an account permission. If you cannot configure an external app, this permission has not been enabled for your user role.

Open Settings

Open Settings

In Account Navigation, click the Settings link.

Open Apps

Open Apps

Click the Apps tab.

View App Configurations

View App Configurations

To configure an app, click the View App Configurations button.

Add New App

Add New App

Click the Add App button.

Set Configuration Type

Set Configuration Type

Select the Configuration Type drop-down menu and set the configuration type to By Client ID.

Enter Client ID

Enter Client ID

Enter the client ID in the Client ID field [1].

Then click the Submit button [2].

Note: If you do not have a client ID, you must first configure an LTI key.

View Error Message

View Error Message

If the submitted client ID is not found in your account's developer keys, Canvas will display an error message.

Install App

To install the app, click the Install button.

View App

View App

View your app on the External Apps page [1].

To manage your app, click the Settings icon [2].

To edit the app, click the Edit link [3]. To see the places where the app appears in Canvas, click the Placements link [4].

If the app supports LTI Advantage, the Settings menu may also display a Deployment ID link. To view the Deployment ID for the app, click the Deployment ID link [5]. App providers who utilize LTI Advantage may require this Deployment ID for app functionality.

To delete the app, click the Delete link [6].