ClassLink Support Docs

ClassLink Support Documentation

Welcome to the ClassLink Support Docs page. You'll find comprehensive guides and documentation to help you start working with ClassLink as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results

Applications

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 NO ACCESS, LIMITED ACCESS, and FULL ACCESS. The number in the top right corner is the access count.

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.

Development Apps

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)

Setup Permissions

You can choose between three permission types: None, Basic, and Full.

None will not allow any orgs or courses access.

Basic is the most common permission set with toggles for Unenrolled Users, Demographics, and Resources. 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 and resources for vendors that don’t require it. The Basic 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.)

Confirm Your Selection

Once you are done selecting Orgs and Courses, click ADD to complete your application.

All Done!

Application Actions

If you click on the 3 dots under Actions, you will have options for:

  • Permissions - Edit Orgs and Courses permissions that were previously set.
  • Find - Search for a Class or User. See Find for more details.
  • Run Sanity Check - Runs a Sanity Check.
  • API Key and Secret - Displays the API key and secret of the app.
  • SFTP Settings - Set up data export and file transfer.
  • 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 Roster 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.

Applications