Creating an extended integration for Quip users (API key)

Sync Quip with Oomnitza to gain visibility of users and SaaS users and transform data into consumable information and actionable insights.

Before you start

To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application. 

Creating integration users 

You must generate an API token in Quip to create credentials and to add the integration.

To generate the API token, see the Generate OAuth token section in Get access to Quip's APIs.

Creating credentials

Make life easier and add your credentials to Oomnitza before you create the integration.  

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. On the INFORMATION tab, use the default name or enter a user intuitive name for the credentials.
2. Select an owner.
3. On the AUTHORIZATION tab, complete the following steps.
   1. Ensure that API Key is selected as authorization type.
   2. Ensure that the token name is Authorization.
   3. Enter the API key.
   4. Ensure that Header is entered in the Add to field.
4. Click CREATE.

Creating the 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. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

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

• User only. Add user records.
• User plus SaaS user. User records and SaaS user records are retrieved. User records are displayed on the People page and SaaS user records can be accessed when you open the SaaS application record on the SaaS page and click the Users tab. In addition to retrieving information about the SaaS application such as usernames, you also retrieve key information such as the user's SaaS role and last activity which will enable you to reduce costs by monitoring SaaS usage and removing users who aren't using the SaaS application. To maintain data hygiene, you can enable the deactivate feature.
• Software SaaS Selection. Link the vendor application to the Oomnitza Software Catalog which is a repository of supported vendor applications and services. If an entry for the vendor application is not shown in the list, it means that the vendor application has not been added to the SaaS page in Oomnitza and linked to the catalog. See SaaS details overview. You can ignore this field because the vendor application is automatically linked to the catalog when the integration is saved.

Important
Now that user information can be retrieved and users deactivated when the integration is run, you can deactivate or remove the workflows that were added to retrieve SaaS user information and deactivate SaaS users. (The block that is used to complete these actions in workflows is the SaaS User Role Retrieval block.)

When you enable the Deactivate feature, the following actions are completed when the integration runs:

• If a user record is missing from the data source - the vendor application - or if the record is marked as inactive in the data source, the user record is deactivated in Oomnitza.
• If a user record was deactivated and is now available in the data source, for example, the user logs into the SaaS application, the user record becomes active in Oomnitza. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAuth authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

1. Click Edit .
2. Make your changes.

Editing the 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

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Select Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Mapping fields

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

The following fields can be mapped to Oomnitza:

• Connect: Credentials
• Connector Sync Time
• Email
• Id
• Name
• Username

Map the Quip User Id to Oomnitza

1. Click the down arrow on the Id field.
2. Select Add new Oomnitza users field.
3. Change the name of the field to Quip User Id.
4. Select the Unique checkbox.
5. Click CREATE. 

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

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

If you selected Local as the installation type when creating the integration, see 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

Test

To test the integration, click the tile in the Saas Management Integration section and click RUN NOW. To check for errors, click Sync Sessions.