OneRoster API (Application Programming Interfaces) is an Industry Standard format, from 1EdTech (formerly IMS Global), for exchange of Student Information System (SIS) / Student Management Systems (SMS) data. Using this sync method, you can connect directly to your SIS/SMS using the REST-based OneRoster 1.1 APIs developed by your SIS/SMS provider. The API support allows you to synchronize data directly instead of using CSV (Comma Separated Value) files.
Using the OneRoster API to ingest the data enables you to light up core SDS capabilities for provisioning. It also allows you to enhance experiences of the Microsoft 365 products and features. The OneRoster APIs are how we can synchronize objects from SIS/SMS that provides OneRoster APIs through the School Data Sync (SDS) platform.
My provider is not listed in the dropdown and the status here says Test. What do I need to do to see them in the provider list?
Reach out to the Customer support team to flight your tenant and gain access to the API providers currently Test. Share following information when raising the request:
Tenant ID
OneRoster Provider name
SDS version
Roster
Once your tenant is flighted, work with your OneRoster provider, and SDS POC to run tests and ensure that the integration is successful. If you run into any issue, work with the provider and SDS POC to get them resolved.
Once the test is successful, the OneRoster Provider status is updated (from test mode to yes) and available on list of publicly accessible providers for all tenants.
My provider is not listed. Is there information to share with them to participate as a OneRoster provider with SDS?
Share with your provider the following article Onboarding Guidance for OneRoster API Providers with SDS. The article includes steps needed to request being added as a OneRoster provider, including testing and validation before being placed in test mode first and then eventually in the public list for selection by tenants.
What endpoints are being accessed when ingesting roster data?
The following list is provided to help you better understand what data is being accessed when connecting to your SIS/SMS via OneRoster API.
For the optional pieces of data for demographics, student contact relationships and student user flags, the ability for you to include this data or not will be based on the supported optional data capabilities from your SIS/SMS OneRoster provider profile. If the SIS/SMS Provider also supports this data, you will see the toggle (default) selected On to include additional data. You can select the toggle to turn off if you wish. If the toggle is unavailable, shown but off and not available for interaction, this means that the provider’s profile does not currently support providing that data.
Note
If the provider’s profile shows demographics, contacts or user demographic flags as unavailable and you would like them to support that feature, contact your provider and request adding support to enable SDS to ingest the data and allow you to enable the scenarios and experiences the data supports.
Student contact relationship may be specified for student users to enhance educator experiences for communication to parents and guardians. Contacts are more users that are supplied with the /users and association to a student are found in the student’s user record under ‘agents’.
familyName, givenName, and email are required for users that have contact/guardian roles.
Expect phone and sms to be in E.164 and + must be included. (Example: +1234567890)
If reverse data is provided, from a contact relationship guardian record to student in the contact users ‘agents’ field, these records are filtered out.
Optional user demographics flags
User flags may be specified for student users to indicate their participation in a program or cohort. User flags are included (when true for the user), or not included if not applicable.
Flags are specified as a metadata extension for the user, in a metadata field, following a Key|Value pair. The key should be named microsoft.userFlags and must be formatted as a comma delimited list. User flags may appear in any order and aren't case sensitive.
Per 1EdTech it is the responsibility of the provider to enforce data privacy for what data is available when a data request is made. School Data Sync make a request for active data based on the time of the request.
OneRoster API access credentials needed
To enable the connection to the OneRoster API for your SIS/SMS, you need to provide the connection credentials. For more information, see your specific provider's documentation to obtain or to generate them.
Web access URL: URL where your OneRoster API is accessible for your SIS/SMS
Client ID that is used to connect to your SIS/SMS OneRoster API
Client Secret that is used to connect to your SIS/SMS OneRoster API
Access Token URL, if your SIS/SMS OneRoster API is configured for authentication using OAuth2, you need to provide the Access Token URL endpoint that used to connect. The endpoint is different from the Web access URL.
Helpful notes and tips
The endpoints always come after 'https://{server_URL}/ims/oneroster/v1p1'
To prevent certain schools from being included in the data being provided from the SIS to SDS, customers need to work with their Provider for how to configure what schools are included for the connection / credentials being used to link SDS to their SIS.
Endpoints have requirements on filter parameter support to allow filtering by status, or to enable delta sync.
SDS applies a filter on the dateLastModified property for delta sync/incremental sync processing and is required for integration with SDS.
Providers must choose to implement either OAuth1(a) or OAuth 2.0 (client credentials grant) authentication scheme. OAuth 2.0 is preferred.
If authentication protocol supported is "OAuth 2.0" - client credentials grant type, SDS would send the credentials in "Authorization" header. As recommended in the OneRoster specification we send the encoded client credentials in the Authorization header of token requests.
Contact Support at Phone (toll-free): (888) 324-5363 or support@aeries.com
Arbor Education
SIS Vendor
Arbor Education
Minimum Version of Software
N/A
Configuration Prerequisites
The integration between Arbor MIS and SDS is enabled on your Arbor MIS. Contact your account manager at Arbor to make sure it's enabled via accountmanagers@arbor-education.com. You must have an Office 365 education tenant, global administrator permissions, and School Data Sync (Plan 1) enabled.
How to get Client ID, Client Secret, and URL(s)
Generate in your Arbor MIS. Steps to complete are detailed in the Arbor Help Center.
Specific Instructions
Contact Arbor or your dedicated support partner to help set up this integration via myteam@arbor-education.com.
Help
Find support articles at Arbor's Help Centre. For questions, reach out to myteam@arbor-education.com or your dedicated support partner.
Blackbaud Education Management
SIS Vendor
Blackbaud Education Management
Minimum Version of Software
The latest version of BEM is always available to users.
When selecting your mapping settings for your Microsoft Entra users, be sure your settings to include/exclude the domain suffix matches your Microsoft Entra usernames. This action ensures the best results when matching BEM students and teachers to your Microsoft Entra users.
Customers can get their oAuth credentials from the console after they add the app. An email is to the developer at Microsoft that set up the app. Select on Adding Applications & Modifying Permissions to show the location to obtain the client ID and secret.
If there are issues connecting, ensure that the Web Access URL has "/ims/oneroster/v1p1" to point to the correct connectors.
For support, contact educate_support@communitybrands.com.
Edulife Connect
SIS Vendor
Edulife Connect
Minimum Version of Software
N/A
Configuration Prerequisites
N/A
How to get Client ID, Client Secret, and URL(s)
Done directly in contact with our deployment and support team.
Specific Instructions
N/A
Help
Contact support at support@wizkids.co.uk. // 020 7550 9286
eSchoolData
SIS Vendor
eSchoolData
Minimum Version of Software
N/A
Configuration Prerequisites
Districts must be subscribers of the eSD GURU product.
How to get Client ID, Client Secret, and URL(s)
See specific instructions.
Specific Instructions
In order to enable an API integration with SDS, district administrators must first create a vendor account within GURU. Navigate to Configuration > Vendors and select Create New Vendor. Enter a Vendor Name and retain the Client ID and Client Secret that are automatically generated. Provide, along with your regional GURU API URL, when configuring the SDS integration. Select Next and enable all OneRoster API permissions. Select Finish when complete to save the new account.
Help
For questions, contact your eSchoolData support team.
eSchooling
SIS Vendor
eSchooling by Codevision
Minimum Version of Software
1.1.20
Configuration Prerequisites
None
How to get Client ID, Client Secret, and URL(s)
Follow directions in eSchooling platform: System Administration > School Data Sync
Specific Instructions
Same as prior
Help
Contact suporte@codevision.pt
Eum School SIS
SIS Vendor
DataEum
Minimum Version of Software
N/A
Configuration Prerequisites
None
How to get Client ID, Client Secret, and URL(s)
Email customer support to request OneRoster API credentials.
Specific Instructions
Contact customer support pbd@dataeum.kr
Help
Contact customer support pbd@dataeum.kr
Eventful
SIS Vendor
Eventful
Minimum Version of Software
A list of supported student registers can be found at Eventful OneRoster.
Configuration Prerequisites
Reach out to Eventful by email at info@eventful.se or by phone at (+46) 10 209 9001
How to get Client ID, Client Secret, and URL(s)
Provided in the setup process.
Specific Instructions
N/A
Help
Contact Eventful Support by email at info@eventful.se or by phone at (+46) 10 209 9001
FACTS
SIS Vendor
FACTS
Minimum Version of Software
Not applicable. Latest version is always available to customers.
Configuration Prerequisites
Not applicable
How to get Client ID, Client Secret, and URL(s)
Customers sign up for OneRoster API and FACTS provides this information to them.
Specific Instructions
From within the SIS, go to System > Configuration > SIS Integrations > OneRoster API > Fill out form.
Help
Customer Support 866-800-6593
Focus School Software
SIS Vendor
Focus School Software
Minimum Version of Software
Focus v 8.7
Configuration Prerequisites
N/A
How to get Client ID, Client Secret, and URL(s)
From the Focus portal screen, Setup > System Setup > Third Party Systems. On the record insert row, enter, Title: Microsoft Version 1.0 > Dialect: OneRoster. Upon saving, the URL, Client ID and client secret are generated.
Specific Instructions
N/A
Help
Call Focus' phone support line at 877-410-6637.
Follett Aspen
SIS Vendor
Follett Aspen
Minimum Version of Software
Latest version of Aspen, 5.9
Configuration Prerequisites
N/A
How to get Client ID, Client Secret, and URL(s)
Contact the Customer Relationship Manager for your district to schedule the upgrade.
Specific Instructions
N/A
Help
Contact your Customer Relationship Manager for help.
Prior to V 1933.3 - Go to the Infinite Campus user interface >> select System Administration >> select Campus Learning >> select OneRoster Tools >> select on OneRoster. Version 1933.3 and later - Go to the Infinite Campus user interface >> select System Administration >> select Learning Interoperability
When selecting attributes within Infinite Campus to sync, ensure that period is not selected. If it's selected, there's a possibility it generates a large number of errors when syncing and lock the profile in quarantine.
For e-mail support, go to support@inlogic.dk, for Phone support, +45 42 40 88 15, and web support, https://www.inlogic.dk/support/.
iSAMS by IRIS
SIS Vendor
iSAMS by IRIS
Minimum Version of Software
21.4.23.12
Configuration Prerequisites
None
How to get Client ID, Client Secret, and URL(s)
You should email helpdesk requesting OneRoster API credentials at helpdesk@isams.co.uk
Specific Instructions
None
Help
Contact iSAMS Helpdesk to ask for help document at helpdesk@isams.co.uk.
IST
SIS Vendor
IST
Minimum Version of Software
Not applicable.
Configuration Prerequisites
See specific instructions.
How to get Client ID, Client Secret, and URL(s)
See specific instructions.
Specific Instructions
Information for setup is provided privately.
Help
For questions, contact your IST support team.
LIBRUS
SIS Vendor
LIBRUS
Minimum Version of Software
Current version
Configuration Prerequisites
Client must have a license for LIBRUS Synergia
How to get Client ID, Client Secret, and URL(s)
To enable an API integration with SDS, you must be logged in as an administrator or school principal. Navigate to Settings > Configuration > Other options > Office 365 Integration
Specific Instructions
Detailed instructions are available in the help section.
Help
Contact our support team at pomoc@LIBRUS.pl
MySchool
SIS Vendor
MySchool Ltd
Minimum Version of Software
Not applicable
Configuration Prerequisites
Initial setup of the MySchool system assisted through support team.
From the VULCAN Admin portal; Select “Configuration” > “Office 365 settings” > API exchange configuration. Enable “Synchronization with Office 365”. On this tab, you receive the Client ID, Client Secret, and URL(s).