Overview
This guide provides the necessary steps for ClassLink Administrators to successfully set up the sharing of their school or district roster data with the Kami application via ClassLink's Roster Server.
Key Features and Benefits
The integration between ClassLink Roster Server and Kami offers significant benefits for school and district administrators by automating the provisioning of user accounts and license seats.
Sync user accounts and license affiliations directly from ClassLink: We provision the user accounts and ensure the correct license affiliation is established based on the rostered data.
Automate user additions and updates as rosters change: New users and enrollment changes are automatically processed, ensuring that accounts are always up to date.
Automated syncing of rostering and license data: This integration delivers continuous, automatic updates for both user data and license coverage.
No more time-consuming CSV uploads: We eliminate the need for manual, periodic data management.
Fewer errors and greater accuracy: By syncing directly from your source data in ClassLink, we ensure greater data integrity and reduced administrative errors.
Requirements
To successfully share your ClassLink roster data with Kami, the following prerequisites must be met:
You must have an active Kami School Plan or District Plan.
You must have Administrator access to your school or district's ClassLink Roster Server.
The Kami App must be available within your ClassLink Roster Server environment.
Your ClassLink Roster Server must be actively syncing data from your Student Information System (SIS).
Step-by-step Instructions
Step 1
From the Roster Server dashboard, hover over Apps and Select All Applications (1).
Click the + ADD button (2) in the top-right corner of the Applications screen.
Step 2
In the Add New App screen, Search for Kami in the Name field.
Click the + Add button next to the Kami result.
We recommend choosing the Full Permissions option for the smoothest and easiest experience. This can be configured later.
Step 3
Back on the Applications screen, Locate the Kami you just added.
Click the gear icon under the Actions column to edit the application settings.
Step 4
On the App Overview screen, Select App Overview (7) from the left-hand navigation menu.
Toggle the switch to Enable API and File Exports (8). The switch should turn blue to indicate it is enabled.
Step 5
Lastly, you will need to reach out to your Kami Account Manager and discuss which school(s) roster to sync with your Kami license. After your Account Manager receives that information, we will take it from there and set up the integration on our end. We'll be in touch with you once it is ready to go.
Step 6
After you receive confirmation from your Kami Account Manager, you can view and manage your roster and license sync through the Kami License dashboard. Clicking the Manage License button will direct you to the Details page. Here you'll be able to see your Roster Sync information.
ClassLink Roster Data Field Sharing Requirements
Here are the tables for all the data fields that are shared by default when you select the Full Permissions sharing option. Note that our requirements are subject to change, and these permissions may need to be adjusted:
Required: Must be present for Kami's integration to function correctly.
Supported: Kami stores this information, but it is not critical for functionality. These fields can be anonymized if you choose to share this information.
Unsupported: Kami does not store this information and should not be shared with Kami.
Orgs
Orgs
Field Name | Required | Supported | Unsupported |
sourcedId | ✓ | - | - |
dateLastModified | ✓ | - | - |
type | ✓ | - | - |
status | ✓ | - | - |
name | ✓ | - | - |
identifier | - | ✓ | - |
parentSourcedId | - | ✓ | - |
NCESId | ✓ | - | - |
mdrpid | - | ✓ | - |
orgStateId | - | ✓ | - |
gradeRange | - | ✓ | - |
address1 | - | ✓ | - |
address2 | - | ✓ | - |
city | - | ✓ | - |
state | - | ✓ | - |
postCode | - | ✓ | - |
phone | - | ✓ | - |
principal | - | ✓ | - |
principalEmail | - | ✓ | - |
Courses
Courses
Field Name | Required | Supported | Unsupported |
sourcedid | ✓ | - | - |
dataLastModified | ✓ | - | - |
orgSourcedId | ✓ | - | - |
status | ✓ | - | - |
title | ✓ | - | - |
courseCode | - | ✓ | - |
subjects | - | ✓ | - |
grades | - | ✓ | - |
subjectCodes | - | ✓ | - |
courseStateId | - | ✓ | - |
schoolYear | - | ✓ | - |
Classes
Classes
Field Name | Required | Supported | Unsupported |
sourcedId | ✓ | - | - |
dateLastModified | ✓ | - | - |
courseSroucedId | ✓ | - | - |
schoolSourcedId | ✓ | - | - |
status | ✓ | - | - |
title | ✓ | - | - |
classType | ✓ | - | - |
termSourcedIds | ✓ | - | - |
grades | - | ✓ | - |
location | - | ✓ | - |
subjectCodes | - | ✓ | - |
classCode | - | ✓ | - |
subjects | - | ✓ | - |
periods | - | ✓ | - |
SessionStartTime | - | ✓ | - |
SessionEndTime | - | ✓ | - |
classStateId | - | ✓ | - |
schoolYear | - | ✓ | - |
Users
Users
Note: The email field must match the Kami user's email address.
Field Name | Required | Supported | Unsupported |
sourcedId | ✓ | - | - |
dateLastModified | ✓ | - | - |
orgSourcedIds | ✓ | - | - |
username | ✓ | - | - |
familyName | ✓ | - | - |
status | ✓ | - | - |
enabledUser | ✓ | - | - |
role | ✓ | - | - |
givenName | - | ✓ | - |
✓ | - | - | |
userIds | - | ✓ | - |
identifier | - | ✓ | - |
agentSourcedIds | - | ✓ | - |
grades | - | ✓ | - |
primaryOrgSourcedId | - | ✓ | - |
userMasteridentifier | - | ✓ | - |
sms | - | - | ✓ |
password | - | - | ✓ |
middleName | - | - | ✓ |
phone | - | - | ✓ |
preferredGivenName | - | - | ✓ |
preferredFamilyName | - | - | ✓ |
prefferedMiddleName | - | - | ✓ |
pronouns | - | - | ✓ |
userStateId | - | ✓ | - |
Enrollments
Enrollments
Field Name | Required | Supported | Unsupported |
sourcedId | ✓ | - | - |
dateLastModified | ✓ | - | - |
schoolSourcedId | ✓ | - | - |
role | ✓ | - | - |
status | ✓ | - | - |
classSourcedId | ✓ | - | - |
userSourcedId | ✓ | - | - |
primary | - | ✓ | - |
beginDate | - | ✓ | - |
endDate | - | ✓ | - |
Academic Sessions
Academic Sessions
Field Name | Required | Supported | Unsupported |
sourcedId | ✓ | - | - |
dateLastModified | ✓ | - | - |
type | ✓ | - | - |
endDate | ✓ | - | - |
status | ✓ | - | - |
startDate | ✓ | - | - |
schoolYear | ✓ | - | - |
parentSourcedId | - | ✓ | - |
Demographics
Demographics
Demographics are not shared by default (Even with full permissions enabled).
Roles
Roles
Kami currently doesn't download data from Roles. We use the roles field from the Users data.
Field Name | Required | Supported | Unsupported |
sourcedId | ✓ | - | - |
dateLastModified | ✓ | - | - |
roleType | ✓ | - | - |
orgSourceId | ✓ | - | - |
status | ✓ | - | - |
userSourcedId | ✓ | - | - |
role | ✓ | - | - |
beginDate | - | ✓ | - |
endDate | - | ✓ | - |
userProfileSourcedId | - | ✓ | - |
Frequently Asked Questions
How long does it take for the roster to sync after enabling the connection?
How long does it take for the roster to sync after enabling the connection?
The roster sync runs once per day, so it will take up to 24 hours.
Can we control which users or classes are shared?
Can we control which users or classes are shared?
Yes, you can configure this by choosing the "Rule-Based" permission type. Here is a helpful article from ClassLink to get you started.
We already have manually created Kami accounts. Will the ClassLink roster overwrite them?
We already have manually created Kami accounts. Will the ClassLink roster overwrite them?
No. Existing Kami accounts are matched to ClassLink data via the email address field of a ClassLink User
What happens if a user is removed from our SIS?
What happens if a user is removed from our SIS?
ClassLink will stop sending that User through to Kami in the Roster Data. After 7 days of a user being removed from the SIS (and therefore from ClassLink), the User will be removed from any License(s) they were added to via the ClassLink integration.
Can I log into Kami via the ClassLink Launchpad?
Can I log into Kami via the ClassLink Launchpad?
Not yet, but it is currently in the works. Please look out for updates on our What's new page.