Skip to main content
Sign in

Creating an extended integration for SimpleMDM assets

  • November 10, 2024 13:07
  • Updated

The following document will capture the available integration points with SimpleMDM and how to configure them.

Before you start

Please follow the documentation to create an API Key on Simple MDM. You can retrieve your API key by signing into your SimpleMDM account, selecting Account from the sidebar, and then selecting the API tab.

Store your API Key securely as it is required for authentication in Oomnitza.

Adding your credentials to Oomnitza

  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. Add the information details.
  2. Click the AUTHORIZATION tab.
  3. Ensure that API Key is selected as the Authorization type.
  4. Ensure that the Token Name is Authorization. 
  5. Enter the API key.
  6. Ensure that Add to Header is selected.
  7. Click CREATE. 

Documentation Links:

Creating the asset integration

Now that you have added your credentials, you can create the asset integration in Oomnitza by completing the following steps:

  1. In Oomnitza, click Configuration> Integrations> Overview.
  2. Click Block view block_view.PNG
  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:

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 option is selected. Select this option  when you want to edit records and add new records. If you want to edit records and not add new records, select Update Only. If you only want to add new records, select Create Only.

Integration details

To review or update the integrations details, click Edit edit_black_pencil_icon.svg.

  1. Update the integration name if necessary. 
  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

Schedule

By default, 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 the Edit edit_black_pencil_icon.svg.
  2. Configure your schedule.
  3. Click Update.

Mappings

To map the fields to Oomnitza, click Edit edit_black_pencil_icon.svg.

TipBulb_Icon_small.svgYou can define rules for your integration by selecting Edit integration edit_integration.svg 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  add_grey_rectangel_icon.svg on the mapping page. All you need to do is specify the property name. See Creating custom API fields. 

Creating custom mappings

Map Simple MDM fields to Oomnitza fields to get the asset information that you need. For the field mapping, it is recommended to follow these steps:

  1. Click Smart Mapping.
  2. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
    1. Click the down arrow on the field that you want to map.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field.
    4. Click CREATE. 
  3. Map and assign a sync key to a unique field, such as the Serial Number.
  4. Click UPDATE.

Custom mappings

Automatic App Installation Enabled
Automatic Check Enabled
Automatic OS Installation Enabled
Automatic Security Updates Enabled
Available Device Capacity
Background Download Enabled
Battery Level
Bluetooth MAC
Build Version
Carrier Settings Version
Cellular Technology
Connect: Credentials
Current Carrier Network
Current MCC
Current MNC
Data Roaming Enabled
Default Catalog
Device Capacity
Device Group ID
Device Name
Filevault Enabled
Filevault Recovery Key
Firewall Block All Incoming
Firewall Enabled
Firewall Stealth Mode
Firmware Password
Firmware Password Enabled
Hardware Encryption Caps
ICCID
ID
IMEI
Is Activation Lock Enabled
Is Cloud Backup Enabled
Is DEP Enrollment
Is Device Locator Service Enabled
Is Do Not Disturb in Effect
Is Roaming
Is Supervised
Is User Approved Enrollment
Last Cloud Backup Date
Last Seen At
Location Accuracy
Location Latitude
Location Longitude
Location Updated At
MEID
Model
Model Name
Modem Firmware Version
Name
Operating System Version
Passcode Compliant
Passcode Compliant with Profiles
Passcode Present
Perform Periodic Check
Personal Hotspot Enabled
Phone Number
Previous Scan Date
Previous Scan Result
Product Name
SIM MNC
Serial Number
Sim Carrier Network
Status
Subscriber Carrier Network
Subscriber MCC
Subscriber MNC
System Integrity Protection Enabled
Type
Unique Identifier
Voice Roaming Enabled
Wifi MAC
iTunes Store Account is Active

Launching the integration

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

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

small_blue_link.svg 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

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 more information.

Related articles

Comments

0 comments

Please sign in to leave a comment.