Skip to content

Google Workspace Sync ​

Google Workspace Sync automatically imports and synchronizes your end users from Google Workspace (formerly G Suite).

Overview ​

With Google Workspace Sync, you can:

  • Automatically import end users from Google directory
  • Keep end user information synchronized
  • Sync Google Groups to Gryffi
  • Eliminate manual end user management

Prerequisites ​

Before connecting:

  1. Super Admin role in Google Workspace
  2. Admin role in Gryffi organization

Connecting Google Workspace ​

Step 1: Navigate to Sync Settings ​

Open in Gryffi: /dashboard/system-settings#users/google

Step 2: First make your Google Workspace ready for the sync ​

Before connecting, your Google Workspace administrator needs to authorize this application.

  1. Open Google Admin Console Go to admin.google.com and sign in with your administrator account.

  2. Navigate to API Controls Go to Security → Access and data control → API controls → Domain-wide delegation.

  3. Add API Client Click 'Add new' and enter the following details:

Client ID: 626812501063-6auk39empidnrmcouli99ob7of7cagji.apps.googleusercontent.com

OAuth Scopes: https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly 4. Authorize Click 'Authorize' to save the settings. You can now connect your Google Workspace account.

Important Only a Google Workspace Super Admin can configure domain-wide delegation. If you're not the admin, please share these instructions with them.

Step 3: Click "Connect With Google" ​

You'll be redirected to Google sign-in.

Step 4: Sign In ​

Log in with your Google Workspace super admin account.

Step 5: Grant Permissions ​

Approve all the permissions for Gryffi:

Step 6: Configure Sync Options ​

After connecting, configure your sync preferences. Like what groups or end users to sync.

Sync Configuration ​

User Sync Options ​

OptionDescription
Sync All UsersImport entire organization
Google GroupsSync members of specific groups

Group Sync Options ​

OptionDescription
Sync GroupsImport Google Groups
Group MembersInclude members of selected groups

Sync Schedule ​

Sync is scheduled every 15 minutes. You can also manually sync if you don't want to wait.

Gryffi Community Edition is open source under the AGPL-3.0.