Canvas Guides (English)SIS GuidesSapphire Admin GuidesCanvas Sapphire Integration Overview

Canvas Sapphire Integration Overview

Instructure supports a SIS integration with Sapphire. The integration uses APIs made available from OneRoster 1.1 where the SIS is the OneRoster data provider, and Instructure is the OneRoster data consumer. Learn more about OneRoster and the Instructure OneRoster implementation.

The Canvas Sapphire integration allows Sapphire to sync rostering data to Canvas and for Canvas to post assignments and assignment grades back to the Sapphire gradebook.

As an admin, you can review the integration functionality and limitations and request the integration for your institution.

Integration Overview

The OneRoster integration works bi-directionally:

  • Sapphire to Canvas Provisioning: When you make changes in Sapphire (to users, courses, enrollments, etc.), those changes are reflected in Canvas after a nightly, one-way transfer from your SIS's OneRoster 1.1 API to Canvas.
  • Canvas to Sapphire Grade Passback (GPB): When instructors make changes or updates to course assignments and student grades in Canvas, those changes are sent to your SIS using OneRoster 1.1 API. Learn about syncing grades from Canvas to the Sapphire gradebook.

Note: OneRoster provisioning is required for GPB functionality.

Supported Objects

The following data is included in any provisioning or GPB transfer.

Provisioning:

  • Courses
  • Enrollments
  • Sections
  • Staff
  • Students
  • Sub-accounts
  • Terms

GPB:

  • Course Grades/Gradebook Scores
  • Graded Assignments
  • Graded Discussions
  • Graded Quizzes

Sapphire Integration Prerequisites

Before implementing the Instructure Sapphire integration, your institution must meet the following requirements:

  1. Request your institution's OneRoster 1.1 credentials from Sapphire. These OneRoster credentials (API URL, client key, and client secret) should be sent to the Instructure SIS team using a secure Canvas-provided link.
  2. Once you have shared your OneRoster credentials, the Instructure SIS team will verify the integration connectivity.
  3. If your institution is converting from one SIS to another or transitioning from a different integration, the SIS team must perform an evaluation of the integration against your data. The SIS team will contact you with any concerns about converting to the Sapphire integration.

Next Steps

If you are interested in enabling the Sapphire Integration for provisioning, please contact your Customer Success Manager (CSM) for consideration.

Additional Resources