Canvas Installation Guide

Introduction

Recently, BioSig-ID created an additional app that reduces the manual processes of creating guarded quizzes and tool instances. This app will allow you to efficiently create guarded quizzes, tool instances and instructions within your courses. To take this new app for a spin, try it out on the BioSig-ID Admin demo page . (This is not attached to a Canvas instance and no actual course is being adjusted)

For those clients who are already using the Guarded Quiz and Tool Instance apps, you can skip to Step 4 to install the BioSig-ID Admin App. If you are new to BioSig-ID, please follow all of the steps below to begin using BioSig-ID in your courses.

UPDATE NOTICE

June 21st, 2022: Support has been added for the Safe Exam Browser (SEB) integration which requires additional API Developer Key scopes, so please update any existing configuration and add the new entries marked in blue as listed at the end of step #1.

Canvas Account Settings

BioSig-ID relies on the primary e-mail address that Canvas forwards to create the usernames from. This means to close any security gaps, the end-user should not be allowed to delete the institution's provided e-mail address, or be able to add a personal one.

The main Canvas Admin "Settings" screen offers options for this halfway down in the "Features" section:

Verify that both "Users can edit their communication channels" and "Users can delete their institution-assigned email address" are unchecked, and Update Settings accordingly.

Step 1: Create Developer Keys

Switch to "Admin View"

Admin > Select the account to manage > Developer Keys

Use the  +Add Developer Key   button, followed by the " + API Key " selection

Description	Value
Key Name	BioSig-ID™
Owner Email	(add your email address)
Redirect URIs	(leave blank)
Redirect URI (Legacy)	Production = https://verifyexpress.com/Interface/Canvas_LTI Sandbox = https://sandbox.verifyexpress.com/Interface/Canvas_LTI
Vendor Code (LTI 2)	(leave blank)
Icon URL	Production = https://verifyexpress.com/bcc/favicon.ico Sandbox = https://sandbox.verifyexpress.com/bcc/favicon.ico
Notes	(leave blank)
Test Cluster Only	(keep checkbox unchecked)

Enter the information from the above table above as shown below:

Then use the " Save Key " button.

Next, you will provide the " ID: " and " Key: " values to BSI to allow the API integration to become fully functional.  The State should be set to "ON"

The ID is right above Show Key button, copy this information to provide to BioSig-ID.

Click Show Key and copy this information to provide to BioSig-ID.

Enforced Scope Policies

The BioSig-ID™ Canvas Admin app has full scope-support now that Canvas added the "Allow Include Parameters" option. Activate both as follows:

To find all the scopes easier use the "Search endpoints" box to filter the large list first.

Filter on "accounts", expand "> Accounts", and check the following items:

1. url:GET|/api/v1/accounts
   
2. url:GET|/api/v1/accounts/:account_id/courses
   
3. url:GET|/api/v1/accounts/:account_id/permissions
   

Then filter on "assignment", expand "> Assignment Groups", and check:

1. url:GET|/api/v1/courses/:course_id/assignment_groups
   
2. url:POST|/api/v1/courses/:course_id/assignment_groups
   

With "assignment" filter still active, at the bottom expand "> Assignments", and check:

1. url:GET|/api/v1/courses/:course_id/assignments
   
2. url:POST|/api/v1/courses/:course_id/assignments
   

Now filter on "modules", expand "> Modules", and check the following items:

1. url:GET|/api/v1/courses/:course_id/modules
   
2. url:GET|/api/v1/courses/:course_id/modules/:id
   
3. url:POST|/api/v1/courses/:course_id/modules
   
4. url:PUT|/api/v1/courses/:course_id/modules/:id
   
5. url:GET|/api/v1/courses/:course_id/modules/:module_id/items
   
6. url:GET|/api/v1/courses/:course_id/modules/:module_id/items/:id
   
7. url:GET|/api/v1/courses/:course_id/module_item_sequence
   
8. url:POST|/api/v1/courses/:course_id/modules/:module_id/items
   
9. url:PUT|/api/v1/courses/:course_id/modules/:module_id/items/:id
   
10. url:DELETE|/api/v1/courses/:course_id/modules/:module_id/items/:id
    

Filter on "pages", expand "> Pages", and check:

1. url:POST|/api/v1/courses/:course_id/pages
   

Next filter on "quizzes", expand "> Quizzes", and check:

1. url:GET|/api/v1/courses/:course_id/quizzes
   
2. url:POST|/api/v1/courses/:course_id/quizzes
   
3. url:GET|/api/v1/courses/:course_id/quizzes/:id
   
4. url:PUT|/api/v1/courses/:course_id/quizzes/:id
   

Filter on "questions", expand "> Quiz Questions", and check:

1. url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
   

Filter on "tabs", expand "> Enrollment Terms", and check:

1. url:GET|/api/v1/courses/:course_id/tabs
   
2. url:PUT|/api/v1/courses/:course_id/tabs/:tab_id
   

And finally filter on "terms", expand "> Enrollment Terms", and check:

1. url:GET|/api/v1/accounts/:account_id/terms
   

Then use the [Save] button to apply the new enforced scopes.

Step 2: Add the Guarded Quiz Intercept App

The BioSig-ID™ Admin App offers an easy solution to convert existing quiz links to guarded quiz links. Both apps are needed to handle existing and new courses without additional steps.

Admin -> "Settings" -> "Apps" tab

Change drop down to " By URL "

Using the information in the below table populate the appropriate boxes in the Add App form. 

Description	Value
Name	BioSig-ID™ Guarded Quiz
Consumer Key	(This will be provided by BSI}
Shared Secret	(This will be provided by BSI)
Config URL	Production = https://verifyexpress.com/interface/quiz.xml Sandbox = https://sandbox.verifyexpress.com/interface/quiz.xml

Then use the " Submit " button.

Step 3: Add the Tool Instance App

Admin -> "Settings" -> "Apps" tab

Change drop down to " By URL "

Description	Value
Name	BioSig-ID™
Consumer key	(Same key as the one from the steps above)
Shared Secret	( Same secret as the one from the steps above )
Config URL	Production = https://verifyexpress.com/interface/canvas.xml Sandbox = https://sandbox.verifyexpress.com/interface/canvas.xml

Using the information from above populate the Add App form as shown below:

Add App form

Then use the "Submit" button.

Step 4: Add the BioSig-ID™ Admin App

Admin -> "Settings" -> "Apps" tab

Change drop down to " By URL "

Description	Value
Name	BioSig-ID™ Admin
Consumer Key	(Same key as the one from the steps above)
Shared Secret	(Same key as the one from the steps above)
Config URL (on)	Production = https://verifyexpress.com/interface/admin_on.xml Sandbox = https://sandbox.verifyexpress.com/interface/admin_on.xml
Config URL (off)	Production = https://verifyexpress.com/interface/admin.xml Sandbox = https://sandbox.verifyexpress.com/interface/admin.xml

Then use the "Submit" button.

Use the "Yes, Install Tool" button when Canvas indicates that the tool has already been installed in this context.

UPDATE: For Apple Safari, or other browsers with a restrictive server session-cookie policy, an empty API-domain error might occur. The error message will contain multiple solutions, including a way to temporarily set a cookie in a new tab, but to fix that permanently the following configuration files allow the Canvas Admin App to always be opened in a new tab:

Sandbox	Config URL (on) = https://sandbox.verifyexpress.com/interface/blank_admin_on.xml Config URL (off) = https://sandbox.verifyexpress.com/interface/blank_admin.xml
Production	Config URL (on) = https://verifyexpress.com/interface/blank_admin_on.xml Config URL (off) = https://verifyexpress.com/interface/blank_admin.xml

Then use the "Submit" button.

NOTE: The difference between (on) and (off) is the default availability status of the course navigation menu item. Unless BioSig-ID™ is used in all Canvas courses then it might be wise to use the (off) method and manually drag-and-drop the "Navigation" menu item per course to make it available.

Recommendations

For BioSig-ID™ Guarded Quizzes to be effective the direct access to Quizzes needs to be disabled. This can be done automatically via the Admin: BioSig-ID™ Admin App with the respective checkbox option, but it can also be done manually as follows:

Admin -> Courses -> select a course that will use BioSig-ID™ -> "Settings" -> "Navigation" tab

Drag 'Quizzes' to the hide section:

Use the "Save" button.

NOTE: BioSig-ID™ Guarded Quiz links need to be re-created on any course copy. Please use the BioSig-ID™ Admin system to fix these links quick and easy, or manually recreate them one at a time.

How to Use the Admin Tool

Watch this quick video for an overview of how to use the BioSig-ID™ Admin Tool to quickly add tool instances and guarded quizzes to any course.

For more detailed instructions, please see Using the BioSig-ID™ Admin Tool Manual.

• Related Articles

• B2 Installation Guide

  Introduction The Biometric Signature ID (BSI) Building Block for Blackboard Learn 9.1 provides a mechanism to require a user/student to validate their identity when needed. This process is split between enrollment for the user to create their initial ...

• LTI 1.3 Installation Guide

  The LTI 1.3/Advantage-Proctoring solution relies on the Ultra Extended Framework which only works on Ultra View courses in a Blackboard Ultra Navigation environment. That means access to the Admin section is achieved by the left-sided menu item that ...

• Canvas course issue detected

  If end-users report seeing the following error: Then please use the BioSig-ID™ Admin app to fix the quiz-links on this copied course. Admins with enough access can do this for a term, or the entire Canvas instance.

• Canvas BioSig-ID Admin App

  Getting Started Click on BioSig-ID™ Admin tool in the Course Navigation menu. If this item is not available, please contact your Canvas Admin to have this item enabled. Click on Authorize to allow BioSig-ID™ access to your course. To take this new ...

• Moodle Installation (Module)

  Introduction ATTENTION: Moodle 3.10+ requires BioSig-ID™ Moodle module v2020122400 or higher. The BioSig-ID™ Module for Moodle provides a mechanism by which a user may be redirected to BSI's BioSig-ID™ Identity verification system and the ...