Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This CCC Data Warehouse user guide provides support and implementation steps for the Canvas data direct access service, exclusively for California Community Colleges.

...

To generate your college’s Canvas Data API credentials, follow the steps below. Once the credentials are generated, a copy of the credentials should be captured for security purposes, and safely passed to the CCC Technology Center in a secure manner.

Note

Strongly Recommended: For security reasons, the CCCTC recommends that a new Admin user account be created specifically for this project to prevent the API key from affecting other active Admin accounts. In the event this API key needs to be changed or disabled, other API keys would then not be affected. See .

College Canvas Administrator

...

  1. Open Your Account: Click the Admin link in your Canvas application, then click on the name of your account or sub-account.

  2. Open Canvas Data Portal: In Account Navigation, click the Canvas Data Portal link.

  3. Create API Credentials: Click the Create Credentials button. A success notification with your API credentials will display.

...

4. Copy API Credentials: Once API credentials are created, copy the API Key and API Secret and prepare to pass to the Implementation Engineer at the CCC Technology Center.

Note

Note: If you return to the Credentials Portal, you will be able to see the API Key but not the API Secret.

Tip

Read more creating your Canvas API credentials: How do I obtain an API access token in the Canvas Data Portal?

...

  1. To facilitate the process of adding your Canvas data into the Data Warehouse, provide your API Key and Secret values to your ES Implementation Engineer in the format shown below. These values should be passed using a secure method such as Privnote.

    1. Canvas Data API Key: [canvas-datawarehouse-<misCode>-apikey]
      (Replace <misCode> with your college MIS code, and replace “apikey” with your Canvas API key value generated for your specific Instructure account.)

    2. Canvas Data API Secret: [canvas-datawarehouse-<misCode>-apisecret]
      (Replace <misCode> with your college MIS code, and replace “apisecret” with your Canvas API secret value generated for your specific Instructure account.)

  2. Upon receipt of your API values, your ES Implementation Engineer will facilitate the process of adding your Canvas data into the CCC Data Warehouse with the CCCTC DevOps team.

...

Creating New API Credentials: You can create new credentials by clicking the Create Credentials button again.

Warning

Important: Generating new API credentials will invalidate the old credentials for all users who have access to them. This includes third-party partner accounts, such as the CCC Data Warehouse.

Creating a New Canvas Admin User

Note

When you assign a user as an admin in the root account, that user has all privileges in any sub-account. You might consider assigning users as admins only in the sub-account for which they are responsible.

To create a new Canvas Admin user, follow the directions below:

  1. To add a user as an admin, you must assign the user to an account role. Before adding a user, ensure that you have created the necessary account-level role.

  2. Open the Account: In Global Navigation, click the Admin link, then click the name of the account you want to add a user to.

  3. In Account Settings, click the Settings link.  

  4. In Settings, click the Admins tab. The Add Admins Account button will display.

  5. Click the Add Account Admins button.

  6. Add an Account Role and Email.

    1. In the Add More drop-down menu, set the admin role type. The default admin role in Canvas is Account Admin which has access to all account-level permissions. You can also create admin roles for your institution and manage their permissions.  

    2. In the text box, type the email address of the new user.

    3. Click the Continue... button.

    4. Add Account Admins.

      1. Verify the user you added is listed in the admin field.

      2. Select the OK Looks Good, Add this [#] User button to add the admin.

      3. Click the Go back and edit the list of users link to adjust any errors. A message will appear in your browser.

  7. Verify the new user administrative user was added.

Tip

See the illustrated How do I add an admin to an account? instructions on the Canvas website.

Info

Once you add a new Admin user to an existing profile in Canvas, the email address associated with that user account will receive an email notification that the new user is now an admin for the account. If the new user account does not already have a profile, an email with a link to create a profile and access the account will be sent.

...

Tip

Implementation FAQs: See the FAQ: Direct Access to Canvas Data in the CCC Data Warehouse section below.

...