Creating an extended integration for Verkada users

Create an extended integration to sync Verkada user data with Oomnitza.

To get and sync user data with Oomnitza, the Get All Access Users API is used. See Verkada API Documentation: Get All Access Users.

Before you start

• Add your credentials to Oomnitza.
• Verkada URL. The default URL for US regions is https://api.verkada.com. For other regions, the format of the URL is https://api.<region>.verkada.com. For example, for European countries it's  https://api.eu.verkada.com.
• See Service Regions.

Add the value as a global variable so that when you create workflows that use presets the variable is automatically added. See Adding global settings.

The name of the global variable is Verkada.URL.  See the definition for Verkada URL above to find out the value that you must enter.

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 

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. 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. Add user and SaaS user records. 

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

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. 

Creating custom mappings

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

Complete these actions:

1. Map the Verkada email field to the Oomnitza email and username fields.
   1. Click the down arrow on the Verkada email field.
   2. Select the Email field.
   3. Select the Username field.
2. Choose a sync key such as Username. 
3. Select the Role field on the Oomnitza mapping side.
4. Choose a suitable role from the list (a defined role is necessary for the integration)
5. To map more fields, complete these actions:
   1. Click the down arrow on the field, and select Add new Oomnitza users field.
   2. Modify the name of the field. For example, you might want to add Verkada to the field name.
   3. Click CREATE.   

Custom Verkada to Oomnitza mappings

The following Verkada fields can be mapped to Oomnitza:

• Email
• Employee ID
• Full Name
• User ID

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