Get started with Directory Sync

This page is for Directory Sync. If you're using Google Cloud Directory Sync (GCDS), go to GCDS. Directory Sync is in public beta.

Use Directory Sync to synchronize user and group data from an external directory to your Google cloud directory. The sync process takes place in the cloud, so there's no need to install a sync client or on-premises software. Directory Sync is ideal if you want to sync your Microsoft Active Directory (AD) or Microsoft Entra ID data with your organization's Google Account.

The Google Workspace support team doesn't provide support for third-party migration tools. To learn more, go to Support for third-party tools.

Set up Directory Sync

If you're already using Google Cloud Directory Sync, follow the steps to move from Google Cloud Directory Sync.

Follow these steps to set up a new Directory Sync if you're using AD (if you're using Microsoft Entra ID, skip to step 4):

  1. Ensure you have connectivity between Google Cloud and AD

    Before you begin, ensure that the network connection is available between Google Cloud and your LDAP server.

  2. Set up a VPC access connector in Google Cloud

    You need a Virtual Private Cloud (VPC) access connector to allow Directory Sync to connect to AD using your existing networking setup.

  3. Enable the Data Connectors API

    Using the same project where you set up your VPC access connector, enable the Data Connectors API.

  4. Add your external directory to Directory Sync

    Use the Google Admin console to connect to your external directory using Directory Sync.

  5. Configure your user and group sync in Directory Sync

    Decide how you want your users and groups to sync to your Google cloud directory. You set this up in the Admin console. Check your setup by running a simulated sync.

  6. Run a sync

    Start syncing your data to your Google cloud directory. Track progress in the audit & investigation page of the Admin console.

Move from Google Cloud Directory Sync

If you are using Google Cloud Directory Sync (GCDS) to sync with AD, you can switch to Directory Sync using the following steps:

  1. Make sure that your LDAP server is accessible from Google Cloud

    How you manage your setup depends on whether your LDAP server is hosted directly on Google Cloud or whether you intend to connect to Google Cloud using Cloud VPN or Google Interconnect.

  2. Set up a VPC access connector in Google Cloud

    You need a Virtual Private Cloud (VPC) access connector to use Directory Sync.

  3. Enable the Data Connectors API

    Using the same project where you set up your VPC access connector, enable the Data Connector API.

  4. Add your LDAP directory to Directory Sync

    Use the Google Admin console to connect to your LDAP server using Directory Sync.

  5. Set up your user and group sync in Directory Sync

    Decide how you want your users and groups to sync to your Google cloud directory. You set this up in the Admin console. Check your setup by running a simulated sync.

  6. Turn off automatic syncs in GCDS

    If you use a scheduling software to automate syncs, turn off the schedule. Don't run a manual sync.

  7. Run a sync in Directory Sync

    You're now ready to start syncing to your Google cloud directory with Directory Sync.

Support for third-party tools

  • If you're using a third-party synchronization tool, such as the Microsoft Entra ID provisioning service, you can create a Workspace support case if the issue relates to a Directory API. These cases are assigned to the Admin console support team.
  • In support cases for third-party tools, the Workspace support team might verify that a Google API caused the issue, refer the case to the appropriate API team, and provide you with information about Workspace support capabilities.

Next step

Review the system requirements


Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.