Jamf Pro connector thinklet
This page outlines different actions to use when configuring thinklets with Jamf Pro.
The Jamf Pro connector enables seamless integration with Jamf Pro, allowing administrators to execute device management operations within their workflows. The connector interacts with Jamf Pro’s API, providing various actions for retrieving inventory data, renewing profiles, posting commands, and more.
Action: Post MDM SETTINGS command
This action sends an MDM (Mobile Device Management) SETTINGS command to a managed device.
The SETTINGS command is used to update or refresh the configuration settings on a device, ensuring it complies with organizational policies. Refer to the MDM endpoint documentation for more details.
Parameters:
Computer Management ID (
​ComputerManagementId) – The unique identifier assigned by Jamf Pro to manage the target computer.​
Outputs:
Command ID (​
CommandId) – An internal identifier for the command, useful for tracking and verifying command execution results.
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v2/mdm/commands
Method
POST
Payload
{
"clientData": [
{
"managementId": "{{ComputerManagementId}}"
}
],
"commandData": {
"commandType": "SETTINGS"
}
}
Outputs
CommandId: $[0].id
Action: Get computer inventory general data
Retrieves general inventory details of a computer, including MDM status, supervision status, and MDM profile expiration. Refer to the Return General section of a Computer for more details.
Parameters:
Computer ID (
ComputerId) – The Jamf Pro computer ID.
Outputs:
Computer Management ID (
ComputerManagementId)UDID (
UDID) - Apple device UDID (Unique Device Identifier)Name (
Name) – Computer name.MDM Capable? (
MDMCapable) – Indicates if the device supports MDM.Supervised? (
Supervised) – Indicates if the device is supervised.Report Date (
ReportDate) – Date of the last inventory report.MDM Profile Expiration (
mdmProfileExpiration) – Expiration date of the MDM profile.
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v1/computers-inventory/{{ComputerId}}?section=GENERAL
Method
GET
Outputs
ComputerManagementId: $.general.managementId
UDID:$.udid
Name: $.general.name
MDMCapable: $.general.mdmCapable.capable
Supervised: $.general.supervised
ReportDate: $.general.reportDate
mdmProfileExpiration:$.general.mdmProfileExpiration
Action: Get computer inventory purchasing data
Retrieves purchasing-related inventory data for a computer, including purchase order date, warranty expiration, and expected lifespan. Refer to the Return General section of a Computer for more details.
Parameters:
Computer ID (
ComputerId) – The Jamf Pro computer ID.
Outputs:
Purchase Order Date (
PODate) – Date of purchase.Warranty Date (
WarrantyDate) – Warranty expiration date.Life Expectancy (
LifeExpectancy) – Expected operational lifespan.
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v1/computers-inventory/{{ComputerId}}?section=PURCHASING
Method
GET
Outputs
PODate: $.purchasing.poDate
WarrantyDate:$.purchasing.warrantyDate
LifeExpectancy:$.purchasing.lifeExpectancy
Action: Renew MDM profile
Requests the renewal of an MDM profile for a computer, ensuring the device remains compliant with Jamf Pro management policies. Refer to the Renew MDM profile for more details.
Parameters:
UDID (
UDID) – Apple device UDID (Unique Device Identifier).
Outputs:
Not Processed ID (
NotProcessedId) – Indicates if the renewal request was not processed.
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v1/mdm/renew-profile
Method
POST
Payload
{
"udids": ["{{UDID}}"]
}
Outputs
NotProcessedId: $.udidsNotProcessed.udids[0]
Action: Get computer inventory general data by name
Retrieves general inventory data using the computer name instead of the ID. Refer to the Return General section of a Computer for more details.
Parameters:
Computer Name (
ComputerName) – The Jamf Pro computer name.
Outputs:
Computer Management ID (
ComputerManagementId)Computer ID (
ComputerId)UDID (
UDID) - Apple device UDID (Unique Device Identifier)
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v1/computers-inventory?section=GENERAL&page=0&page-size=100&sort=general.name%3Aasc&filter=general.name=={{ComputerName}}
Method
GET
Outputs
ComputerManagementId: $.results[0].general.managementId
ComputerId: $.results[0].id
UDID: $.results[0].udid
Action: Get MDM command information
Retrieves the status and type of a previously executed MDM command. Refer to the Get information about MDM commands made by Jamf Pro for more details.
Parameters:
Command ID (
CommandId) – ID of the executed command.
Outputs:
Command Type (
CommandType)Command State (
CommandState)
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v2/mdm/commands?page=0&page-size=100&sort=dateSent%3Aasc&filter=uuid=={{CommandId}}
Method
GET
Outputs
CommandType: $.results[0].commandType
CommandState: $.results[0].commandState
Action: Post MDM DEVICE_LOCK command
Locks a device via MDM and displays a custom message and contact information. Refer to the Post a command for creation and queuing for more details.
Parameters:
Computer Management ID (
ComputerManagementId)PIN (
PIN) – Lock screen PIN.Message (
Message) – Custom message displayed on the locked screen.Phone Number (
PhoneNumber) – Contact number displayed for unlocking assistance.
Outputs:
Command ID (
CommandId)
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v2/mdm/commands
Method
POST
Payload
{
"clientData": [{"managementId": "{{ComputerManagementId}}"}],
"commandData": {"commandType": "DEVICE_LOCK","pin": "{{PIN}}","message": "{{Message}}", "phoneNumber": "{{PhoneNumber}}"}
}
Outputs
CommandId: $[0].id
Action: Post MDM DECLARATIVE_MANAGEMENT command
Sends a declarative management command to a managed device. Refer to the Post a command for creation and queuing for more details.
Parameters:
Computer Management ID (
ComputerManagementId)
Outputs:
Command ID (
CommandId)
The table below shows the API Service connector details needed when recreating the connector:
Resource Path
api/v2/mdm/commands
Method
POST
Payload
{
"clientData": [{"managementId": "{{ComputerManagementId}}"}],
"commandData": {"commandType": "DECLARATIVE_MANAGEMENT"}
}
Outputs
CommandId: $[0].id
Refer to the Configuring connector thinklets documentation for more information about connector thinklets.
Last updated
Was this helpful?