Jamf
API integration

list_all_jamf_accounts

List all account users or admin users in Jamf. Returns an array of account objects containing id and name fields for each account.

get_single_jamf_account_by_id

Get details of a specific account user or admin user in Jamf by id. Returns id, name, email, enabled status, access_level, privilege_set, site, and privileges related to JSS objects, settings, actions, and tools.

delete_a_jamf_account_by_id

Delete a specific account user or admin user in Jamf using its id. Returns a 200 OK response when the account is successfully deleted.

update_a_jamf_account_by_id

Update an existing account user or admin user in Jamf using the specified id. Returns updated fields including name, email_address, access_level, privilege_set, and enabled status.

create_a_jamf_account

Create a new account in Jamf using id. Requires id. Returns details such as name, email, full_name, access_level, and privilege_set in the response.

list_all_jamf_users

List all users in Jamf. Returns an array where each item includes size and user details such as id and name.

get_single_jamf_user_by_id

Get a specific user in Jamf by id. Returns fields such as id, name, full_name, email, phone_number, position, ldap_server, extension_attributes, sites, and links with related assets.

delete_a_jamf_user_by_id

Delete a user in Jamf by id. Requires id. Returns a confirmation of successful deletion.

update_a_jamf_user_by_id

Update an existing user in Jamf using id. This operation cannot be used to add computers, mobile devices, peripherals, or VPP assignments. Returns updated user details such as name, full_name, email, and phone_number.

create_a_jamf_user

Create a new user in Jamf by id. Requires id. The response includes created user details such as name, full_name, email, phone_number, and position. Cannot be used to add computers, mobile devices, peripherals, or VPP assignments.

list_all_jamf_mobile_devices

List all mobile-devices in Jamf. Returns id, name, serialNumber, wifiMacAddress, udid, phoneNumber, model, modelIdentifier, username, type, managementId, and softwareUpdateDeviceId for each device.

get_single_jamf_mobile_device_by_id

Get details for a specific mobile device in Jamf by id. Returns key fields including display_name, device_name, serial_number, model, and os_version.

create_a_jamf_mobile_device

Create a new mobile device in Jamf using id. Returns fields such as model_identifier for device type and os_name derived from API level for Android devices. id is required.

update_a_jamf_mobile_device_by_id

Update an existing mobile device in Jamf using id. Returns updated device details including general information, location, purchasing data, and extension attributes. The os_name field in android is derived from the API level and cannot be set.

delete_a_jamf_mobile_device_by_id

Delete a mobile device in Jamf by id. Requires id. Returns a success message on successful deletion.

list_all_jamf_search_mobile_devices

Search mobile devices in Jamf that match the provided match parameter. Requires match. Returns fields such as id, name, serial_number, os_version, model, managed, and location details in the response.

list_all_jamf_mobile_device_applications

List all mobile device applications in Jamf. Returns each application's id, name, display_name, bundle_id, version, and internal_app fields.

get_single_jamf_mobile_device_application_by_id

Get details of a specific mobile-device-application in Jamf using id. Returns key fields such as name, bundle_id, version, category, icon, and deployment_type for the application.

delete_a_jamf_mobile_device_application_by_id

Delete a mobile device application in Jamf by id. Requires id. Returns a confirmation upon successful deletion.

update_a_jamf_mobile_device_application_by_id

Update an existing mobile device application in Jamf using id. Requires id. Returns updated fields including general details, scope, self_service configuration, VPP settings, and app_configuration preferences (must use character entities).

create_a_jamf_mobile_device_application

Create a new mobile device application in Jamf using id. Returns details such as name, bundle_id, display_name, version, and configuration preferences. App configuration preferences must be listed using character entities.

list_all_jamf_computer_inventory

List paginated Computer Inventory records in Jamf. Returns key fields such as id, udid, general.name, general.platform, and hardware.model for each device.

create_a_jamf_computer_inventory

Create a new Computer Inventory record in Jamf. Returns id and href of the created record in the response.

update_a_jamf_computer_inventory_by_id

Update specific fields on a computer in Jamf using id. Returns the updated computer object including fields such as general, purchasing, userAndLocation, hardware, and operatingSystem details.

delete_a_jamf_computer_inventory_by_id

Delete a specific computer record in Jamf using id. Returns a 204 status when the computer is successfully removed or a 404 error if the computer id does not exist.

list_all_jamf_computer_inventory_v_4

List paginated Computer Inventory records in Jamf using the v4 endpoint (Jamf Pro 11.30.0 or later). Use section to choose which parts of each computer are returned, filter to narrow the results and sort to order them. Returns the id and udid of each computer plus the requested sections: general, hardware, operatingSystem, diskEncryption, security, userAndLocation, purchasing and applications. Needs the Read Computers privilege.

get_single_jamf_computer_inventory_v_4_by_id

Get one computer in Jamf by id using the v4 endpoint (Jamf Pro 11.30.0 or later). Use section to choose which parts of the computer are returned; only the GENERAL section is returned by default. Returns the id and udid plus the requested sections: general, hardware, operatingSystem, diskEncryption, security, userAndLocation, purchasing and applications. Returns a 404 error when the computer does not exist. Needs the Read Computers privilege.

create_a_jamf_computer_inventory_v_4

Create a computer record in Jamf using the v4 endpoint (Jamf Pro 11.30.0 or later). general.name is required; every other field is optional. Returns the id and href of the created computer. Needs the Create Computers privilege.

update_a_jamf_computer_inventory_v_4_by_id

Update a computer in Jamf by id using the v4 endpoint (Jamf Pro 11.30.0 or later). Send only the fields to change. Returns no content when the computer is updated and a 404 error when it does not exist. Needs the Update Computers privilege.

delete_a_jamf_computer_inventory_v_4_by_id

Remove a computer record from Jamf by id using the v4 endpoint (Jamf Pro 11.30.0 or later). Returns no content when the computer is removed and a 404 error when it does not exist. Needs the Delete Computers privilege.

list_all_jamf_mobile_device_inventory_v_2

List paginated mobile device inventory records in Jamf (iPhone, iPad, Apple TV, Apple Watch and Apple Vision devices) using the v2 detail endpoint. Use section to choose which parts of each device are returned, filter to narrow the results and sort to order them. Returns the mobileDeviceId and deviceType of each device plus the requested sections: general, hardware, userAndLocation, purchasing, security and applications. A device with unreadable data is returned with empty sections instead of failing the page. Needs the Read Mobile Devices privilege.

get_single_jamf_mobile_device_inventory_v_2_by_id

Get one mobile device in Jamf by its mobile device id, in the same shape as the mobile device inventory list. Use section to choose which parts of the device are returned; only the GENERAL section is returned by default. Returns the mobileDeviceId and deviceType plus the requested sections: general, hardware, userAndLocation, purchasing, security and applications. Returns a 404 error when the device does not exist. Needs the Read Mobile Devices privilege.

update_a_jamf_mobile_device_inventory_v_2_by_id

Update a mobile device in Jamf by its mobile device id using the v2 endpoint. Send only the fields to change. Returns id, name, assetTag, serialNumber, osVersion and managed for the updated device, a 403 error when the account may not modify the device and a 404 error when it does not exist. Needs the Update Mobile Devices privilege.

list_all_jamf_end_users

List paginated end users in Jamf (the users that devices are assigned to) using the v1 users endpoint (Jamf Pro 11.26.0 or later). Use filter to narrow the results and sort to order them. Returns id, username, realname, email, phone, position, enableCustomPhotoUrl, customPhotoUrl and managedAppleId for each user. Needs the Read User privilege.

get_single_jamf_end_user_by_id

Get one end user in Jamf by id using the v1 users endpoint. Returns id, username, realname, email, phone, position, enableCustomPhotoUrl, customPhotoUrl and managedAppleId. Returns a 404 error when the user does not exist. Needs the Read User privilege.

create_a_jamf_end_user

Create an end user in Jamf using the v1 users endpoint. Returns the id and href of the created user. Needs the Create User privilege.

update_a_jamf_end_user_by_id

Update an end user in Jamf by id using the v1 users endpoint. Jamf does not say whether this replaces the whole user or only the fields sent, so send every field you want to keep. Returns no content when the user is updated and a 404 error when the user does not exist. Needs the Update User privilege.

delete_a_jamf_end_user_by_id

Delete an end user in Jamf by id using the v1 users endpoint. Returns no content when the user is deleted and a 404 error when the user does not exist. Needs the Delete User privilege.

list_all_jamf_sites

List all sites in Jamf (the way a Jamf Pro instance is divided into groups of devices and users). Returns the id, divisionId and name of each site. The result is not paginated. Needs the Read Sites privilege.