Integrating an Account with Google Workspace

Overview

The Google Workspace integration allows you to sync your PhishingBox account with a Google Workspace directory. This integration will add your Google Workspace users as targets on PhishingBox. 

Setting up the integration will require a Google Workspace user with Administrator privileges.

The client ID for the application is 110415018621831148079.

Use the links below to jump to a section:

1. Grant Permissions to the App
2. Integration Store
3. Create/Edit Group
4. Synced Attributes

Grant Permissions to the App

To get started, you will need to grant permissions to the PhishingBox app:

1. Open the Google Workspace Admin console.
2. Navigate to Security > Access and data control > API Controls.
3. At the bottom of the API Controls page, click the 'MANAGE DOMAIN WIDE DELEGATION' link.
   
4. Click 'Add new'.
5. Input 110415018621831148079 into the Client ID field
6. Add the following scopes:
   • https://www.googleapis.com/auth/admin.directory.orgunit.readonly 
   • https://www.googleapis.com/auth/admin.directory.user.readonly 
7. Click the 'AUTHORIZE' button.
   

NOTE: If you're a Google Sales Partner that manages multiple Google Workspace Tenants, you will need to configure the above settings for each Google Workspace tenant you want to sync users from. 

Integration Store

After granting permissions to the app in Google Workspace, you are now ready to configure the integration in PhishingBox:

1. In the PhishingBox portal, navigate to Administration > Integration Store.
   
2. Click the 'Setup' button located on the bottom-right of the Google Workspace card.
   
3. In the Edit Configuration form, set the 'Active' toggle to 'YES'
4. Input a Google Workspace administrator email address. This user must be an administrator on the primary domain.  

5. Click the 'Test' button to authenticate and fetch the workspace's OUs.

   NOTE: If the "Sync sub OUs" option is enabled, any users in sub-OUs of the selected OUs will be included in the sync. If it is not enabled, the sync will contain only the users in the selected OUs.

   
   

If successful, the workspace's OUs will be available for selection. Select the OUs you'd like to sync then click 'Save' to save the integration.

NOTE: '/' is the root OU. If selected, all users in the directory will sync into a single PhishingBox group.

Furthermore, under Advanced Settings, you may also skip certain target fields for updating in integrated groups, as well as toggle on Retrieve user language from mailbox settings:

Create/Edit Group

In the PhishingBox portal, navigate to Targets / Groups > Create Group (/group_cu.php). On the 'Create Group' form, input a group name and select 'Google Workspace' in the 'Third-Party Syncing' option menu. Click the 'Create Group' button to create the group.

After the group is created, the Google Workspace settings form will appear. Input an admin email from the workspace then click the 'Get Groups' button to fetch the workspace's OUs. Select an OU and click the 'Update Group' button to save the group's integration settings.

NOTE: '/' is the root OU. If selected, all users in the directory will sync into a single PhishingBox group.

Synced Attributes

Below is table that shows the mapping of Google Workspace user attributes to PhishingBox target fields.

NOTE: Custom attributes will not be synced into PhishingBox

Back to top