Difference between revisions of "Retain Google Apps"

Revision as of 22:51, 11 November 2016

Change to Google Apps API Requiring Retain 3.5.1

The Google Apps API has changed since the time that the Google Apps module was developed. Thus, Retain 3.5 and earlier used the old API. Retain 3.5.1 and later is using the new API. As of April 20, 2015, the old API is being discontinued by Google, thus requiring an upgrade to Retain 3.5.1 or later.

Here are some configuration resources for the Google Apps module:

• KB article with all of the instructions: Retain 3.5.1 and the Changes to the Google Apps API
• Training video: "Retain 3.5.1 for Google Apps - Module Configuration" given by Steve Dorrough

Back to Retain Module Configuration

Configuring Google Apps (GSuite) for Retain 4.x

== You will need access to the following interfaces to setup Retain for archiving with Google Apps:

API Admin Access/IAM & Admin/Developer Console/API Manager

Admin Console/Google Apps Console Administration ==

1. Log into Google Apps Developer Console/API Manager:

• https://console.developers.google.com/

2. Create a project

• Click Project | New Project
• Give the Project a name (Retain)

Give it a moment to create the project. It might take a minute.

Note: After the project is created it will automatically be used, and you can edit the settings. If you need to change projects, or select the project, click projects at the top and select the name of your project.

3. Configure Credentials, OATH, and Client ID

• Click Menu Button (Top Left) Top left and select API Manager
• Click Credentials
  • Click Oath Consent Screen Tab
    • Enter in Email address (It is recommended to use the same account that is logged into the developer console) Copy this address. This will be used in the Retain connection to Google Apps.
    • Enter in Product Name: Retain
    • Leave everything else blank and click SAVE
• Click on Credentials Tab
  • Select OAuth client ID
    • Select Web Application
• Enter in Retain as the name.
• In the Authorized Java Script Origins enter in: http://retainIP or hostname (Do not enter in any other URI i.e. /RetainServer)
• Click Create
• Copy the Client ID to a notepad.
• Copy the Client Secret
• Copy the Client ID (24 digit number) (This will be used in the Authorize Domain section)

4. Create a Service Account

• Click on Menu at top left and select IAM & Admin. Select Service Accounts
• Click Create Service Account
  • Enter in name of service account (Retain-service).
  • Select Role: Owner (optional)
  • Check the Enable G Suit Domain-wide Delegation
  • Click Create
  • Copy the Service Account ID (Must have @ symbol). (Copy this Service Account. This will be used in the Retain connection for Google Apps)

5. Create P12 and Key

• Click on Service Accounts in IAM & Admin
• Click the more icon next to the Retain Service Account ID (3 vertical dots)
• Select P12 and click Create. Download this file and keep it safe. (This file will need to be uploaded in the Google Apps Module in the Retain connection for Google Apps)

6. Enable APIs

• Log in the developer Console | API Manager.
• Click Library.
• Enable the 3 APIs: calendar, gmail and Admin SDK. Simply click on them and then click Enable at the top for each.
• Do not enable other APIs as that may cause issues with the Retain project.

7. Authorize the Domain—

• Log into the Go to the Admin Console/Google Apps: https://admin.google.com/AdminHome?hl=en
• Click Security
• Select Advanced Settings
• Click on Manage API Client Access
• Paste the 24 Digit number in Client Name
• From the Retain Google Apps Module, copy the URLS into the scopes field:

https://mail.google.com/,https://www.googleapis.com/auth/admin.directory.group ,https://www.googleapis.com/auth/admin.directory.user ,https://www.googleapis.com/auth/gmail.readonly

• Click Authorize

If for whatever reason it still fails, then check the NTP configuration, the Client ID in Manage Access, and/or the e-mail address. If all else fails, create a new project and go through the documentation slowly.,

Configure Retain to Connect to Google Apps (GSuite)

1. Click on configure for the Google Apps (Gsuite) Module.

2. Click on Settings Tab

• Fill in the Email address of OAuth Service Account: Step 4 from Configuring Google Apps (GSuite) for Retain 4.x
• Upload the p12 Key File
• Enter in the e-mail address that created the project in Google Apps: Step 2 from Configuring Google Apps (GSuite) for Retain 4.x

3. Test connection

4. Save Changes