The OneRoster tab contains settings that enable syncing roster data from SISs that support the OneRoster standard.
.png)
OneRoster Integration allows connection to any student information system (SIS) that supports the OneRoster standard and provides OneRoster Endpoints. Note that some SISs support OneRoster, but only through exported CSV files. Securly Classroom does not support the CSV upload method. The SIS must provide OneRoster API endpoints for connection and integration.
The method of setting up OneRoster endpoints varies from system to system. Typically there will be an admin settings area with an option to create new OneRoster endpoints. Once created, the system will provide the set of credentials needed to fill into the OneRoster section in Securly Classroom. Consult your SIS User Guide or support documentation for more information.
You will find the API endpoint, Client ID, Client Secret values in your SIS. Copy and paste them into these fields.
You may choose to edit the following sync options:
| Option | Description |
|---|---|
| Use this integration as a source for Username | Enabling this will allow Securly Classroom to pull usernames from the OneRoster automatically by default. Districts using Windows and Mac devices can also set rules to reformat usernames as it comes from the sync source to ensure they match their local device login requirements. This should be configured with the assistance of Securly Support. |
| Auto create locations from roster data | When enabled, the sync process will automatically create new locations in Securly Classroom based on data found on the roster import. If not selected, all classes from the sync will be created in the Main Location. |
| Use incremental sync when possible | When checked, only new and changed items will sync else a full sync will be performed. Incremental sync is only possible if the source data uses the dateLastModified field. |
| Add field to class names to avoid duplicate names | Lets you append fields (period, academic session title, class code, source ID) to class names to easily tell apart classes with the same name. |
| Daily sync start | Set the time when the daily sync occurs. |
| OneRoster Role mapping | This option allows importing users with the roles of Teacher, Aid, and Administrator, and assign them any desired role in Securly Classroom. Using the 1.2 protocol allows even more defined role fields, including counselors, principals, site admin, system admin, and district admin. |
Notes on using OneRoster
- Any teacher found on an incoming class roster will automatically be created as a Securly Classroom user with the "Teacher 1" role in Securly Classroom.
- When using incremental sync, where the source data uses the dateLastModified field, classes with an enrollment.beginDate in the future (like in the next term or school year) are still imported into the system. However, these future classes won't be immediately visible to users. The system automatically hides them until 15 days before the class start date, even if the data isn't updated again.