Now your server is ready to go and you can provision access to your roster data with vendors that accept the OneRoster format.
Granting Apps Permissions
Click on the Applications tab to see a list of applications you have currently provisioned access to. All added apps will be presented here and will show any Recent REST and SFTP Access by the app. Org or Course Access gives a quick overview of how much access that app has for Orgs and Courses. The levels are Full and Basic.
Toggling Show Extra Columns will give an expanded view of all the users the application's permissions encompass.
How to Add An Application
To add an app in OneRoster, you will need to go in Applications (left blue column) and click Add Applications (top right blue button).
You can either search for an app or go through the list and add them.
By switching the toggle one, it will show the applications that are flagged as development in the developer console.
(Under the name, you'll see a "DEV" label)
You can choose between two permission types: Custom and Full.
Custom is the most common permission set with toggles for Unenrolled Users and Demographics. By default, OneRoster will only send users that are enrolled in a class (teachers and students). If you wish to send administrators, turn on the Unenrolled Users toggle. You can also switch off demographics for vendors that don’t require it. The Custom type allows for selection of all or some schools and courses.
Full will automatically select all orgs and courses, along with unenrolled users and demographics.
OneRoster will automatically filter the data based upon the selections made here.
(Permissions are not permanent! They can be edited later on.)
Course permission options
When selecting courses, there are special options that can be accessed by clicking the "Actions" button on the right side of the menu.
The actions available are "Paste IDs" (explained in the next section), "Select courses by Courses: Org ID" and "Select courses by Classes: School ID". The "Selecting courses by Courses: Org ID" option will select all the courses that are assigned to the orgs that are currently selected. The second option, "Select courses by Classes: School ID" will take the classes assigned to the orgs currently selected, and add courses based on those classes' School IDs. In other words, it will select all the courses assigned to the classes that your selected orgs have.
Bulk select values
You also have the option of mass-selecting courses/orgs using a comma separated list of sourcedIds. Click on "Paste IDs" to open a text field.
After pasting in the values, you must validate the IDs.
The error report card will show the number of invalid sourcedIds:
Confirm Your Selection
Once you are done selecting Orgs and Courses, click Add App to complete your application.
More on Dependencies
If you click on the 3 dots under Actions, you will have options for:
- Edit Permissions - Edit Orgs and Courses permissions that were previously set.
- Find - Search for a Class or User. See Find for more details.
- Explore in API - Redirects to the ClassLink Roster Server API
- Run Sanity Check - Runs a Sanity Check to see if the data has the correct connections.
- API Key and Secret - Displays the API key and secret of the app.
- SFTP Settings - Set up data export and file transfer.
- Filter Fields - Add or remove metadata fields to the application's permissions.
- Email Developer - Email is sent to the developer who created the application. If there are multiple developers on the account, then it will only email the developer who signed up the app.
- Remove - Deletes the application.
CSV or REST?
What does this mean? Your OneRoster server can provide data to vendors using either CSV files or the REST API.
What's the difference?
CSV files are sent to the vendor using the OneRoster format. This requires an additional step to set up the SFTP details to send the files, which is explained in the Exporting Data page.
With REST API, the vendors fetch the data directly from your server.