Skip to main content

Canvas Integration

Steps on Creating an integration to Canvas from your Scaffold Instance

R
Written by Rachel Gough
Updated over 2 weeks ago

To integrate Canvas with your Scaffold Instance, you'll first need to create a role in Canvas with the proper permissions and then a utility account that uses that role. The Canvas utility account, should be an admin account that has direct login access (no SSO login).

Part 1: Create a Canvas Role

  1. Log in to Canvas and go to your Root Account.

  2. Click on Permissions in the menu, then choose Account Roles.

  3. Click Add Role.

  4. Give the role a name, like Canvas Archiving, then click Save.

  5. Within the Root Account> Account Permissions, turn on the permissions needed for this role (Required Canvas Permission).

  6. Then, go to each Sub-Account, that courses will be archived from and enable the sub-account permissions for this new role.

Part 2: Create a Canvas Utility Account

  1. In the Root Account, go to Settings> Admin

  2. Scroll down and click + Account Admins

  3. In the Add More dropdown, choose the role you just created (e.g. Canvas Archiving)

  4. In the Input box enter: “Last Name, First Name” <[email protected]>

  5. Click Continue, then click “Ok Looks Good, Add This 1 User”

  6. You will receive an email from Canvas regarding the account creation. Follow the instructions to finish setting up the account and accept the Canvas user agreement.

Part 3: Creating the Integration to Canvas

  1. In the Canvas Archiving instance, go to Imports from the menu.

  2. Click + New Integration.

  3. Fill in the details:

    • Integration Name (your choice)

    • Integration URL (e.g., https://institution.instructure.com)

    • Username (Canvas Utility Account username)

    • Password (Canvas Utility Account password)

    • Sub Account ID (the sub-account you want to archive from)

  4. Click Verify Account to check the connection.

  5. If all looks good, click Save.

After you click Save, the integration will be created. If there’s an issue with the integration, you’ll see an error status on the integration tile on the Imports page.

Note: Once the integration has been saved, as part of the creation process 10 Access Token will be created from the Utility Account that was used in the integration. Depending on your Canvas email settings, you may get up to 10 emails regarding the creation of the access tokens.

Click on the integration to view the details and find out what caused the error. Refer to our Integration Status & Errors help article for additional details on errors.

Did this answer your question?