Syncing Data with OneRoster

Let’s see how to create and add a group, and sync it with OneRoster.

1. Sign in with your Enterprise Admin credentials.

2. Click on + Group for adding a group.

3. Enter the group details like Group Name, Description, Email ID, and Client Group ID. > Select OneRoster1.1 or OneRoster 1.2 from the SSO Source/Onboarding Type

dropdown menu.

NOTE: The moment you select OneRoster as the Onboarding type, a new field by the name Sync Type with Sync With API as a default sync type will appear. The other fields that you will find there are – Sync Frequency, Client Partner ID, Consumer Key, Secret Key, URL, and Path. If you are selecting the OneRoster 1.1 then you can see the Authorization Option there you can select OAuth1.0 or OAuth 2.0.

4. The other Sync Type options are: SFTP and Zip Upload. We have continued with the default option, i.e., Sync With API in this example.

 If you select the Sync With API option, OneRoster will do an API call and pull the

required data from the service. It will then create a partner, class, and a user. You can sync the OneRoster data by using the Sync with OneRoster hyperlink. You can also delete the OneRoster data on the server. The data will also get deleted from your system once you use the Update option.

● If you select the SFTP option as the sync type, the OneRoster file would not be uploaded automatically. You will have to provide the SFTP where you have placed your CSV file.

The server will then pick the OneRoster file from the SFTP you provide and create a

partner, class and a user.You can then assign the content to the desired class and user.

● If you select the Zip Upload option as the sync type, the user will be able to upload the OneRoster zip file to the server. The LMS will then create a class, and user aligned to the Partner ID you use. You can then assign the content to the desired class and user.

NOTE

There are two Sync Frequency options – Manual and Auto. Here Manual means you will have to manually sync the data. And, Auto means the system will automatically sync the data.

If you select the Auto data syncing option, you will have to define how frequently you want the system to sync the data. Currently, there are six options available.

5. We have selected Auto as the Sync Frequency option, and Weekly as the

Period for sync frequency in this example.

6. Enter details in the Customer Key, Secret Key, and URL fields.

7. Select Customers from the list. > Click on Select Cover for providing a cover

image to your group. > Click on Add.

NOTE

Some of the customers on the list are greyed out. This is because they

are already part of another group. Hence they cannot be selected.

Finally, you will get a confirmation message: Sync up request is accepted.