As an Instructure partner, you can receive Canvas Data 2 credentials from an institution without the institution ever sending you a Client ID or Secret by email or chat. An account admin at the institution generates an API key with the Instructure Partner key type, selects your organization, and enters one of your email addresses. Identity Services then emails that address a one-time link where you retrieve the Client ID and Secret yourself.
Notes:
- Your organization must appear in the Select Partner drop-down menu in Identity Services. If it does not, contact your Instructure partner manager.
- The Select Partner drop-down menu lists partner names, not product names. Ask the admin to look for your company name rather than the name of the integration.
- Identity Services validates the email address against your organization's domain. If the admin enters an address on any other domain, the key cannot be created.
- The Client ID and Secret display only once. Copy them before you leave the page.
Confirm the Email Address to Give the Admin
Give the admin an email address on your organization's own domain. Identity Services validates the address against the domain registered for your organization, so an address on a personal or customer domain is rejected.
Use a shared mailbox that more than one person on your team can reach. If the only recipient is unavailable, no one else can retrieve the key, and the admin has to revoke it and create a new one.
Open the Credentials Email
Identity Services sends the email from identity@instructure.com with the subject Access Credentials have been securely shared with you. The email is addressed to your organization and confirms which institution generated the key.
Click the Check out API key link in the email.
Note: If the email does not arrive, check your spam folder and confirm with the admin that they entered the correct address. Add identity@instructure.com to your allowed senders list.
Copy the Client ID and Secret
The page displays the Client ID and Secret for the key. Copy both values and store them in your secret manager before you leave the page.
To reveal your Client ID and Secret, click the Reveal OAuth Credentials button [1].
To copy your Client ID and Secret, click the Copy Text button next to the Client ID and Secret fields [2].
Notes:
- The credentials display only once. If you refresh the page, or close it and open the link again, the credentials no longer display.
- If you lose the credentials, ask the admin to revoke the key and generate a new one. Identity Services has no resend option.
Check the Key Status with the Admin
Until you open the link, the institution's admin sees the key with a Pending Verification status. The admin can use that status to confirm whether the handoff is complete, so let them know once you have the credentials.
Start Using Canvas Data 2
Once you have the Client ID and Secret, you can start here: Getting Started | Instructure Developer Documentation Portal.
