Difference between revisions of "G Suite Integration"

Jump to: navigation, search
[unchecked revision][unchecked revision]
(Customize Consent Screen)
Line 36: Line 36:
==== Customize Consent Screen ====
==== Customize Consent Screen ====
* Click on ''OAuth consent screen'' in the left navigation pane.
* Click on ''OAuth consent screen'' in the left navigation pane.
* Select ''Internal'' as ''User Type''.
* Enter ''MailStore'' as ''Product name for the consent screen''.
* Click on ''Create''
* Fill in the following information:
** '''Application name'''<br/>Enter a meaningful Name that helps user to identify the application, e.g. ''MailStore''
** '''Authorized domains''<br/>Enter the domain under which the MailStore Server is located, e.g. <tt>example.com</tt> if MailStore Server is accessible through <tt>mailstore.example.com</tt>.
* Click on ''Save''.
* Click on ''Save''.
* Click on the service account to see its service account details. Note the unique ID (Client ID) and the email address shown for use in the next step.
=== Grant access to the required APIs  ===
=== Grant access to the required APIs  ===

Revision as of 17:06, 27 May 2020

In addition to adding users manually as described in chapter User Management, MailStore Server can synchronize its internal user database with the G Suite account of your organization.

During synchronization, user information, such as user names and email addresses, is copied from the G Suite account into MailStore Server's user database. That way, users can use their G Suite account credentials to also log on to MailStore Server and emails can be assigned to their corresponding user archives automatically, for example. No changes are made to the G Suite account itself by MailStore Server. The scope of the synchronization can be limited through filters.

Prepare the G Suite account

In order to synchronize account information from G Suite, MailStore Server requires a service account which has been granted permission to access the G Suite account. The same service account is later used for archiving email from G Suite, too.

Creating a Project

Before MailStore is able to connect to G Suite accounts, a project has to be created. In Google's terminology, a project is the collection of all settings, credentials and meta data of an application that uses Google Developer APIs or Google Cloud resources.

  • Go to the Google Developers Console.
  • If prompted, login using a Google Account of you G Suite organization. A user with administrative privileges is highly recommend.
  • If no project exists, click Create on the dashboard. Otherwise open the Project drop-down list in the header bar and click New Project.
  • Name the project, e.g. MailStore API Access. By default a random Project ID is assigned, change it if desired. Click Create.
  • Once the project has been created, APIs & Services is shown.
  • Make sure that you have selected the newly created project. You can change the project by using the drop-down list.

Adding API Libraries

  • Click on Library in the left navigation pane.
  • In the API Library, enable Admin SDK and Gmail API.
  • Return to the project's dashboard by clicking on Google APIs in the top navigation bar.

Adding Credentials

  • Click on Credentials' in the left navigation pane.
  • Click Create Credentials and select Service account from the drop-down list.
  • On the Create service account screen, enter a name for the service account. The Service account ID gets updated automatically based on the service account name, but can be changed if desired.
  • Click on Continue.
  • The service account does not require permissions on project level, therefore do not select a role.
  • Click on Continue.
  • Only grant other users access to this service account if absolutely necessary, which is typically not the case.
  • Click on Create Key in the Keys section.
  • Select the JSON as key type and click on Create.
  • The JSON file will be downloaded automatically. Save the JSON file (e.g. MailStore API Access-e035d2ad4f35.json) in a secure location as it allows access to cloud resources of your organization.
  • Click on Close and then on Done to finish the creation of credentials.
  • Click on the newly created service account to access details.
  • Click on Show Domain-wide Delegation.
  • Check the Enable G Suite Domain-wide Delegation box.
  • Click on Save.

Customize Consent Screen

  • Click on OAuth consent screen in the left navigation pane.
  • Select Internal as User Type.
  • Click on Create
  • Fill in the following information:
    • Application name
      Enter a meaningful Name that helps user to identify the application, e.g. MailStore
    • 'Authorized domains
      Enter the domain under which the MailStore Server is located, e.g. example.com if MailStore Server is accessible through mailstore.example.com.
  • Click on Save.

Grant access to the required APIs

Once created, grant the project access to the APIs used by MailStore Server's Directory Services module.

  • Go to your G Suite domain’s Admin console.
  • Select Security from the list of controls. If you don't see Security listed, select More controls from the gray bar at the bottom of the page, then select Security from the list of controls. If you can't see the controls, make sure you're signed in as an administrator for the domain.
  • Click on Basic Settings.
  • Make sure that the setting under Less secure apps is not set to Disable access to less secure apps for all users (Recommended). If it is, choose one of the other options and save the changes.
  • Navigate back to Security.
  • Select API reference from the list of options.
  • Enable the API access and save the changes.
  • Select Advanced settings from the list of options. If this section is not visible, click on Show more first.
  • Select Manage API client access in the Authentication section.
  • In the Client name field enter the service account's Unique ID (Client ID) (e.g. 108878593494909748351).
  • In the One or More API Scopes field enter the following scopes:
    https://mail.google.com/, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.readonly
  • Click Authorize.

Accessing Directory Service Integration

  • Log on to MailStore Client as a MailStore Server administrator.
  • Click on Administrative Tools > Users and Archives > Directory Services.
  • In the Integration section, change the directory service type to G Suite.
Gapps sync 01.png

Connection to G Suite

For synchronization MailStore Server requires information on how to connect to the G Suite.

  • Key ID
    To import the private key, select the JSON file (e.g. MailStore API Access-e035d2ad4f35.json) that has been generated by Google for the service account.
  • Service Account
    The service account is determined automatically from the JSON file.
  • User Name
    The email address of a G Suite Administrator (e.g. admin@example.com).

User Database Synchronization

After configuring the connection settings as described above, you can specify filter criteria for the G Suite synchronization in this section.

  • Sync only these groups
    Choose one or several G Suite 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.


  • Automatically delete users in MailStore Server
    Here you can choose whether users that have been deleted in the G Suite Account will also be deleted in the MailStore user database by the synchronization. If the archive folder of such a user already contains archived emails, only the user entry but not its archive folder will be deleted in MailStore. Additionally, only MailStore users that have their authentication method set to Directory Services will be deleted.

Assigning Default Privileges

By default, users that have been synchronized to MailStore Server from G Suite Account have the privilege to log on to MailStore Server as well as read access to their own user archive.
You can configure those default privileges before synchronization, for example, to assign the privilege Archive E-mail to all new users. To do this, click on Default Privileges...
More information on managing user privileges and their effects is available in the chapter Users, Folders and Settings which also has details on editing existing privileges.

Running Directory Services Synchronization

Click on Test Settings to check synchronization configuration and the results returned by the G Suite Account without any changes to the MailStore Server user database being actually committed.

To finally run the synchronization, click on Synchronize now. The results are shown with any changes committed to the MailStore Server user database.

ApplicationIntegration sync 02.png

You can test the authentication for a user by first selecting him from the list and then clicking on the button on the lower left. You will now be asked for that user's password. Upon clicking OK you'll receive a message whether the authentication has been successful.

Important Notice: For authentication with G Suite to work, the setting Allow less secure apps of the respective G Suite user has to turned on if it has not been enforced for all users (see above).

Login with G Suite Account Credentials

After synchronization MailStore users can log on to MailStore Server with their G Suite Account username and G Suite Account password.

About MailStore

  • MailStore Server is one of the leading email archiving solutions for SMB.
  • For private use there is a free tool for email archiving furthermore: MailStore Home.