Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Mobile / Get

Operation Information

Retrieve Mobile Device Information from jamf.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Jamf.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Jamf in the Type pick list;
  • Give the Jamf KeySafe key a Title (this is the name / identifier for the Jamf account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Jamf username
Jamf Server string The server name for your jamf instance this can be found in your url before '.jamfcloud.com'
Password string Your Jamf Password

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Jamf account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Mobile ID mobileId string The Unique ID of the Mobile Device No None provided
Mobile Name mobileSearch string The Name of the Device you would like to search for No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any error message returned by jamf
Status Code status string The status of the operation, ok/failed
Mobile ID id integer The unique identifier number for the mobile device
Mobile Name name string The Name of the Mobile Device
Mobile Display Name displayName string The Display Name of the Mobile Device
Mobile Device Name deviceName string The Device Name of the Mobile Phone
Mac Address macAddress string A 12-digit hexadecimal number assigned to each device connected to the network.
Phone Number phoneNumber string The Device Phone Number
Computer Serial Number serialNumber string The Serial Number of the Computer
Computer UDID udid string The UDID of the Computer
Building model string The Building the Device is in
Mobile Model Identifier modelIdentifier string Mobile Model Identifier Details
Mobile Model Number modelNumber string Mobile Model Number
Device Ownership deviceOwnership string Device Ownership Information
Username username string The Username of the Device user
Real Name realName string The Name of the Device user
Email Address emailAddress string The Email of the Device user
Position position string The Position of the Device user
Phone phone string The Phone of the Device user
Phone Number locationPhoneNumber string The Phone Number of the Device user
Department department string The Department the Device is in
Building building string The Building the Device is in
Room room string The Room the Device is in
Purchased purchased string Has the Device been purchased
Purchased leased string Has the Device been leased
PO Number poNumber string The Purchase Order Number the Device is associated with
Vendor vendor string The Vendor of the Device
Apple Care Id applecareId string The Apple Care Id for the device
Purchase Price purchasePrice string The Price the Device was Purchased at
Purchasing Account purchasingAccount string The Account the Device was Purchased by
Warranty Expires warrantyExpires string The Warranty Experation Date
Lease Expires On leaseExperation string The Device Lease Expiration Date
Life Expectancy lifeExpectancy string The Device Life expectancy
In This Document