School Directory Sync Quick Start Guide
You can use Google School Directory Sync (SDS) to synchronize data from your school information system to Classroom and G Suite for Education.
By default, SDS synchronizes data with Classroom only. You can choose to synchronize also with G Suite for Education. For details on SDS features and benefits, see About Google SDS.
Note: Your school information data is never modified or compromised. SDS has no direct contact with your school's information system. It only synchronizes the CSV files you create and export to SDS.
How SDS works
- Decide what data to sync.
- Create CSV files from the data and export the files to SDS.
- SDS connects to and updates Classroom and G Suite for Education to match the school information data.
- After synchronization, a report is emailed to any addresses you've specified.
- A server to run SDS with either of these operating systems:
- Microsoft® Windows®—SDS is supported on Windows 7, Windows 8, Windows 10, and Windows Server 2008/2012/2016.
- Linux®—If you’re using a 32-bit version of SDS on a 64-bit Linux system, a 32-bit libc (such as libc6-i386 ) must be installed.
- If you have an x64 machine—Install the x64 version of SDS.
- At least 256 MB of free RAM.
- If you have less than 10,000 users, we recommend that you allocate at least 1 GB of free RAM.
- If you have more than 10,000, allocate at least 2 GB of free RAM.
- More than 250,000 users? You might need more RAM.
- At least 5 GB of disk space for log files and data. If you're running the DEBUG or INFO level of logging, you might need more free space for additional log data. For details, see Specify log settings.
- Collect data from your school information system and create comma-separated values (CSV) files in the IMS OneRosterTM v1.0 format.
- The exported CSV files must be located on the same server as SDS.
You don't need to run SDS on the same server as your school's information system.
- You must use your primary domain name, not a domain alias. The primary domain name is the one you use to access the Google Admin console.
- You need a super administrator account for your G Suite domain that's setup in the Admin console.
- You need to enable API access for the Classroom API and G Suite Administrative APIs.
- Network access to the G Suite for Education domain through HTTPS directly or through a proxy server. This includes ports 80 and 443.
For best results, we recommend a network connection to G Suite for Education with no proxies or firewalls.
- A mail server able to accept and relay notifications from SDS. If you don’t have one, you can also use Google’s default mail server (aspmx.l.google.com) without authentication.
- Set up access to SSL Certificate Authorities for your network.
Synchronizing with SDS
- Install SDS—Download and install SDS.
- Configure SDS—Use Configuration Manager to configure a synchronization. Enter your primary domain name, authenticate any administrator accounts, configure what you want to synchronize, and set up notifications and logging.
- Simulate synchronization—Use Configuration Manager to verify settings and simulate a synchronization. If you need, revise your configuration in Configuration Manager.
- Set password policies and data change thresholds— Set thresholds on data changes to avoid making unintended changes.
- Synchronize—When you get the configuration correct, click Sync & apply changes or use the command line to synchronize. The first synchronization, which imports all information, is likely to take much longer than later synchronizations.