How do I add a developer key for an account?

Document created by Canvas Doc Team Employee on Oct 7, 2017Last modified by Canvas Doc Team Employee on Dec 9, 2017
Version 4Show Document
  • View in full screen mode

As an admin, you can create developer keys for root accounts. A developer key is a code given to the developer of a third-party application that allows access to certain information and permissions within Canvas. Developer keys can be used to create custom integrations with Canvas and allow third-party apps to use Canvas authentication. The developer key uses OAuth2 to enable the application to use Canvas for authentication. For more information about OAuth2, see the Instructure API OAuth documentation.

The developer key is sent from the application to Canvas when a user requests access. The application asks the user for permission to programmatically create an API access token. When the user authorizes the application, the third-party application will have the same access to information and account permissions as the user that granted access. For more information about developer documents, see the Instructure Github page.

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.

Add Developer Key

Add Developer Key

Click the Add Developer Key button.

Enter Key Settings

Enter Key Settings

Enter the settings for the developer key:

  • Key Name [1]: Usually your app or company name. This field will be shown when users are asked to approve access to their Canvas account on your behalf.
  • Owner Email [2]: The email of the person who owns the developer tool.
  • Redirect URI (Legacy) [3]: The URI for the key redirect. This field allows you to set the previous URI for a tool. Eventually this field will be removed.
  • Redirect URIs [4]: The domains where tokens are requested. These URIs are not your Canvas URL. To avoid mixed content browser concerns, use https.
  • Vendor Code (LTI 2) [5]: A unique registered code which identifies the vendor or developer of the third-party tool. This is specifically for LTI 2 tools and apps.
  • Icon URL [6]: The URL of the icon for your developer tool. This URL is presented to the user to approve authorization for your tool. To avoid mixed content browser concerns, use https.
  • Notes [7]: Any notes about the developer key, such as the reason it was created.

Save Key

Save Key

Click the Save Key button.

View Key

  View Key 

View the Developer Key for your account.

You are here
Table of Contents > Integrations > How do I add a developer key for an account?

Attachments

    Outcomes