Prerequisite

Obtain connection parameters and authentication credentials from your OneRoster Provider.

Create Connection

Create an API Consumer connection to connect to a Student Information System or other OneRoster-enabled data source.

From the "Data" page in Data Sync begin your data source setup and select OneRoster as your Method for connection. If you see your data source listed specifically, please use this profile as it is purposely built to simplify the connection process for you.

Authentication

Some student information systems use non-standard authentication methods for OneRoster Authentication. DataSync supports OAuth1 as well as OAuth2 in both the Client Credentials and Password workflows. If you don't know which method your data source supports, you will need to contact your provider to get help obtaining this information.

OAuth1

Property

Description

URL

This is the URL for the Base of OneRoster. It typically looks something like https://some.exampleprovider.com/ims/oneroster/v1p1. Your vendor will provide this.

Consumer Key

A unique key specific to you. Your vendor will provide this.

Consumer Secret

A generated secret key. Your vendor will provide this.

OAuth2 Password Workflow

URL

This is the URL for the Base of OneRoster. It typically looks something like https://some.exampleprovider.com/ims/oneroster/v1p1. Your vendor will be able to provide this.

Username

This is the username of the user that has the required access to OneRoster APIs from your vendor

Password

This is the password of the user above

Scope

Optional value, may be required. Please verify with your vendor

Grant Type

Password

Access Token URL

This URL is required to get the access token back from your vendor. The URLs typically look like http://some.exampleprovider.com/oauth/token. Your vendor will provide this.

OAuth2 Client Credentials Workflow

URL

This is the URL for the Base of OneRoster. It typically looks something like https://some.exampleprovider.com/ims/oneroster/v1p1. Your vendor will be able to provide this.

Client ID

This is the Client ID required access to OneRoster APIs from your vendor.

Client Secret

This is the Secret of the client above. Your vendor will to provide this.

Scope

Optional value, may be required. Please verify with your vendor.

Grant Type

Client Credentials

Authorization URL

This URL is used to obtain an authorization token. Should be provided by your vendor.

Access Token URL

This URL is required to get the access token back from your vendor. Their URLs typically look like http://some.exampleprovider.com/oauth/token and may be the same as the authorization URL. Your vendor will provide this.

Connect

Data Sync will validate your connection information to your vendor to make sure that we were able to successfully obtain the required credentials and data from your provider. Once that is successful, you may finish your setup.

OneRoster Rest API Support resources

Data Sync queries the following OneRoster API endpoints when collecting all data.

Rostering

Data Sync Topic

Endpoint

Terms

GET /terms

Sections

GET /classes

Courses

GET /courses

Enrollments

GET /enrollments

Students

GET /students

Teachers

GET /teachers

Persons

GET /users

Demographics

GET /demographics if supported by Provider

Schools

GET /schools
or
GET /orgs if LEA topic is published

LEAs

GET /orgs

Grades (only if enabled)

Topic

Endpoint

GradingCategory

GET /categories

Assignment

PUT /lineItems/{id}

AssignmentScore

PUT /results/{id}

Did this answer your question?