Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


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

It contains support for ACCOUNT and GROUP (mailing lists entities). However the original connector contains support for even more entity types, these were not fully tested with midPoint. Current focus is on ACCOUNT entity.


Google API / OAuth 2.0

SecuritySSL/TLS 1.2



Connector name




Testing in progress. Not recommended for production environment yet.


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 create, add, delete and modify user accounts and email aliases.

Please note that only the Premium (paid) or Educational versions of Google Apps provide access to the provisioning APIs. This connector will not work on free Google Apps domains.

More information on Google Apps can be found here.

Supported Operations

The Google Apps connector supports the following operations:

  • Authentication
  • Create
  • Delete
  • Get
  • Schema
  • ScriptOnConnector
  • Search
  • Sync
  • Test
  • Update
  • Validate


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

Configuration Property
Default Value
domainXString Internet domain name. See
clientIdXString Client identifier issued to the client during the registration process.
clientSecretXGuardedString Client secret issued to the client during the registration process.
 The refresh token allows you to get a new access token that is good for another hour. Refresh tokens never expire, they can only be revoked by the user or programatically by your app.
skuid String Stock Keeping Units (SKU) ID. For more information see
autoaddlic BooleanFalseAutomatically add license to user after create
productidXString Product ID. For more information see

Getting started

  1. Download and build the project with usual:

    mvn clean install
  2. Now you need to obtain credential codes for Google API. Log in to Google API Manager with your Google admin account.

  3. Make sure API access is enabled and credentials created. Retrieve credentials JSON by click on the icon as follows:

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



  5. 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:<censored>
    Generated credentials:
      "clientId" : "<censored>",
      "clientSecret" : "<censored>",
      "refreshToken" : "<censored>"
  6. You now have all the information you need to configure the connector resource in the midPoint.


  • No labels