View source for Google Workspace Integration

{{DISPLAYTITLE:Synchronizing User Accounts with Google Workspace}}
{{Directory Services Preamble|Google Workspace account|Google Workspace}}

<p class=msnote>Please note that on December 16th 2019, [https://go.mailstore.com/?lang=en&target=gsuite-lsa-restriction Google announced] to limit access to Google Workspace accounts for less secure apps in the future.  This affects any MailStore Server version prior to 13, which therefore will no longer be able to authenticate users against Google Workspace when trying to log into MailStore Server.
<br/>
<br/>
In MailStore Server 13, support for modern authentication methods via OAuth 2.0 & OpenID Connect as per Google's recommendation was introduced. Although MailStore Server 13 still comes with support for IMAP-based authentication, this document only covers the setup using modern authentication methods as required by Google in the future.</p>

== Prerequisites, Recommendations, Limitations ==
* To comply with Google's requirements for ''Authorized redirect URIs'' of  OAuth 2.0 clients, MailStore Server must be accessible via an URI that ends with a public top-level domain. This does not necessarily mean that it must  indeed be accessible from the Internet. Google uses the list from https://publicsuffix.org for validation.
* For best user experience, the certificate used by MailStore Server should be trusted by all client and the used web browsers. Using a certificate that is signed by an trusted certificate authority or [[Using_Lets_Encrypt_Certificates|using Let's Encrypt certificates]] is highly recommended.
* If users are supposed to login to MailStore Server from outside the organization's network without a VPN, using [[Accessing_the_Archive_with_the_MailStore_Client_software|MailStore Client]], [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration|MailStore Outlook Add-in]] or the [[Accessing_the_Archive_with_MailStore_Web_Access|Web Access]], the URIs mentioned in this article must be resolvable via DNS on the Internet and port-forwardings to the MailStore Server computer must be set up on the firewall or router if necessary. 
* When using Google to authenticate users at login, [[Accessing_the_Archive_via_Integrated_IMAP_Server|accessing the archive via IMAP]] is not possible for technical reasons.

== Register Project with Google ==
Irregardless of whether own or third-party applications such as MailStore Server are supposed to interact with a Google Workspace account through Google APIs, they must be registered as a project with Google first. This is necessary to ensure that access by external applications is limited to a necessary  minimum and that each application uses its own set of credentials to authenticate with Google.

=== Create New Project ===
To register a project  for MailStore Server with Google, proceed as follows:

* Go to the [https://console.developers.google.com Google Developers Console].
* If prompted, login using a Google account of you Google Workspace organization. Logging in with a user that has admin privileges is highly recommended. 
* If no project exists, click ''Create Project'' on the dashboard. Otherwise, open the project list by clicking on the project drop-down in the header bar and click ''New project''.
* Type in a meaningful name into the ''Project name'' field, e.g. <tt>MailStore Server</tt>.
* Verify that ''Organization'' matches the desired organization and adjust the ''Location'' if needed.
* Click on ''Create''.

Once the project has been created, make sure that it is selected in the project drop-down list before proceeding. 

==== Add API Libraries ====
* Open the ''Navigation menu'' (☰) and select ''APIs & Services'' > ''Library''.
* In the ''API Library'', search and enable the following APIs and services:
*: <tt>Admin SDK</tt>
*: <tt>Gmail API</tt>

==== Customize Consent Screen ====
* Open the ''Navigation menu'' (☰) and select ''APIs & Services'' > ''OAuth consent screen''.
* Under ''User Type'' select ''Internal''.
* Click ''Create''.
* Type in a meaningful name into the ''App name'' field, e.g. <tt>MailStore Server</tt>.
* Fill out the other fields according to the policies of your organization.
* Click ''Save and Continue''.
* In the next steps, directly click ''Save and Continue'' again as MailStore Server does not need users to authorize any scopes.

=== Create Service Account ===
A service account is required for MailStore Server to authenticate with Google and request authorization to use certain Google APIs for synchronizing users and accessing mailboxes. Follow these steps to create such a service account.

* Open the ''Navigation menu'' (☰) and select ''APIs & Services'' > ''Credentials''.
* Click ''+ Create Credentials'' and select ''Service account'' from the drop-down list.
* On the ''Create service account'' page, enter a name for the service account, e.g. <tt>MailStore Server Service</tt>.
* Enter a description such as: <tt>Service account for MailStore Server to synchronize users and access mailboxes</tt>.
* Click ''Create''.
* The service account does not require permissions on project level, therefore do not select a role.
* Click ''Continue''.
* Users do not need access to the service account, so no changes are needed in the ''Grant users access to this service account'' step.
* Click ''Done''
* Back on the ''Credentials'' page, click on the newly created service account to open its properties.
* Under ''Keys'' click on ''Add Key'' and select ''Create new key''.
* Select ''JSON'' as key type and click ''Create''.
* The JSON file will be downloaded automatically. Save the JSON file in a secure location as it allows access to cloud resources of your organization.
* Click ''Close''.
* Back under ''Details'', click ''Show Domain-wide Delegation''.
* Check the ''Enable Google Workspace Domain-wide Delegation'' box.
* Click ''Save''.

On the ''Credentials'' page, there should be a service account listed under ''Service Accounts'' with a corresponding client listed under ''OAuth 2.0 Client IDs''.

=== Create OAuth 2.0 Client for User Authentication ===
To allow users to log in to MailStore Server by authenticating with Google using the OpenID Connect mechanism, an OAuth 2.0 client must be created as described below.

* Open the ''Navigation menu'' (☰) and select ''APIs & Services'' > ''Credentials''.
* Click ''+ Create Credentials'' and select ''OAuth client ID'' from the drop-down list.
* Select ''Web application'' as ''Application type''.
* Enter a ''Name'', e.g. <tt>MailStore Server OpenID Connect</tt>.
* Click ''+ Add URI'' under ''Authorized redirect URIs''.
* Enter the URI that is reachable by clients in the ''URIs'' field using the the following scheme:
*:<tt>https://<fqdn>[:<port>]/oidc/signin</tt>
*; with the following components:
*: '''https://'''<br/>Specifying the protocol ''https://'' is mandatory. To prevent certificate warnings later at login, the [[MailStore_Server_Service_Configuration#Certificate|certificate used by MailStore Server]] must be trusted by all client and the used web browsers. 
*: '''FQDN'''<br/>The fully qualified domain name of the MailStore Server computer, e.g. <tt>mailstore.example.com</tt>. This must be resolvable from all clients, from where users are supposed to log in to MailStore Server.
*: '''Port'''<br/>The TCP port of MailStore Web Access (default: <tt>8462</tt>). This must match the port configured in the [[MailStore Server Service Configuration#Services|MailStore Server Service Configuration]] at ''Network Settings'' > ''Services'' > ''MailStore Web Access / Outlook Add-in (HTTPS)''. The TCP port is only required if it is different from the default port of the HTTPS protocol (443).
*: '''/oidc/signin'''<br/>The path at which MailStore Server expects to receive the authentication response from Google via the web browser.
* Click ''Create'' to finish.
* Copy the client ID and client secret from the ''Your Client ID'' and ''Your Client Secret'' fields to a safe place (e.g. password safe or similar) and click ''OK''.
::{| class="wikitable"
|+ Examples of valid redirect URIs
|-
! style="width:80px;" | Product
! style="width:80px;" | Computername
! style="width:90px;" | DNS Domain
! style="width:40px;" | TCP Port
! Resulting Redirect URI
|-
| align="center"| MailStore Server
| align="center"| mailstore
| align="center"| example.com
| align="center"| 8462
| <code><nowiki>https://mailstore.example.com:8462/oidc/signin</nowiki></code><br/><br/>Redirect URI with fully qualified domain name and MailStore Web Access default port.
|-
| align="center"| MailStore Server
| align="center"| mailstore
| align="center"| example.com
| align="center"| 443
| <code><nowiki>https://mailstore.example.com/oidc/signin</nowiki></code><br/><br/>If the HTTPS default port 443 is used for MailStore Web Access or as source of a port forwarding rule on a firewall, specifying the port as part of the redirect URI can be omitted.
|-
| align="center"| MailStore SPE
| align="center"| archive
| align="center"| example.com
| align="center"| 443
| <code><nowiki>https://archive.example.com/<instanceid>/oidc/signin</nowiki></code><br/><br/>The ''instanceid'' of the instance is part of the Redirect URI. 
|-
|}

== Grant Access on Google Workspace Account to Project ==
Once created, grant the new project fine-grained access to your Google Workspace account by defining the Google APIs it is allowed to use.

* Open the [https://admin.google.com/ Google Admin console] and log in with a Google Workspace domain admin.
* Open the ''Navigation menu'' (☰) and select ''Security'' > ''API controls''.
* Under ''Domain wide delegation'', click ''Manage domain wide delegation''.
* On the ''Domain-wide delegation'' page, click ''Add new''.
* Enter the ''Client ID'' of the OAuth 2.0 Client that is linked with the service account.
* Under ''OAuth Scope'', add the following scopes:
*: <tt><nowiki>https://mail.google.com/, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.readonly</nowiki></tt>
* Click ''Authorize''.

== Configure MailStore Server ==
After the project has been successfully set up on the Google side, MailStore Server can now be configured to synchronize and authenticate users with Google Workspace.

{{Directory Services Accessing Configuration|Google Workspace|gapps_sync_01.png}}

=== Connection ===
For synchronization, MailStore Server requires information on how to connect to the Google Workspace.

* '''Key ID'''<br/>To import the private key, select the JSON file hat has been generated by Google for the service account in the [[#Create_Service_Account|Create Service Account]] step.
* '''Service Account'''<br/>The service account is determined automatically from the JSON file.
* '''User Name'''<br/>The email address of a Google Workspace Administrator (e.g. admin@example.com).

=== User Database Synchronization ===
After configuring the connection settings as described above, you can specify filter criteria for the Google Workspace synchronization in this section.

* '''Sync only these groups'''<br/>Choose one or several Google Workspace groups if you only want their members to be created as MailStore Server users. That way it's possible to exclude certain users from being synchronized to MailStore Server.

=== Authentication ===
The authentication settings define how MailStore Server should authenticate users at login, that have been synchronized from Google Workspace.

* '''Method'''<br/>Ensure that ''OpenID Connect'' is selected. As mentioned in the introduction, the ''IMAP'' option is only available for backward compatibility.
* '''Client ID'''<br/>Enter the client ID from the [[#Create_OAuth_2.0_Client_for_User_Authentication|Create OAuth_2.0 Client…]] step.
* '''Client Secret'''<br/>Enter the client secret from the [[#Create_OAuth_2.0_Client_for_User_Authentication|Create OAuth_2.0 Client…]] step. 
* '''Redirect URI'''<br/>Enter the same redirect URI as defined in the [[#Create_OAuth_2.0_Client_for_User_Authentication|Create OAuth 2.0 Client…]] step .

{{Directory Services Options|Google Workspace Account}}
{{Directory Services Assign Default Privileges|Google Workspace Account}}
{{Directory Services Run Synchronization|Google Workspace Account}}
[[File:ApplicationIntegration_sync_02.png|450px|center]]

{{Directory Services Test Authentication}}
[[de:Google Workspace-Integration]]
[[en:Google Workspace Integration]]