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

Version 1 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.



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.


To install the Google Apps connector, add the bundle JAR file to a directory on your disk. If your application has a dedicated directory for connector bundles, put the file in that directory. For example, Apache Syncope looks for connector bundles in the configured bundles directory.

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.

Obtaining the configuration parameter values

  1. Log in to your Google API Manager with your Google admin account.

  2. Make sure API access is enabled.

  3. Retrieve credentials JSON:

  1. Open JSON file and make note of following properties: 
  1. Change to the directory where you have downloaded the bundle and run the following command on the client_secrets.json file that you obtained earlier in this procedure:

    $ jar xvf net.tirasa.connid.bundles.googleapps-1.4.0.jar
    $ java -jar net.tirasa.connid.bundles.googleapps-1.4.0.jar /path/to/client_secrets.json
    Please open the following address in your browser:

    This command opens the default browser, and loads a screen on which you authorize consent to access the Google Apps account.


    If you have recently created your Google Apps account, it might take some time (often two hours or more) to synchronize the data required for this access request to work. For additional information, refer to the Google documentation noted earlier.

  2. When you have authorized consent, the browser returns a code. Copy and paste the code into the terminal from which you ran the original command.

    $ Attempting to open that address in the default browser now...
    Please enter code:

    A response similar to the following is returned: 

        "clientId" : "",
        "clientSecret" : "0xhx9xrx8xdxqx9xDxjxUx3x",
        "refreshToken" : "1x7xmxfx_yxuxNxUxFxjxVxVxkxXx3XxHxMxYxzx5xcxI"
  3. You can now use the information above to populate the configuration properties as reported above.


  • No labels