on - edited on by
Vedanth_BK
Disclaimer
The integration was either created by Saviynt or by Saviynt community users and verified by Saviynt. The integration is available “as is” and fall under standard connectors support for REST, SCIM, SOAP, JDBC, LDAP, PowerShell, Jar and Saviynt Connector Framework.
Preface
This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and GoogleApps.
Audience
This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with GoogleApps.
Introduction
Google Analytics is a web analytics service that provides statistics and basic analytical tools for search engine optimization (SEO) and marketing purposes. The service is part of the Google Marketing Platform and can help organizations determine top sources of user traffic, gauge the success of their marketing activities and campaigns, track goal completions (such as purchases, adding products to carts), discover patterns and trends in user engagement and obtain other visitor information such as demographics.
The Google Analytics connector enables you to seamlessly integrate with Google Analytics to manage user lifecycle and govern access to their accounts, Properties and Sub-properties.
For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors.
Note: This guide provides information about using the GoogleApps REST connector using REST API for performing operations listed in the Supported Features.
Supported Features
The GoogleApps integration supports the following features:
Supported Software Versions
Software | Version |
EIC | Release v4.5 and later |
Understanding the Integration between EIC and GoogleApps
You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration:
The Complete Service Management platform GoogleApps combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity.
Objects are imported as entitlement types into EIC.
Security System represents the connection between EIC and the target application.
It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository.
It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System.
Endpoint is an instance of an application within the context of a security system.
It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements.
It is mandatory to create an endpoint after creating the security system.
You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System.
Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the REST APIs. For more information about creating a connection, see Creating a Connection.
Job Scheduler is a software component that executes a job based on the configured schedule to perform import or provisioning operations from EIC.
When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the configured connector. If you want to instantly provision requests for completing the tasks without running the provisioning job, you must enable Instant Provisioning at the security system level and the Instant Provisioning Tasks global configuration. For more information about the jobs used by the connectors in the GoogleApps integration.
Integration Architecture
EIC uses a REST connection for integrating with GoogleApps for importing data and for performing provisioning and deprovisioning tasks.
The following diagram illustrates the integration architecture and communication with the target application
Setting Up the Integration
API Overview
Google APIs use the OAuth 2.0 protocol for authentication and authorization. Google supports common OAuth 2.0 scenarios such as those for web server, client-side, installed, and limited-input device applications.
To begin, obtain OAuth 2.0 client credentials from the Google API Console. Then the client application(SSM) requests an access token from the Google Authorization Server, extracts a token from the response, and sends the token to the Google API that you want to access
Prerequisites
Create an API Key
Login to Google Cloud console to create API Keys
Click on Create Credentials and select Create Service Account:
Provide the service account name, Service account ID and description and Click Create and Continue
Grant the necessary user access and project access to the service account.
Open the newly created service account and select Keys tab. Click on ADD KEY and create a JSON key
Create the Key and download the same. Following will be the format of the newly created key JSON file:
The details from this key file will be used to establish the JWT based REST connection to Google.
An initial JWT token could be generated through the following sample java script:
// load .env file
require('dotenv').config();
const fs = require('fs');
const jwt = require('jsonwebtoken');
const saKeyJson = require(process.env.SA_KEY_JSON);
const jwtPrivateKey = saKeyJson.private_key;
const saEmail = saKeyJson.client_email;
const tokenUri = saKeyJson.token_uri;
const scopes = process.env.SCOPES;
const jwtPayload = {
iss: saEmail,
scope: scopes,
aud: tokenUri,
sub:"sa-p-nl-mgmtgovernance@xxxxxx.iam.gserviceaccount.com",
exp: Math.floor(Date.now() / 1000) + 3600,
};
const jwtHeader = {
algorithm: 'RS256', // alg
};
const token = jwt.sign(
jwtPayload,
jwtPrivateKey,
jwtHeader,
);
console.log(token);
The .env file consists of the following properties:
SA_KEY_JSON="<full path of the service account key json file>"
Note: Refer to the Google Analytics APIs
REST Resource: properties.userLinks | Google Analytics Admin API | Google for Developers and
REST Resource: accounts.userLinks | Google Analytics Admin API | Google for Developers to understand the required scopes
The above steps completes the configuration of a service account for Google APIs in general.
The service account created from the above steps should have the following permissions in Google Analytics to manage the user accounts and access to properties and sub-properties:
The Service account should also be provided with Administrator rights for all the Properties and Sub-properties that are to be managed
Creating a Connection
Connection refers to the configuration setup for connecting EIC to target applications. For more information about the procedure to create a connection, see Creating a Connection.
Understanding the Configuration Parameters
While creating a connection, you must specify connection parameters that the connector uses to connect with the target application, define the type of operations to perform, the target application objects against which those operations are performed, and the frequency of performing them. In addition, you can view and edit attribute mappings between EIC and the target application, predefined correlation rules, and provisioning jobs and import jobs.
Configuration Parameters for Account and Access Import
The connector uses the following parameters for creating a connection and for importing account and access from the target application:
Connection Parameters
Parameter | Description | Example Configuration | Mandatory? |
|
|
Connection Name | Specify the name to identify the connection. | - | Yes |
|
|
Connection Description | Specify the description for the connection. | - | No |
|
|
Connection Type |
| - | Yes |
|
|
Default SAV Role | Specify this parameter to assign the SAV role for the connection. The SAV role is a role in EIC that assigns specific access to users. This parameter is valid only for importing users. Sample value: User assigned with the ROLE_ADMIN role, has access to all the sections of EIC. | - | No |
|
|
Email Template | Specify this parameter to select an email template for sending notifications. Email templates provide immediate trigger of emails to a user based on actions performed. Email informs user about the action performed and if critical, needs immediate action from the user. | - | No |
|
|
ConnectionJSON | Specify this parameter to create a connection.
Note: Update TOKEN as per your GoogleApps details. | Use the following format to connect to the GoogleApps application: |
|
| Yes |
Import Parameters
Parameter | Description
| Recommended Configuration | Mandatory? |
AccountEntImport JSON | Specify this parameter to reconcile the accounts and entitlements | Use the following format to import accounts and entitlements using the GoogleApps application: |
Yes |
Configuration Parameter for Provisioning
Parameter | Description
| Recommended Configuration | Support for Binding Variables? | Support for Java Ternary Operations? |
CreateAccountJSON | Specify this parameter to create an account in the target application.
| Use the following format to create accounts using the GoogleApps application: | The bindings supported are:
| Yes |
AddAccessJSON | Specify this parameter to add access to an account.
| Use the following format to add access using the GoogleApps application: | The bindings supported are:
| Yes |
RemoveAccessJSON | Specify this parameter to remove access from an account. | Use the following format to remove access using the Talend application: | The bindings supported are:
| Yes |
RemoveAccountJSON | Specify this parameter to remove an account.
| Use the following format to remove an account using the GoogleApps application: | The bindings supported are:
| Yes |
Importing Connection Package
connection package helps you build the connection with pre-defined JSONs, this can be used if your tenant does not already have out of the box connection templates available. Here are the steps to import the GoogleApps connection package.
Download the connection package.
Navigate to Admin → Transport → select Import Package.
Browse the downloaded package and Import.
Navigate to Admin → Connections → Select “GoogleApps” Connection.
Edit the connection with your GoogleApps tenant details.
Creating a Security System
The security system represents the connection between EIC and the target application. For more information on creating a security system, see Creating a Security System.
Creating an Endpoint for the Security System
Endpoint refers to the target application used to provision accounts and entitlements (access). For more information on creating an endpoint, see Creating Endpoints.
Using the GoogleApps Integration
You can use the GoogleApps integration for performing import and provisioning operations after configuring it to meet your requirements.
Guidelines for Using the Integration
You must apply the following guidelines for configuring import:
Run account import before running the access import.
Map all GoogleApps attributes to EIC account attributes using ImportAccountEntJSON.
You must apply the following guidelines for configuring provisioning:
Use Java ternary operators if you want to add conditions in the provisioning parameters. You can use Java operations to tweak any attributes by using if-else conditions, substrings, or operators in the JSON for provisioning.
Configuring Import Operations
Full account import: When configuring the connection for the first time, first perform full import to import all existing accounts from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted accounts are also identified and marked as suspended from import service.
Full Access import: When configuring the connection for the first time, first perform full import to import all existing access from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted entitlements are also identified and marked as inactive.
The import jobs are automatically created in EIC after you create a connection for the GoogleApps integration. For more information about creating jobs, see Data Jobs.
Importing Accounts and Accesses
You must import accounts after the users are available in EIC.
To import accounts:
Specify the connection and import parameters. For more information, see Account and Access import.
Note: Ensure that the connection type is selected as REST.Configure the Application Data Import (Single Threaded) job to import accounts and access. For more information, see Data Jobs.
Configuring Provisioning and Deprovisioning
Provisioning is automatically enabled when a connection is configured. For detailed information about performing provisioning tasks, see Access Request System.
To provision objects to the target application:
Specify the connection and provisioning parameters. For more information, see Configuration Parameters for Provisioning.
Note: Ensure that the connection type is selected as REST.Configure the Provisioning job (WSRETRY). For more information, see Provisioning Jobs.
When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the connector.
Troubleshooting
To troubleshoot common problems with connectors, answer frequently asked questions, and provide solutions to a few common issues you might encounter while configuring or working with connectors, see Common Troubleshooting Guide for Connectors.
To troubleshoot common problems or obtain answers for frequently asked questions for REST connectors, see the REST Connector Guide.
Note: Ensure that you record the token expiry duration during the initial token generation. The connection may fail, if the token is not refreshed.
