On the Directories page, you can create a new directory sync for an organization and access all organizations that currently have a directory sync. SMB organizations can be synced to their respective directory via the + Add Directory Sync.
Directory Sync
BullPhish ID supports synchronization with the Azure, Google, and Passly active directories. You can configure directories and grant permissions to import groups to BullPhish ID on the Directories page.
Directory Sync Preference
Directory Sync Preference options determine how targets are handled in BullPhish ID after they have been deleted from an organization's active directory.
The Directory Sync Preference options are:
-
Targets status remains unchanged on BullPhish ID: This is the default selection. When targets are deleted from active directory groups:
-
The targets are removed from the BullPhish ID groups that are synced with the active directory groups. Targets in groups created manually in BullPhish ID are not affected.
- The Status of each target in BullPhish ID remains the same. In other words, the Active or Inactive Status of each target remains unchanged on the Targets page.
-
Deactivate targets on BullPhish ID: When targets are deleted from active directory groups:
-
The targets are removed from the BullPhish ID groups that are synced with the active directory groups. Targets in groups created manually in BullPhish ID are not affected.
- Each target is deactivated in BullPhish ID and the Status for each is changed to Inactive.
You select a Directory Sync Preference option when creating a new directory sync or editing an existing directory sync. The selected option goes into effect when the next directory sync occurs.
Here is the Directory Settings modal that is displayed when editing an existing directory sync. The Directory Sync Preference options are at the bottom.
Note: Directory Sync Preference options are not available when syncing with IT Glue.
Adding a Directory Sync
To sync BullPhish ID with an active directory, you will need account information for the applicable active directory. The procedure for syncing each active directory type is described below.
Azure Active Directory
To sync BullPhish ID with Azure Active Directory:
- Configure Azure Active Directory as described in the Azure Active Directory Configuration Guide.
- Log into BullPhish ID.
- In the navigation menu, select Targets & Groups > Directories.
- in the upper-right corner, click + Add Directory Sync.
- In the Add Directory Sync modal, complete the following:
- Organization
- Directory Type: Select Azure
- Tenant ID: Created when configuring Azure Active Directory
- Client ID: Created when configuring Azure Active Directory
- Client Secret: Created when configuring Azure Active Directory
- Directory Sync Preference
- Do one of the following:
- Click Save.
- Click Save & Sync. The sync is executed and the Edit Directory page for the organization is displayed.
Google Active Directory
To sync BullPhish ID with Google Active Directory:
- Configure Google Active Directory as described in the DirectorySync G-Suite guide.
- Log into BullPhish ID.
- In the navigation menu, select Targets & Groups > Directories.
- in the upper-right corner, click + Add Directory Sync.
- In the Add Directory Sync modal, complete the following:
- Organization
- Directory Type: Select Google
- Impersonation Email: Created when configuring Google Active Directory
- Service Account Credentials: Created when configuring Google Active Directory
- Directory Sync Preference
- Do one of the following:
-
- Click Save.
- Click Save & Sync. The sync is executed and the Edit Directory page for the organization is displayed.
Passly Active Directory
To sync BullPhish ID with Passly Active Directory:
- Configure Passly Active Directory as described in the BullPhish ID Integration with Passly guide.
- Log into BullPhish ID.
- In the navigation menu, select Targets & Groups > Directories.
- in the upper-right corner, click + Add Directory Sync.
- In the Add Directory Sync modal, complete the following:
- Organization
- Directory Type: Select Passly
- Host: Created when configuring Passly Active Directory
- Domain: Created when configuring Passly Active Directory
- ID: Created when configuring Passly Active Directory
- Key: Created when configuring Passly Active Directory
- Directory Sync Preference
- Do one of the following:
- Click Save.
- Click Save & Sync. The sync is executed and the Edit Directory page for the organization is displayed.
Edit Directory Sync Preference
To edit the Directory Sync Preference for an existing directory sync:
- Log into BullPhish ID.
- In the navigation menu, select Targets & Groups > Directories.
- For the desired organization, click the edit icon.
- In the upper-right corner, click Directory Settings.
- Select the desired Directory Sync Preference option.
- Click Save.
Edit Directory page
Once the directory has been successfully synced, you are taken to the Edit Directory page of the organization.
You will see two radio button options: Groups & Targets.
Groups:
You can select a group from the drop-down menu and sync them to BullPhish ID.
You can preview up to 20 targets within the group by clicking the Preview button below the Group Selection dropdown.
Click the Sync button to sync the selected group. When you select Sync Now, the status of all groups changes to Syncing. Click the Refresh Sync button or refresh the page to update the table. Once a group has been successfully synced, you will see details specific to that group under the Synced Groups table with the following information:
- Group Name
- Status
- Last Sync date
- Added/Removed users from the most recent sync
- # Of total targets within the group
Once a directory has been synced to BullPhish ID, you can find the groups by selecting the group in the Synced Groups table or on the Groups page.
Navigate to the left panel and go to Targets & Groups > Groups.
Causes of an inactive status:
- When users enter expired active directory credentials, the synchronization cannot be completed successfully.
- When users remove permissions on the active directory site, or the synchronization is unsuccessful.
Note: If you want to delete synchronization with the Active directory, you can click delete on the action column, and a modal window will open. Click Delete.
Targets:
To sync all existing Targets from the active directory to BullPhish ID, click the Targets radio button and provide a name.
- Name: Create a new group name. All targets will sync to this specific group from the active directory; for example, BPID-Group.
- Click Preview. The Preview modal window only displays a list of 20 target names and emails in the directory and syncs all targets from the active directory. For example, if there are 40 targets in the group, the preview button will only show 20 targets as a sample.
- Click Close to go back to the edit directory page.
- Click the Sync button to import all targets from the Azure/Google directory to BullPhish ID under the created group name. Once targets are successfully imported, the Targets radio button will not be available. You will see a notification Targets have been imported under the group when you hover over it.
When the user selects sync now, the status of all groups changes to Syncing. Click the Refresh Sync button or refresh the page to update the table with Synced Group targets. The Refresh Sync button updates the table with Synced Group targets.
After successful synchronization, the status changes from Syncing to Active. You can see the date and time of the most recent synchronization along with the added users, removed users, and # of targets.
Sync Now: You will see a Sync Now in the upper-right corner of the active directory page. This Sync Now button schedules syncing processes of all groups, which are displayed in the Synced Groups table. Sync Now works in the following way:
-
- It creates a new job to resync all existing synced groups.
- Existing targets get updated if they have any updates in the Azure/Google directories.
- It removes targets from groups and creates new targets for the groups.
-
With the help of action icons, you can perform the following tasks on Synced Groups table.
-
Synchronize specific Group (Sync icon): You can now synchronize a specific group using the Sync icon from the action column without synching all groups.
-
The status changes to Syncing; click the Refresh Sync button to update the table.
-
- Remove specific Group (remove icon): Once a group has been successfully synced under the Synced Groups table from the active directory, you can remove a specific group using the Remove icon from the action column.
Note: The removed group will still be available on the Groups page under the associated organization.
-
-
-
A modal window will appear with the title Remove Synced Group. Once you click Confirm, the group will remain on BullPhish ID, but the connection to the Active Directory will be removed. You may permanently delete the group from the Groups Page.
Related Articles:
Follow the below articles to learn more about Targets and Groups.
How to create Targets?
How to create Groups?