Creating an extended integration for Workspace users

Let Oomnitza be your single source of truth!

You'll get visibility of your Google Workspace users as data from Google Workspace is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Google Workspace in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management

Navigation

Creating the user integration

Creating custom mappings

Before you start

The Google Workspace user load retrieves all users in a domain.

Google Workspace REST API uses OAuth2 based authentication. Instructions on how to setup an OAuth2 App and add your credentials to the Oomnitza vault can be found here: Adding Google (OAuth 2.0) credentials.

When creating these credentials, the following scope is required:

https://www.googleapis.com/auth/admin.directory.user.readonly

For more information see Google API Documentation: users.list

Creating the user integration

1. In Oomnitza, click Configuration>Integrations>Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. Search for the integration in the sidebar.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

➢ User selection

Select User only to add user records to the User object. 

Select User plus SaaS user to add user records to the User object and the SaaS object. 

The benefit of adding SaaS user records is that you can run a SaaS user workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that you can retrieve about SaaS users depends on the availability of SaaS user workflows for the integration. 

If you have already added records to the SaaS object from a previous integration, you are prompted to select it from the Software SaaS Selection list. 

➢ Installation type

Select Cloud if you want to store credentials in the Oomnitza cloud.

Select Local if you want to store credentials locally. Local extended integrations do not support AWS and OAuth authentication. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select Cloud.

➢ Integration preferences

By default, the option Create & Update is selected, which allows for editing existing user records and adding new ones. If your goal is only to edit existing user records, choose Update Only. On the other hand, if you only want to add new records, select Create Only.

Integration details

Procedure
To review or update the integrations details, click Edit :

1. Update the integration name if necessary. 
2. From the User Selection list, select an option. 
3. Select an installation type.
4. For integration preferences, select an option.
5. Enter the name of the integration user.

Credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click Edit :.

Creating custom mappings

Map the Google Workspace user fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. Create custom mappings to map any other field that you want to add to Oomnitza:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Ensure that the Email is mapped to the
   1. Username field on the Oomnitza side (required for integration).
   2. Email field on the Oomnitza side (required for integration).
4. Select the Role field on the Oomnitza mapping side.
5. Choose a suitable role from the list (a defined role is necessary for the integration)
6. Assign a sync key to a unique field, such as the Email.
7. Click UPDATE.

Standard Google Workspace to Oomnitza mappings

Agreed to Terms
Archived
Change Password at Next Login
Creation Time
Customer ID
Enforced in 2-Step Verification
Enrolled in 2-Step Verification
Etag
Family Name
Full Name
Given Name
ID
IP whitelisted
Include in Global Address List
Is Admin
Is Delegated Admin
Is Mailbox Setup
Kin
Last Login Time
Org Unit Path
Primary Email
Suspended

Did you know? 
You can define rules for your integration by selecting Edit integration on the mapping page. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  
You can add new fields to your integration by selecting Add new field   on the mapping page. All you need to do is specify the property name. See Creating custom API fields. 

Launching the integration

Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, select Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, refer to Running an extended integration

If you selected Local as the installation type when creating the integration, refer to Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started

For further information see:
Creating workflows for Google Workspace users