Magidoc

1Edtech (Formerly IMS Global) OneRoster 1.1 API

#

Overview

#

Seed customers who have subscribed to Authentica's Sprout package can use our implementation of the OneRoster 1.1 specification. We support all rostering endpoints except for demographic endpoints.

Authentication

#

Before accessing the API, you must retrieve a bearer token using the Client ID and Secret provided by your client. If you are an Authentica Seed customer, you can generate a Client ID and Secret by creating a datashare within the Seed Portal.

The authentication flow is described in section 3.6.2 of the OneRoster Specification, which can be found at https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452003 . Sprout supports the following scopes for rostering:

The token URL for production is: https://authenticaseedprod.ciamlogin.com/authenticaseedprod.onmicrosoft.com/oauth2/v2.0/token .

Using the API

#

Once you have retrieved a bearer token, you can retrieve data using the rostering API endpoints as defined in section 3.1 of the OneRoster 1.1 Specification, which can be found at: https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480451989 . Sprout supports all of the endpoints listed under Rostering, except for those /demographics.

The base API URL for production is: https://oneroster.authenticaseed.com/ims/oneroster/v1p1/ .