Generating a Canvas Data 2 API Key

This article covers the creation of a Canvas Data 2 API key which we require to connect and retrieve data from customers using Canvas Data 2.

The Canvas Data 2 Client ID and Secret can only be created by an account admin.

Locate Customer

  1. In a web browser, visit identity.instructure.com.

  2. In the institution drop-down menu, search for your institution by entering its name.


  • If your institution does not appear in the search list, contact your Canvas Customer Success Manager for it to be added, with Canvas Data 2 enabled.
  • You may need to use your Instructure url (e.g. edpotential.instructure.com)

  1. Click the Log In to Canvas button.


Authorise Access

  1. To authorise Identity Service to access your account, click the Authorize button.


Add New Key

  1. To add a new key, click the Add New Key button.

  2. Enter the settings for the key:

    1. Key Name [1]: EdPotential
    2. Expiry [2]: 3 years (or the maximum available period)
    3. Key Type [3]: Institutional Use
  3. Click the Save button [4].

Copy API Key and Secret

  1. To reveal your Client ID and Secret, click the Reveal OAuth Credentials button [1].
  2. To copy your Client ID and Secret, click the Copy Text button next to the Client ID and Secret fields [2].
  3. To avoid accidental closing before copying the Client ID and Secret, you need to click the Click 3 more times to close button [3].
  • The Client ID and Secret window can only be opened one time. When you close it, you cannot reopen it.
  • If you do not copy the generated Client ID and Secret and close the window, you will need to generate a new Client ID and Secret.

Provide Credentials to EdPotential

Using this form or a password manager, securely provide EdPotential with:

  1. The Client ID
  2. The Secret
  3. The expiry date

Make a note of the expiry date for the Client ID and Secret, as this will not automatically renew.

A new Client ID and Secret will need to be created and provided to EdPotential before this date, to ensure unbroken data transfer.

Did you find this article helpful? Thanks for your feedback! There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us