Admin Managers' Guide: Google Workspace Directory Integration

Syncing your Google Workspace directory with Goldphish allows you to automatically import and update user accounts across your organisation.

In This Guide:

Step 1: Authorise Domain-Wide Delegation in Google Admin

Step 2: Configure in the Security Awareness Platform

Step 3: Sync Summary & Sync Review

Before You Begin

Make sure you have the following in place:

• Google Workspace Super Admin Access: A valid Super Administrator account to configure domain-wide delegation in the Google Admin Console.
• Sufficient Licences: Ensure you have enough Goldphish licences to cover all users you want to sync. If you attempt to sync more users than you have licences for, the sync will fail.
• Clean Directory Records: Every synced user must have a valid primary email address.
• Directory Scope: Decide whether you are syncing all Workspace users or restricting sync to a specific Google Group.

Step 1: Authorise Domain-Wide Delegation in Google Admin

Before connecting Goldphish to Google Workspace, you must authorise the Goldphish API client within your Google Admin Console.

1. Sign in to your Google Admin Console using a Super Administrator account.
2. Go to Security > Access and data control > API controls  > Manage Domain Wide Delegation.
3. Add the Goldphish API client: Create a new API client and use that Client ID
4. Authorise the read - only scopes: Paste the following comma-separated OAuth scopes into the client.
5. Select Authorise.

Step 2: Configure in the Security Awareness Platform

Next, input your Workspace parameters into the User Sync section on the Goldphish platform.

1. Log into your Goldphish Dashboard.
2. Go to Settings > User Sync.
3. Select Setup Google Workspace.

4. Configure the Connection Details:

• Schedule Type: Select  Manual, Daily, or Weekly depending on how often you want user data refreshed.
• Workspace Customer ID: Enter your Customer ID (Found in Google Admin under Account > Account settings > Profile; starts with C ).
• Delegated Admin Email: Enter the email address of a Google Workspace Super Administrator whose account Goldphish will impersonate for read-only directory queries.
• Google Group ID, Email, or Alias (Optional): Enter a specific group ID/email if you only want to sync direct members of that group. Leave this field blank to sync all users across the organisation.

5. Click Test And Save.

Step 3: Sync Summary & Sync Review

1. After clicking Test And Save, Goldphish will verify the delegation credentials and generate a preview.
2. Preview Sync: Review the summary dashboard to inspect the actions that will take place.

• New Learners: Displays accounts that will be imported into Goldphish.
• Updated Learners: Displays existing users whose attributes will be updated.

3. Activate Sync: Confirm the changes to complete the initial import.
4. Verify: Navigate to Users in the main side menu to confirm that your imported learners are visible in the platform.

If you ever get stuck or need some tailored help, we’ve got your back! Pop us a message via the in-app chatbot or drop us an email via support - we're happy to help! 😊