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

Status

FunctionalityStable, limited
Support statusSupportable
Support provided byEvolveum; Support may also be available from original author.
OriginCommunity (AMI Praha)
Target systemsGoogle Apps SAAS platform

MidPoint version

Connector requires midPoint 3.4.1 or newer.

This connector does not work correctly in midPoint 3.8 - see MID-4683

Description

Protocol

Google API / OAuth 2.0

SecuritySSL/TLS 1.2

Framework

Polygon 1.4.2.14

Connector name

com.evolveum.polygon.connector.googleapps.GoogleAppsConnector

LicenceCDDL-1.0
Sourcehttps://github.com/Evolveum/connector-googleapps

History

Connector was introduced as a contribution to midPoint project by AMI Praha.

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.

Premium only

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 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:

Configuration Property
Required
Type
Default Value
Description
domainXString
Internet domain name. Seehttps://support.google.com/a/answer/177483?hl=en
clientIdXString
Client identifier issued to the client during the registration process.
clientSecretXGuardedString
Client secret issued to the client during the registration process.
refreshTokenXGuardedString
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. Typical value: Google-Apps-For-Business. For more information see https://developers.google.com/admin-sdk/licensing/v1/how-tos/products

autoaddlic
BooleanFalseAutomatically add license to user after create
productidXString
Product ID. Typical value: Google-Apps. For more information see https://developers.google.com/admin-sdk/licensing/v1/how-tos/products

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.



  • No labels