Google Apps Connector
Introduction
Description
Google Apps Connector allows to manage users and groups using the Google Directory API.
Managed System
This connector is specific for integration with the Google domain.
For more information to check if your system may be synchronized with this connector you do not hesitate to contact us through our Contact form
Prerequisites
To get a service account and a private key, please follow this link: Creating a service account. You must:
- Register a new project
- Enable AdminSDK API
- Register a new OAuth service account. Store the JSON generated file in a secure place.
Furthermore, you will need to follow this guide to enable the recently created account to use directory API services. The scopes to grant are:
- View and manage the provisioning of groups on your domain: https://www.googleapis.com/auth/admin.directory.group
- View and manage group subscriptions on your domain: https://www.googleapis.com/auth/admin.directory.group.member
- View and manage organization units on your domain: https://www.googleapis.com/auth/admin.directory.orgunit
- View and manage the provisioning of users on your domain: https://www.googleapis.com/auth/admin.directory.user
Download and Install
This addon is located in the Connectors section and its name is SQL Google Apps plugin.
For download and install the addon you could review our generic documentation about this process: Addons installation
Agent Configuration
Basic
Generic parameters
After the installation of the addon, you may create and configure agent instances.
To configure this Google Apps Connector you must select "GoogleApps" in the attribute "Type" of the generic parameters section in the agents page configuration.
For more information about how you may configure the generic parameters of the agent, see the following link: Agents configuration
Custom parameters
Below there are the specific parameters for this agent implementation:
|
Parameter
|
Description
|
|---|---|
| Admin user |
Administrator account name |
|
Service account client email
|
Extract it from generated json file. It is tagged as client_email |
|
Service account private key
|
Extract it from generated json file. It is tagged as private_key. As the private key is JSON encoded, mind to replace unicode escape chars by it's ASCII equivalents |
|
Google domain
|
Base google domain |
Attribute mapping
This connector could manage users and groups.
Properties
Nothing to configure.
Attributes
Users
|
Attribute
|
Value
|
|---|---|
| suspended | "True" if the account is disabled. "False" otherwise |
| name{"givenName"} | User given name |
| name{"familyName"} | User last name |
| name{"fullName"} | User full name |
| primaryEmail | Account name |
To get an extensive list of attributes supported by Google, browse to Google User API
Soffid groups can be mapped as OrgUnits.
|
Attribute
|
Value
|
|---|---|
| name | Org Unit Name |
Groups
Mails alias will be automatically bound to users without any further configuration.
Roles and Mail Lists will also be created and maintained as Google Apps groups.
For more information about how you may configure attribute mapping, see the following link: Soffid Attribute Mapping Reference
Load Triggers
&&TODO&&Pending to be documented.
Account metada
&&TODO&&Pending to be documented.
Operational
Monitoring
After the agent configuration you could check in the monitoring page if the service is running in the Synchronization Server, please go to:
Tasks
AuthotitativeAuthoritative
If you are checked "Authorized identity source", an automatic task to load identities from the managed system to Soffid is available, please go to:
And you will something like "Import authoritative data from <AGENT_NAME>".
Reconcile
If your are configured the "Attribute Mapping" tab with some of our objects: "user, account, role, group or grant", an automatic task to synchronize these objects from the managed system to Soffid is available, please go to:
And you will something like "Reconcile all accounts from <AGENT_NAME>".
Synchronization
About the synchronization of the objects, there are two possible options:
- If you are checked the generic attribute "Read Only" in the "Basics" tab, only the changes in the managed systems will be updated in Soffid. We recommend this options until the global configuration of Soffid will be tested.
- If you are not checked the generic attribute "Read Only" in the "Basics" tab, all the changes in Soffid or the managed system will be updated in the other. Note that this synchronization must be configured in the "Attribute mapping" tab correctly.
For more information about how you may configure the generic parameters of the agent, see the following link: Agents configuration