Enterprise Portal: Set Up Your Canvas Roster Sync Integration

In this guide for administrators, you’ll learn how to establish a secure connection between ExamSoft Enterprise and Canvas by creating a Developer Key and configuring LMS settings.

In this guide:

• Set up Canvas
• Set up ExamSoft and Run the Sync Process

Set up Canvas

1. Log in to Canvas as a System Admin.

2. Select Admin and select the appropriate account.

   

3. Select Developer Keys in the list on the left.

   

   If you do not see this option, you'll need to select a higher-level account.

4. Select + Developer Key and then+ API Key.

   

5. Enter your information in the Key Settings fields:

   • For Key Name, enter: ExamSoft
   • For Owner Email, enter your LMS or ExamSoft admin email.
   • For Redirect URIs, enter:
     • https://rsms-api-usw2.integrations.turnitin.com/v1/canvas/oauth2response
     • https://rsms-api-euw1.integrations.turnitin.com/v1/canvas/oauth2response
     • https://rsms-api-apse1.integrations.turnitin.com/v1/canvas/oauth2response
     • https://rsms-api-apse2.integrations.turnitin.com/v1/canvas/oauth2response
   • The remaining fields can be left blank.

   

6. Select Enforce Scopes.

7. Select the Allow Include Parameters checkbox.

   

8. Enable the following endpoints under each category:

   • Accounts

     • url:GET|/api/v1/accounts

     • url:GET|/api/v1/course_accounts

     • url:GET|/api/v1/accounts/:id

     • url:GET|/api/v1/accounts/:account_id/help_links

     • url:GET|/api/v1/accounts/:account_id/courses

   • Assignments

     • url:GET|/api/v1/courses/:course_id/assignments

     • url:POST|/api/v1/courses/:course_id/assignments

   • Courses

     • url:GET|/api/v1/accounts/:account_id/courses/:id

     • url:GET|/api/v1/courses/:course_id/users

   • Enrollments

     • url:GET|/api/v1/courses/:course_id/enrollments

   • Result

     • url:GET|/api/v1/courses/:course_id/live_assessments/:assessment_id/results

   • Roles

     • url:GET|/api/v1/accounts/:account_id/roles

   • Sections

     • url:GET|/api/v1/courses/:course_id/sections

     • url:GET|/api/v1/courses/:course_id/sections/:id

     • url:GET|/api/v1/sections/:id

   • Submissions

     • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

     • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

9. Select Save (in the bottom right corner).

   

10. Under State, select ON for the ExamSoft entry you just created.

    

Set up ExamSoft

1. Log in to your ExamSoft portal as an Institution Administrator.

   If you are the LMS admin without any access to your ExamSoft portal, you need to either obtain an account with proper access or work with someone who has the correct access before you can continue.

2. Select Admin >Global Settings >LMS Settings.

3. Select Canvas Roster Sync from the Type drop-down menu.

   

4. Enter your information in the following fields:
   1. Select Edit. Then, input the following values.
   2. Select Save when finished.

• For Canvas Server, paste your Canvas instance URL.
• For Client ID, paste the value that you saved earlier in your text file.For Client Secret, paste the value that you saved earlier in your text file.
  
  

5. Select the Generate Key button, and it will launch a Canvas login screen.

   

6. Log in with a Canvas admin account.

7. Select Authorize, and you'll be redirected back to your ExamSoft portal. 

   

8. Select Save (in the top right corner).

   

Learn more

If you do not see the data that was supposed to sync over, see: Enterprise Portal: LMS Sync Errors