How do I install the Canvas Credentials LTI in a self-hosted Canvas instance?

To use the Credentials LTI in a self-hosted Canvas instance, Canvas admins must create their own API and LTI keys. Please contact support and provide the URL of your Canvas instance to begin the process.

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 Developer Keys

Open Developer Keys

In Account Navigation, click the Developer Keys link [1], then click the Account tab [2]. To add a key, click the Add Developer Key button [3].

Select Key Type

Select Key Type

To add an LTI key, select the Add LTI Key option.

Configure LTI Key

Configure LTI Key

In the Key Name field, enter the LTI tool name. This name also displays in the Course Navigation menu [1]. In the Method drop-down menu, select the Enter URL option [2].

In the Redirect URIs field, copy and paste the support-provided redirect URI [3].

In the JSON URL field, copy and paste the support provided JSON URL [4].

Click the Save button [5].

Add API Key

Add API Key

To add an API key, click the Add Developer Key button [1] and select the Add API Key option [2].

Configure API Key

Configure API Key

In the Key Name field, enter the same name as entered in the LTI key creation [1].

In the Redirect URIs field, copy and paste the support-provided redirect URI [2].

In the Icon URL field, copy and paste the support-provided icon URL [3].

Click the Save button [4].

Enable LTI and API Keys

Enable LTI and API Keys

Toggle the State of your new LTI and API keys to the On position.

Send ID and Keys to Support

Send ID and Keys to Support

Copy the Developer ID for the LTI key [1] and paste into an email. Label it LTI Client ID.

Copy the Developer ID for the API key [2] and paste it into an email. Label it API Client ID.

To view the API key, click the Show Key button [3]. Copy and paste this key into an email and label it API Secret Key.

Contact support with this information. Once Support updates the integration for your Canvas instance, you can install the Credentials LTI.

Locate Client ID

Locate Client ID

When installing the Credentials LTI on a self-hosted Canvas instance, the Developer ID for the LTI Key is your client ID. To begin installing the Credentials LTI, copy the Developer ID for the LTI Key to your clipboard.

View App Configurations

View App Configurations

In Account Navigation, click the Settings link [1]. Click the Apps tab [2]. To view app configurations, click the View App Configurations button [3].

Add App

Add App

Click the Add App button.

Enter Client ID

Installing the Badgr Groups LTI

In the Configuration Type dropdown menu, select the By Client ID option [1]. In the Client ID field, enter your LTI key developer ID [2].

Click the Submit button [3].

Confirm Installation

Confirm Installation

To confirm the installation of the Credentials LTI, click the Install button.

View Installed LTI

View Installed LTI

Once the Credentials LTI is installed, the name you entered for the tool displays as a link in the Course Navigation for all courses in your Canvas instance.  

Add LTI Registration

LTI Registration

Canvas Credentials supports LTI 1.3 Dynamic Registration with Canvas LMS. Admins can start registration using a single URL, allowing Canvas to automatically fetch and apply the configuration. To start registration, click the Add Developer Key button [1], then select the Add LTI Registration link [2].

Register App

Register App

In the Canvas LMS developer keys Register App modal, paste the Dynamic Registration URL of the institution [1]. Then click the Continue button [2].

Note: These URLs cannot be opened directly in a browser. They must be pasted into Canvas in the Dynamic Registration URL field. Opening them directly will not initiate registration.

Verify account

To verify a Canvas Credentials account, enter the Canvas Credentials email address [1]. Then, click the Next button [2] to enter the verification code.

Select Organization

Select an Organization [1], then click the Next button [2].

Review Integration

Review Integration

Review and set the Integration Visibility in Canvas Courses [1]. To enable a self-hosted Canvas instance, click the Use with a self-hosted Canvas Instance toggle on [2], and enter the Canvas API Client ID and Secret [3]. Click the Submit button [4].

Complete Registration

Complete Registration

In the Canvas Credentials Settings modal, review Permissions [1], User Data Sharing [2], and Placements [3], and adjust if needed. Click the Enable and Close button [4] to complete registration.