Create an extended integration for Jamf Pro assets and software (API V4)

Sync Oomnitza with Jamf to gain visibility of asset and software data.

Contents

1. Before you start
2. Required connection information
3. Required credential information
4. Adding credentials
5. Creating the integration
6. Mappable fields
7. Running the integration

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 

Required connection information

Review Return paginated Computer Inventory records.  

Jamf Pro Instance URL. The URL has the following format: https://<instance-name>.jamfcloud.com. 

Do not include a trailing slash.

Adding global variables

Save time when you create integrations and run workflows by adding connection information as global variables.

1. Click Configuration > General > Global Settings.
2. Click Add new variable.
3. Add the key value, which is the name of the variable.
4. Enter the value.
5. Save your changes.

The name of the variable is Jamf.Domain. You enter your Jamf Pro instance URL as the value. 

Required credential information

Type of authentication: OAuth 2.0.

To create the Oauth flow to retrieve the client ID and secret, see API Roles and Clients.

You will require the following information:

• Jamf instance URL
• Client ID and secret

Adding 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 arrow > to select the integration.
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

Creating the integration

1. In Oomnitza, click Configuration> Integrations> Overview.
2. Click Block view .
3. Scroll down to the Extended section for asset integrations.
4. Click NEW INTEGRATION.
5. Select 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:

Software data

Depending on the asset integration, an option might be available to ingest desktop software information such as the name and version of the software installed on an asset. To view the software information in Oomnitza, you must have the software module. 

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.

Integration details

To review or update the integrations details, click Edit .

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. Update the integration name.
2. Select an installation type.
3. For integration preferences, select an option.
4. 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

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.  

Click SMART MAPPING.

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

Mappable fields

Active Directory Status
Alt. MAC Address
Applecare ID
Asset Tag
Available RAM Slots
Barcode #1
Barcode #2
Battery Capacity
Boot ROM
Building ID
Bus Speed
Cache Size (KB)
Computer Name
Connector Sync Time
Department ID
Disk Encryption Configuration
Distribution Point
Email Address
Enrollment Method
Gatekeeper Status
ID
Initial Entry Date
IPv4 Address
Is BLE Capable
Is Declarative Device Management Enabled
Is Enrolled Via Automated Device Enrollment
Is Institutional Recovery Key Present
Is iTunes Store Account Active
Is Leased
Is MDM Capable
Is Purchased
Is remote managed
Is Supervised
Is User Approved MDM
Jamf Version
Keyboard Country
Last Check In
Last Cloud Backup Date
Last Contact Time
Last Enrolled Date
Last known IPv4 Address
Lease Expires
Life Expectancy
MAC Address
Make
MDM Profile Expiration
Model
Model Identifier
Network Adapter Type
NIC Speed
Number of Cores
Number of Processors
Optical Drive
OS Build
OS Name
OS Version
Phone Number
Platform
PO Date
PO Number
Position
Processor Architecture
Processor Speed Mhz
Processor Type
Purchase Price
Purchasing Account
Purchasing Contact
Real Name
Report Date
Room
Serial Number
SIP Status
Site
SMC Version
Total Memory (MB)
UDID
Username
Vendor
Warranty Expires
Xprotect Version 

Drag and drop

You can map additional fields to Oomnitza.

1. Drag and drop the fields onto the Add new Oomnitza field area in the Oomnitza column.
2. Rename the field.
3. Make your changes.
4. Save your changes.

Selecting sync keys

You must select at least one field as the sync key field. To ensure that the sync runs successfully, the field must contain unique values such as the serial number of an asset record or the email address of a user record. Records that do not contain a value for the sync key are skipped.   

See Configuring multiple sync keys.

Running the integration

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