SDM DocumentationPluginsSource Plugins
OneRoster API
Connect to OneRoster REST APIs for live data synchronization
OneRoster API Source
Connect directly to your Student Information System's REST API for real-time data.
Overview
- Plugin ID:
source-oneroster - Data Format: OneRoster v1.2 REST API
- Best For: Live integration with SIS systems
Supported Systems
Any system implementing OneRoster v1.2 API:
- Librus
- PowerSchool
- Infinite Campus
- Other compliant systems
Connection Management
SDM provides a centralized system for managing OneRoster API connections. Instead of entering credentials every time you create a flow, you can save connections and reuse them.
Creating a Connection
- When configuring a OneRoster API source, click Create New Connection
- Choose a provider template:
- Librus - Pre-configured for Librus SIS (Poland)
- Custom - Manual configuration for any OneRoster API
- Enter connection details (name, Base URL, Client ID, Client Secret)
- Optionally set a custom Auth URL and proxy country
- Click Test Connection to verify credentials
- Save the connection
Reusing Connections
Once saved, connections appear in the Connection Selector dropdown when configuring any OneRoster API source - both in the wizard and advanced flow editor. Select an existing connection instead of re-entering credentials.
Connection Status
| Status | Description |
|---|---|
| Configured | Connection saved but not yet tested |
| Testing | Connection test in progress |
| Success | Last test passed successfully |
| Error | Last test failed - check credentials |
Connections are shared across your organization. Any member can use saved connections when creating flows.
Configuration
| Field | Description | Required |
|---|---|---|
| Connection | Select a saved connection or create new | Yes |
| Base URL | API endpoint (when creating new) | Yes |
| Client ID | OAuth client identifier (when creating new) | Yes |
| Client Secret | OAuth client secret (when creating new) | Yes |
| Auth URL | Custom OAuth endpoint | No |
| Proxy Country | EU proxy for GDPR compliance | No |
Setup Steps
- Select an existing connection from the dropdown, or click Create New Connection
- If creating new: enter Base URL, Client ID, and Client Secret
- Click Test Connection to verify credentials
- Wait for pre-flight check to complete
Data Fetching
The plugin fetches entities in parallel:
- Organizations
- Courses
- Classes
- Users
- Enrollments
Troubleshooting
Authentication Failed
- Verify Client ID and Secret are correct
- Check credentials haven't expired
- Ensure API access is enabled
Connection Timeout
- Verify the Base URL is correct
- Check network allows outbound HTTPS