OneRoster provider overview

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.

For more information on how to set up your tenant to use OneRoster API as a source, Data Ingestion with OneRoster API.

OneRoster providers status and capabilities

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.

Required API Endpoints for SDS

Optional API Endpoints for SDS

Optional user student contact relationships

Student contact relationship can 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.’

• For more information, see the supported student contact relationship roles supported by SDS see Default List of Values: Contact Relationship Roles.

• 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 can appear in any order and aren't case sensitive.

For more information, see the default list of user flag values supported by SDS see Default List of Values: User Flags.

Example:

{ 
  "user" : { 
   … 
   … 
    "metadata" : { 
     "microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“ 
    } 
}

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.

OneRoster provider details

Aequitas

Aeries

Arbor Education

Blackbaud Education Management

Bubblecon

ClassLink

Classter

Edge Learning

Educate by Community Brands

Edulife Connect

eSchoolData

eSchooling

Eum School SIS

Eventful

FACTS

Focus School Software

Follett Aspen

Furlong Schoolbase

INACAP SDS API

Infinitas Learning

Infinite Campus

inLogic

iSAMS by IRIS

IST

LIBRUS

MySchool

Rediker Software

SIMS

Skool

Skyward

SmartSchool

Synergy SIS

Trivium

Vigilo

Visma InSchool

VULCAN UONET+