Skip to content

Google Workspace Connection

Google workspace is a collection of cloud-based tools and software products that are used by organizations for collaborations in enterprises. It offers a directory service in which one can create and manage accounts, configure administrator settings and monitor its usage in their domain.

Previously many organizations used on-premise AD or Entra ID. However, due to the new age features offered by Google, they are now shifting towards Workspace, especially in the education sector.

The Google Workspace application uses OAuth authorization with Hire2Retire. By linking your Google workspace to Hire2Retire, you enable delegated and automated access to our platform. To ensure a smooth integration experience, the following permissions are required.

Scopes Explanation
admin.directory.orgunit.readonly Scope for only retrieving organizational units.
admin.directory.userschema.readonly Scope for only retrieving custom user schemas.
admin.directory.user Global scope for access to all user and user alias operations.
admin.directory.group Global scope for access to all group operations, including group aliases and members.
cloud-identity.groups.readonly Cloud Identity Groups that you can access, including group members and their emails.
offline_access Maintain access to data you have given it access to. When a user approves the offline_access scope, Hire2retire can receive refresh tokens from the google identity platform token endpoint. Refresh tokens are long-lived. Hire2retire can get new access tokens as older ones expire.

Create a Connection

You need to create a Google Workspace account if you want to use the application for integration on Hire2Retire.

Google Workspace Connection Name

Figure 1. Google Workspace Connection

You can find the Customer ID in Google Workspace Admin Console: Go to Google Workspace Admin Console > Account Settings > Profile > Customer ID

Google Workspace Customer ID

Figure 2. Google Workspace Admin Console

After clicking the 'Link Account' button, you'll be redirected to the Google Account authorization screen. Simply enter your account details to enable Workspace for this process.

Google Workspace Sign In

Figure 3. Google Workspace Sign In

By granting access, you authorize Hire2Retire to connect with your Google Workspace account and make updates based on the available HR data.