Setting up Google Workspace synchronisation allows you to easily import your users and groups to usecure directly from your Google Workspace directory, and to keep your users and groups automatically up to date on the usecure app.
To set up Google Workspace synchronisation, you will need to:
How to authenticate your Google Workspace account in usecure
To start setting up your Google Workspace synchronisation, head to the Google Workspace Settings page inside your usecure app.
If you haven't run through the Google Workspace usecure setup process before, you will be prodded to start the setup on the Google Workspace settings page.
You will need to have the right roles/privileges within Google Workspace to authorise synchronisation.
Click the Sign in with Google button to start the setup process.
You will be prompted to select between Delegated User and Service Account authentication.
Delegated User authentication is the quicker method of the 2 and relies on the Google account used to authorise the sync. This account must have sufficient roles/privileges for the sync to work.
Service Account authentication requires more effort to set up but offers better service continuity. You will need to specify a sufficient privileged user for the service account to impersonate but authentication is ultimately tied to the service account. This means it won't be disrupted by things like the authorising user changing their password.
For the sake of ease this guide will use the delegated user method. Once selected you will then be prodded to sign in to your Google account and allow usecure to access user and group data using the authentication type you selected.
The consent screen may differ slightly from the one above as each permission may have a checkbox next to it. Please ensure that you accept all the permissions presented otherwise the sync may not work in full.
How to set up automatic synchronisation
Step One - Starting The Setup Wizard
The usecure Google Workspace synchronisation setup wizard will now start. You will see an introduction page to let you know which options you will be able to configure.
Click Start on the bottom right to proceed.
Step Two - Automatic sync options
On the second page of the setup wizard, you will be able to choose whether you want the Google Workspace sync to run automatically. If you choose the sync to not run automatically, you will need to perform manual synchronisations to import users and groups from Google Workspace into usecure.
Once you have chosen whether you want syncs to run automatically, click Next on the bottom right to proceed.
Step Three - Choose whether to include groups
On the fourth page you will be able to choose whether you want to include groups in your Google Workspace sync. If you choose not to include groups, only users will be imported without any group data.
Step Four - Choose whether to select groups users are imported from
You will now be able to choose whether to only import users from certain groups in your Google Workspace. If you select No, users from all groups will be synced.
Step Five - Choose whether to map groups
You may already have a group structure in the usecure app that doesn't mirror your group structure in Google Workspace. If so, you can use this step to begin group mapping, which will allow you to map groups from Google Workspace into your existing group configuration on the usecure app.
Step Six - Choose which types of groups to import
You can import Groups and/or Organisational Units from Google Workspace. In this step, you can choose whether to import one or both data types from your Google Workspace
Step Seven - Configure your groups
In this step you will be able to choose which groups to include in syncs and/or which groups to import users from. If you chose to enable group mapping, you will also see an option to map groups from Google Workspace into existing groups in your usecure app.
Step Eight - Exclude Users who do have a mailbox
You can exclude users without a mailbox from the sync during this step. This can be useful for excluding users who lack a Gmail licence or have been created ahead of their first day at your organisation.
Step Nine - Choose whether to import managers
You can choose whether you want to import assigned managers for each user into usecure. These will show on the Users page as Direct Managers.
Step Ten - Configure your user email deny list
You may have users in your Google Workspace who you wish not to import to the usecure app. You can add their email addresses to this email deny list to ensure that they won't be included in any future syncs.
Step Eleven - Test your synchronisation
The setup wizard will now prompt you to test your Google Workspace synchronisation. This test sync will show you what data a synchronisation will find and synchronise without importing any data to the usecure app yet. The Test Sync emails the results of the sync to the address you've signed in with.
Once you are satisfied that your test sync is working you can run a Manual Sync to apply the changes.
Step Twelve - Complete your Google Workspace setup
Your Google Workspace synchronisation setup is now complete. If you enabled automatic synchronisation your chosen users and groups will automatically be imported to the usecure app within the next 24 hours. If you chose to not enable automatic synchronisation, you will need to run a Manual Sync to import your users and groups.