Skip to main content
OneRoster is off until a school administrator turns it on in Settings › Integrations › OneRoster.

Credentials

On OneRoster’s page, the administrator creates credentials for each tool: a name, a client ID that starts with sc_, and a secret shown once. The tool trades them for an access token that lasts an hour, sending them as HTTP Basic authentication or in the form body:
Deleting a tool’s credentials, or turning OneRoster off, stops the tool at its next request.

Collections

Read the roster at /ims/oneroster/v1p1/{collection} and /ims/oneroster/v1p1/{collection}/{sourcedId}: orgs, schools, academicSessions, terms, courses, classes, users, students, teachers and enrollments. Lists take OneRoster’s limit, offset, sort, orderBy, fields and filter (with AND or OR), and return the total in X-Total-Count.

What’s in the roster

The organization and school, the current school year and its terms, a course per class, the year’s active classes, active students with their school email addresses, teachers assigned to a class, and current enrollments. It holds no families, no contact details beyond school email, and nothing from a student’s record. A tool that takes a file instead can use Download Roster, a zip of OneRoster’s CSV files.