Description

Google Apps Connector for midPoint is based on ForgeRock's OpenICF connector released in December 2015. It was enhanced with some unique fixes and updates and was ported to Evolveum's Polygon project.

Status

Google Apps Connector is intended for production use. Connector was introduced as a contribution to midPoint project by AMI Praha and is not officially supported by Evolveum.

Google Apps Connector contains support for ACCOUNT and GROUP (mailing lists entities). However, as the original connector contains support for more entity types, not all of those were fully tested with midPoint. Current focus is on ACCOUNT entity.

Overview

Google Apps is a Software-as-a-Service platform (SaaS), that provides email, calendar, documents and other services. This connector uses the Google Apps provisioning APIs to add, modify and delete user accounts and email aliases.

More information on Google Apps as well as Google user management console can be found here.

Supported Operations

The Google Apps connector supports the following operations:

• Create
• Delete
• Get
• Schema
• Search
• Test
• Update
• Validate

Configuration

The following table lists all the configuration properties you can specify when setting up the Google Apps connector:

Getting started

Building the connector

Download and build the project with usual:

mvn clean install

Import connector JAR file to one of these locations:

• midPoint WEB-INF/lib
• application server (e.g. Tomcat) lib directory
• icf-connectors directory in midPoint home

Creating resource

Sample resource XML can be found here.

Configuring resource

1. Obtain credential codes for Google API. Log in to Google API Manager with your Google admin account.

2. If you have not done already - create new project and then create new credentials for "OAuth client ID" (and "other" option).

3. Make sure API access is enabled for at least: Admin SDK and Enterprise License Manager API.

4. Retrieve credentials in JSON by click on the icon as follows:
   

5. Open JSON file and make note of following properties: 

   client_id":"XXXX434004-XXXu8jrm1iqp3clirelba480qXXX.apps.googleusercontent.com

   client_secret":"48zv5mfYZZZZw3QTcb8RBXXX"

    

6. In order to authenticate with Google you will also need refreshToken. To retrieve it, go to your connector-googleapps java project, run the main and confirm requested action in your web browser.
   

   connector-googleapps> mvn exec:java -Dexec.mainClass="com.evolveum.polygon.connector.googleapps.Main"
   -------------------------------------------------------------------------------------------
   Generate credentials for GoogleApps Connector
   -------------------------------------------------------------------------------------------
   You have to created and registered App in Google API and Google API enabled.
   Add these credentials into configuration fields in Google Apps Connector. See readme.txt.
   -------------------------------------------------------------------------------------------
   Enter Client ID: <censored> 
   Enter Client Secret: <censored>  
    
   Please open the following address in your browser:
     https://accounts.google.com/o/oauth2/auth?<censored>
   Generated credentials:
   {
     "clientId" : "<censored>",
     "clientSecret" : "<censored>",
     "refreshToken" : "<censored>"
   }

7. You now have all the information you need to configure the connector resource in the midPoint.