Valid sources include Microsoft Active Directory, CSV (comma-separated values) files, and ClassLink OneRoster. Each source requires different forms of credentials or setup.
CSV files can be uploaded to OneSync by adding CSV files to a OneSync directory. This directory is automatically generated by your installer and can be located at C:\ClassLink OneSync. You can download a Sample CSV at the bottom of this article or create your own CSV file using programs such as, but not limited to, NotePad or Microsoft Excel. The screenshots below illustrate the same set of CSV data, viewed in Notepad versus Excel.
Note: When using Microsoft Excel to edit and format your CSV data, you must save your file as type "CSV (Comma delimited)".
OneSync can import data from your Roster Server, but requires the server's URL, API Key, and Secret. To find these credentials, log into your Roster Server account through the ClassLink portal or here. You can find the URL at the top right of any page, next to the logout button.
Note: You must add “/ims/oneroster/v1p1/users” to the end of the URL. For example, the URL below must be formatted as "https://sandbox-demo-v2.oneroster.com/ims/oneroster/v1p1/users".
You can then find the API Key & Secret by navigating to the Applications page, finding the ClassLink app (make sure it has full permissions) and clicking the three dots in the “Actions” column. In the dropdown list, click “API Key and Secret” for the current Key and Secret.
Note: If your server is ever reset, the Key and secret will change. The Key and Secret stored in OneSync will not auto-refresh, so you will need to update the credentials there as well.
Microsoft Active Directory
Active Directory requires credentials including a username, password, protocol, domain, base path, and port number. You can check your connection status by clicking the Test Connection button. The default values for protocol and port number are LDAP and 389, respectively. The domain is the user’s personal preference. The base path is the distinguished name of the domain, including the domain component (DC), and excluding the common name (CN) and organization units (OU).