Google Workspace Directory

Integrate Google Workspace with the host application for seamless user management

This guide helps administrators sync their Google Workspace directory with an application they want to onboard to their organization. Integrating your application with Google Workspace automates user management tasks and ensures access rights stay up-to-date.

1. Access the directory configuration screen

Navigate to the Admin Portal of your application and select the "Directory Sync" tab. You'll see a list of available directory providers.

Directory Sync configuration screen with various provider options.

2. Select Google Workspace

From the list of directory providers, locate and click on "Google Workspace".

Select Google Workspace from the available directory providers.

3. Begin configuration

Click on the "Configure" button to start setting up the Google Workspace integration.

Click Configure to begin setting up the Google Workspace integration.

4. Authorize Google Workspace

To establish the connection, you need to authorize access to your Google Workspace directory. Click on "Authorize Google Workspace".

Click Authorize Google Workspace to begin the authorization process.

5. Sign in with Google admin account

You'll be redirected to Google's authentication page. Sign in with your Google Workspace administrator account. If you're already signed in with multiple accounts, select "Use another account" to ensure you're using your administrator account.

Select "Use another account" if you need to sign in with a different Google account.

6. Enter administrator credentials

Enter your Google Workspace administrator email address and password when prompted.

Enter your Google Workspace administrator email address.

7. Grant required permissions

When prompted, review and confirm the permissions requested by the application. These permissions allow the application to read user and group information from your Google Workspace directory.

Review the requested permissions for directory access.

Click "Continue" to grant the necessary permissions.

Click Continue to grant directory access permissions.

8. Select groups to sync

After authorization, you'll see the groups available in your Google Workspace directory. Select the groups you want to synchronize with your application.

Select which Google Workspace groups you want to sync with your application.

9. Map IdP groups to application roles (optional)

Map IdP groups to application roles to control access to your application. This needs to be enabled by the host application.

Map IdP groups to application roles to control access to your application.

10. Enable directory sync

After selecting your groups, click "Enable Sync" to activate the integration.

Click Enable Sync to start synchronizing users and groups from Google Workspace.

Troubleshooting

If you encounter issues during synchronization:

1. Authorization errors: Ensure you have sufficient privileges to authorize us to access your users and groups information from your Google Workspace directory.
2. Missing users/groups: We automatically fetch latest users and groups from Google Workspace directory once every hour. If you would like to trigger a sync manually, use the "Sync Now" button in the Actions menu.