jamf

SDK Installation

NPM

npm add jamf-classic-sdk-nodejs

Yarn

yarn add jamf-classic-sdk-nodejs

SDK Example Usage

Example

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
    const sdk = new Jamf({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
            username: "<YOUR_USERNAME_HERE>",
        },
    });

    const res = await sdk.accounts.createAccountById({
        id: 437973,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Available Resources and Operations

accounts

• createAccountById - Creates a new account by ID
• createGroupById - Creates a new group by ID
• deleteAccountById - Deletes an account by ID
• deleteAccountByName - Deletes an account by name
• deleteGroupById - Deletes a group by ID
• deleteGroupByName - Deletes a group by name
• findAccounts - Finds all accounts
• findAccountsById - Finds accounts by ID
• findAccountsByName - Finds accounts by name
• findGroupsById - Finds groups by ID
• findGroupsByName - Finds groups by name
• updateAccountById - Updates an existing account by ID
• updateAccountByName - Updates an existing account by name
• updateGroupById - Updates an existing group by ID
• updateGroupByName - Updates an existing group by name

activationcode

• findactivationcode - Finds the Jamf Pro activation code
• updateActivationCode - Updates the Jamf Pro activation code

advancedcomputersearches

• createAdvancedComputerSearchgById - Creates a new advanced computer search
• deleteAdvancedComputerSearchById - Deletes a computer search by ID
• deleteAdvancedComputerSearchByName - Deletes a computer search by name
• findAdvancedComputerSearches - Finds all advanced computer searches
• findAdvancedComputerSearchesById - Finds computer searches by ID
• findAdvancedComputerSearchesByName - Finds advanced computer searches by name
• updateAdvancedComputerSearchById - Updates an existing advanced computer search by ID
• updateAdvancedComputerSearchByName - Updates an existing advanced computer search by name

advancedmobiledevicesearches

• createAdvancedMobileDeviceSearchById - Creates a new advanced mobile device search
• deleteAdvancedMobileDeviceSearchById - Deletes a mobile device search by ID
• deleteAdvancedMobileDeviceSearchByName - Deletes a mobile device search by name
• findAdvancedMobileDeviceSearches - Finds all advanced mobile device searches
• findAdvancedMobileDeviceSearchesById - Finds mobile device searches by ID
• findMobileDeviceSearchesByName - Finds advanced mobile device searches by name
• updateAdvancedMobileDeviceSearchById - Updates an existing advanced mobile device search by ID
• updateAdvancedMobileDeviceSearchByName - Updates an existing advanced mobile device search by name

advancedusersearches

• createAdvancedUserSearchgById - Creates a new advanced user search by ID
• deleteAdvancedUserSearchById - Deletes a user search by ID
• deleteAdvancedUserSearchByName - Deletes a user search by Name
• findAdvancedUserSearches - Finds all advanced user searches
• findAdvancedUserSearchesById - Finds user searches by ID
• findUserSearchesByName - Finds user searches by name
• updateAdvancedUserSearchById - Updates an existing advanced user search by ID
• updateAdvancedUserSearchByName - Updates an existing advanced user search by name

allowedfileextensions

• createAllowedFileExtensionById - Creates a new allowed file extension value by ID
• deleteAllowedFileExtensionById - Deletes an allowed file extension value by ID
• findAllowedFileExtension - Finds the allowed file extensions
• findAllowedFileExtensionById - Finds an allowed file extension value by ID
• findAllowedFileExtensionByName - Finds an allowed file extension value by name

buildings

• createBuildingById - Creates a new building
• deleteBuildingById - Deletes a building by ID
• deleteBuildingByName - Deletes a building by name
• findBuildings - Finds all buildings
• findBuildingsById - Finds buildings by ID
• findBuildingsByName - Finds buildings by name
• updateBuildingById - Updates an existing building by ID
• updateBuildingByName - Updates an existing building by name

byoprofiles

• createBYOProfilesById - Creates a personal device profile by ID
• deleteBYOProfilesById - Deletes a personal device profile by ID
• deleteBYOProfilesByName - Deletes a personal device profile by name
• findBYOProfiles - Finds all personal device profiles
• findBYOProfilesById - Finds personal device profile by ID
• findBYOProfilesByName - Finds a personal device profile by name
• updateBYOProfilesById - Updates a personal device profile by ID
• updateBYOProfilesByName - Updates a personal device profile by name

categories

• createCategoryById - Creates a new category by ID
• deleteCategoryById - Deletes a category by ID
• deleteCategoryByName - Deletes a category by name
• findCategories - Finds all categories
• findCategoriesById - Finds categories by ID
• findCategoriesByName - Finds categories by name
• updateCategoryById - Updates an existing category by ID
• updateCategoryByName - Updates an existing category by name

classes

• createClassById - Creates a new class by ID
• deleteClassById - Deletes a class by ID
• deleteClassByName - Deletes a class by name
• findClasses - Finds all classes
• findClassesById - Finds classes by ID
• findClassesByName - Finds classes by name
• updateClassById - Updates an existing class by ID
• updateClassByName - Updates an existing class by name

commandflush

• commandFlush - Flushes commands based on information specified in an XML file
• createCommandFlushWithIdAndStatus - Flushes commands for devices

computerapplications

• findComputerApplicationByNameAndVersion - Finds computer applications by name and version
• findComputerApplicationsByName - Finds computer applications by name
• findComputerApplicationsByNameAndVersionAndInventory - Finds computer applications by name and version
• findComputerApplicationsByNameInventory - Finds computer applications by name with additional display fields

computerapplicationusage

• findComputerApplicationUsageById - Finds computer application usage by computer ID
• findComputerApplicationUsageByMacAddress - Finds computer application usage by computer MAC address
• findComputerApplicationUsageByName - Finds computer application usage by computer name
• findComputerApplicationUsageBySerial - Finds computer application usage by computer serial number
• findComputerApplicationUsageByUDID - Finds computer application usage by computer UDID

computercheckin

• findComputerCheckin - Finds the Jamf Pro computer checkin information
• updateComputerCheckin - Updates the Jamf Pro computer checkin information

computercommands

• createComputerCommandByCommand - Creates a new computer command using command name
• createComputerCommandByCommandAndAction - Creates a new computer command with a command specific action. Commands supported: ScheduleOSUpdate (deprecated on 2022-10-17)
• createComputerCommandByCommandAndId - Creates a new computer command using command name and device IDs
• createComputerCommandByCommandIdAndPasscode - Creates a new computer command using command name and device IDs
• findComputerCommands - Finds all computer commands
• findComputerCommandsByName - Finds all computer commands by name
• findComputerCommandsByUuid - Finds a computer command by UUID

computerextensionattributes

• createComputerextensionattributeById - Creates a new computer extension attribute by ID
• deleteComputerextensionattributeById - Deletes a computer extension attribute by ID
• deleteComputerextensionattributeByName - Deletes a computer extension attribute by name
• findComputerextensionattributes - Finds all computer extension attributes
• findComputerextensionattributesById - Finds computer extension attributes by ID
• findComputerextensionattributesByName - Finds computer extension attributes by name
• updateComputerextensionattributeById - Updates an existing computer extension attribute by ID
• updateComputerextensionattributeByName - Updates an existing computer extension attribute by name

computergroups

• createComputerGroupById - Creates a new computer group by ID
• deleteComputerGroupById - Deletes a computer group by ID
• deleteComputerGroupByName - Deletes a computer group by name
• findComputerGroups - Finds all computer groups
• findComputerGroupsById - Finds computer groups by ID
• findComputerGroupsByName - Finds computer groups by name
• updateComputerGroupById - Updates an existing computer group by ID
• updateComputerGroupByName - Updates an existing computer group by name

computerhardwaresoftwarereports

• findComputerHardwareSoftwareReportsById - Finds hardware/software reports by computer ID
• findComputerHardwareSoftwareReportsByIdSubset - Finds a subset of hardware/software reports by computer ID
• findComputerHardwareSoftwareReportsByMacAddress - Finds hardware/software reports by computer MAC address
• findComputerHardwareSoftwareReportsByMacAddressSubset - Finds a subset of hardware/software reports by computer MAC address
• findComputerHardwareSoftwareReportsByName - Finds hardware/software reports by computer name
• findComputerHardwareSoftwareReportsByNameSubset - Finds a subset of hardware/software reports by computer name
• findComputerHardwareSoftwareReportsBySerial - Finds hardware/software reports by computer serial number
• findComputerHardwareSoftwareReportsBySerialSubset - Finds a subset of hardware/software reports by computer serial number
• findComputerHardwareSoftwareReportsByUDID - Finds hardware/software reports by computer UDID
• findComputerHardwareSoftwareReportsByUDIDSubset - Finds a subset of hardware/software reports by computer UDID

computerhistory

• findComputerHistoryById - Finds computer history by ID
• findComputerHistoryByIdSubset - Finds a subset of computer history data by ID
• findComputerHistoryByMacAddress - Finds computer history by MAC address
• findComputerHistoryByMacAddressSubset - Finds a subset of computer history data by MAC address
• findComputerHistoryByName - Finds computer history by name
• findComputerHistoryByNameSubset - Finds a subset of computer history data by name
• findComputerHistoryBySerialNumber - Finds computer history by serial number
• findComputerHistoryBySerialNumberSubset - Finds a subset of computer history data by serial number
• findComputerHistoryByUDID - Finds computer history by UDID
• findComputerHistoryByUDIDSubset - Finds a subset of computer history data by UDID

computerinventorycollection

• findComputerInventoryCollection - Finds the Jamf Pro computer inventory collection information
• updateComputerInventoryCollection - Updates the Jamf Pro computer inventory collection information

computerinvitations

• createComputerInvitationsById - Creates a new computer invitation by id
• createComputerInvitationsByInvitation - Creates a new computer invitation by invitation
• deleteComputerInvitationById - Deletes a computer invitation by id
• deleteComputerInvitationByInvitation - Deletes a computer invitation by invitation
• findComputerInvitations - Finds all computer invitations
• findComputerInvitationsById - Finds computer invitations by id
• findComputerInvitationsByInvitation - Finds computer invitations by invitation

computermanagement

• findComputerManagementById - Finds computer management information by ID
• findComputerManagementByIdPatchFilter - Display patch management information for a computer and filter
• findComputerManagementByIdSubset - Finds a subset of computer management information by ID
• findComputerManagementByIdUsername - Finds management information for a computer and username
• findComputerManagementByIdUsernameSubset - Finds a subset of management information for a computer and username
• findComputerManagementByMacAddress - Finds computer management information by MAC address
• findComputerManagementByMacAddressPatchFilter - Display patch management information for a computer and filter
• findComputerManagementByMacAddressSubset - Finds a subset of computer management information by MAC address
• findComputerManagementByMacAddressUsername - Finds management information for a computer and username
• findComputerManagementByMacAddressUsernameSubset - Finds a subset of management information for a computer and username
• findComputerManagementByName - Finds computer management information by name
• findComputerManagementByNamePatchFilter - Display patch management information for a computer and filter
• findComputerManagementByNameSubset - Finds a subset of computer management information by name
• findComputerManagementByNameUsername - Finds management information for a computer and username
• findComputerManagementByNameUsernameSubset - Finds a subset of management information for a computer and username
• findComputerManagementBySerialNumber - Finds computer management information by serial number
• findComputerManagementBySerialNumberPatchFilter - Display patch management information for a computer and filter
• findComputerManagementBySerialNumberSubset - Finds a subset of computer management information by serial number
• findComputerManagementBySerialNumberUsername - Finds management information for a computer and username
• findComputerManagementBySerialNumberUsernameSubset - Finds a subset of management information for a computer and username
• findComputerManagementByUDID - Finds computer management information by UDID
• findComputerManagementByUDIDSubset - Finds a subset of computer management information by UDID
• findComputerManagementByUdidPatchFilter - Display patch management information for a computer and filter
• findComputerManagementByUdidUsername - Finds management information for a computer and username
• findComputerManagementByUdidUsernameSubset - Finds a subset of management information for a computer and username

computerreports

• findComputerReports - Finds all computer reports
• findComputerReportsById - Finds computer reports by id
• findComputerReportsByName - Finds computer reports by name

computers

• createComputerById - Creates a computer
• deleteComputerById - Deletes a computer by ID
• deleteComputerByMacAddress - Deletes a computer by MAC address
• deleteComputerByName - Deletes a computer by name
• deleteComputerBySerialNumber - Deletes a computer by serial number
• deleteComputerByUDID - Deletes a computer by UDID
• findComputers - Finds all computers
• findComputersBasic - Finds basic information for all computers
• findComputersById - Finds computers by ID
• findComputersByIdSubset - Finds a subset of information for a computer
• findComputersByMacAddress - Finds computers by MAC address
• findComputersByMacAddressSubset - Finds a subset of data for computers by MAC address
• findComputersByName - Finds the first computer with the given name
• findComputersByNameSubset - Finds a subset of data for the first computer with the given name
• findComputersBySerialNumber - Finds computers by serial number
• findComputersBySerialNumberSubset - Finds a subset of data for computers by serial number
• findComputersByUDID - Finds computers by UDID
• findComputersByUDIDSubset - Finds a subset of data for computers by UDID
• flushComputerExtenstionAttributeData - Deletes data collected by an extension attribute
• matchComputers - Searches for computers that match the provided parameter
• matchComputersNames - Searches for computers that match the provided name parameter
• updateComputerById - Updates an existing computer by ID
• updateComputerByMacAddress - Updates an existing computer by MAC address
• updateComputerByName - Updates an existing computer by name
• updateComputerBySerialNumber - Updates an existing computer by serial number
• updateComputerByUDID - Updates an existing computer by UDID

departments

• createDepartmentById - Creates a new department by ID
• deleteDepartmentById - Deletes a department by ID
• deleteDepartmentByName - Deletes a department by name
• findDepartments - Finds all departments
• findDepartmentsById - Finds departments by ID
• findDepartmentsByName - Finds departments by name
• updateDepartmentById - Updates an existing department by ID
• updateDepartmentByName - Updates an existing department by name

directorybindings

• createDirectoryBindingById - Creates a new directory binding by ID
• deleteDirectoryBindingById - Deletes a directory binding by ID
• deleteDirectoryBindingByName - Deletes a directory binding by name
• findDirectoryBindings - Finds all directory bindings
• findDirectoryBindingsById - Finds directory bindings by ID
• findDirectoryBindingsByName - Finds directory bindings by name
• updateDirectoryBindingById - Updates an existing directory binding by ID
• updateDirectoryBindingByName - Updates an existing directory binding by name

diskencryptionconfigurations

• createDiskEncryptionConfigurationById - Creates a new disk encryption configuration by ID
• deleteDiskEncryptionConfigurationById - Deletes a disk encryption configuration by ID
• deleteDiskEncryptionConfigurationByName - Deletes a disk encryption configuration by name
• findDiskEncryptionConfigurations - Finds all disk encryption configurations
• findDiskEncryptionConfigurationsById - Finds disk encryption configurations by ID
• findDiskEncryptionConfigurationsByName - Finds disk encryption configurations by name
• updateDiskEncryptionConfigurationById - Updates an existing disk encryption configuration by ID
• updateDiskEncryptionConfigurationByName - Updates an existing disk encryption configuration by name

distributionpoints

• createDistributionPointById - Creates a new distribution point by ID
• deleteDistributionPointById - Deletes a distribution point by ID
• deleteDistributionPointByName - Deletes a distribution point by name
• findDistributionPoints - Finds all distribution points
• findDistributionPointsById - Finds distribution points by ID
• findDistributionPointsByName - Finds distribution points by name
• updateDistributionPointById - Updates an existing distribution point by ID
• updateDistributionPointByName - Updates an existing distribution point by name

dockitems

• createDockItemById - Creates a new dock item by ID
• deleteDockItemById - Deletes a dock item by ID
• deleteDockItemByName - Deletes a dock item by name
• findDockItems - Finds all dock items
• findDockItemsById - Finds dock items by ID
• findDockItemsByName - Finds dock items by name
• updateDockItemById - Updates an existing dock item by ID
• updateDockItemByName - Updates an existing dock item by name

ebooks

• createEBookById - Creates a new ebook by ID
• deleteEBookById - Deletes an ebook by ID
• deleteEBookByName - Deletes an ebook by name
• findEBooks - Finds all ebooks
• findEBooksById - Finds ebooks by ID
• findEBooksByName - Finds ebooks by name
• findEBooksByNameSubset - Finds a subset of data for ebooks by name
• findEbookssByIdSubset - Finds a subset of data for an ebook by ID
• updateEBookById - Updates an existing ebook by ID
• updateEBookByName - Updates an existing ebook by name

fileuploads

• uploadFiles - Creates file attachments in Jamf Pro

gsxconnection

• findGSXConnection - Finds the Jamf Pro GSX connection information
• updateGSXConnection - Updates the Jamf Pro GSX connection information

healthcarelistener

• findHealthcareListener - Find all Healthcare Listeners
• findHealthcareListenersById - Finds healthcare listener by ID
• updateHealthCareListenerById - Updates an existing healthcare listener by ID

healthcarelistenerrule

• createHealthCareListenerRuleById - Creates a new Healthcare Listener rule
• findHealthcareListenerRule - Find all Healthcare Listener rules
• findHealthcareListenerRulesById - Finds Healthcare Listener rules by ID
• updateHealthCareListenerRuleById - Updates an existing Healthcare Listener rule by ID

ibeacons

• createIBeaconById - Creates a new iBeacon region by ID
• deleteIBeaconById - Deletes an iBeacon region by ID
• deleteIBeaconByName - Deletes an iBeacon region by name
• findIBeacons - Finds all iBeacon regions
• findIBeaconsById - Finds iBeacon regions by ID
• findIBeaconsByName - Finds iBeacon regions by name
• updateIBeaconById - Updates an existing iBeacon region by ID
• updateIBeaconByName - Updates an existing iBeacon region by name

infrastructuremanager

• findInfrastructureManager - Find all Infrastructure Managers
• findInfrastructureManagerById - Finds infrastructure manager by ID
• updateInfrastructureManagerById - Updates an existing infrastructure manager by ID

jsonwebtokenconfigurations

• createJsonWebTokenConfigurationById - Creates a new JSON Web Token configuration by ID
• deleteJsonWebTokenConfigurationById - Deletes a JSON Web Token configuration by ID
• findJsonWebTokenConfigurationById - Find JSON Web Token configuration by ID
• findJsonWebTokenConfigurations - Finds all JSON Web Token configurations
• updateJsonWebTokenConfigurationById - Updates an existing JSON Web Token configuration by ID

jssuser

• jssuserGet - Returns basic information about Jamf Pro, as well as privileges of the person requesting the resource. (Deprecated) ⚠️ Deprecated

ldapservers

• createLDAPServerById - Creates a new LDAP server by ID
• deleteLDAPServerById - Deletes an LDAP server by ID
• deleteLDAPServerByName - Deletes an LDAP server by name
• findLDAPServerGroupById - Display information for matching groups for an LDAP server
• findLDAPServerGroupByName - Display information for matching groups for an LDAP server
• findLDAPServerGroupUserById - Display information about user membership in a group for an LDAP server
• findLDAPServerGroupUserByName - Display information about user membership in a group for an LDAP server
• findLDAPServerUserById - Display information for matching users for an LDAP server
• findLDAPServerUserByName - Display information for matching users for an LDAP server
• findLDAPServers - Finds all LDAP servers
• findLDAPServersById - Finds LDAP servers by ID
• findLDAPServersByName - Finds LDAP servers by name
• updateLDAPServerById - Updates an existing LDAP server by ID
• updateLDAPServerByName - Updates an existing LDAP server by name

licensedsoftware

• createLicensedSoftwareById - Creates new licensed software by ID
• deleteLicensedSoftwareById - Deletes licensed software by ID
• deleteLicensedSoftwareByName - Deletes licensed software by name
• findLicensedSoftware - Finds all licensed software
• findLicensedSoftwareById - Finds licensed software by ID
• findLicensedSoftwareByName - Finds licensed software by name
• updateLicensedSoftwareById - Updates existing licensed software by ID
• updateLicensedSoftwareByName - Updates an existing licensed software by name

logflush

• createLogFlushForInterval - Flushes all logs for a given interval
• createLogFlushWithIdAndInterval - Flushes a single log for a given interval
• logFlush - Flushes a log specified in an XML file

macapplications

• createMacappById - Creates a new mac application by ID
• deleteMacappById - Deletes a mac application by ID
• deleteMacappByName - Deletes a mac application by name
• findMacapps - Finds all mac applications
• findMacappsById - Finds mac applications by ID
• findMacappsByIdSubset - Finds a subset of date for a mac application by ID
• findMacappsByName - Finds mac applications by name
• findMacappsByNameSubset - Finds a subset of data for mac applications by name
• updateMacappById - Updates an existing mac application by ID
• updateMacappByName - Updates an existing mac application by name

managedpreferenceprofiles

• createManagedPreferenceProfileById - Creates a new managed preference profile by ID
• deleteManagedPreferenceProfilesById - Deletes a managed preference profiles by ID
• deleteManagedPreferenceProfilesByName - Deletes a managed preference profiles by name
• findManagedPreferenceProfiles - Finds all managed preference profiles
• findManagedPreferenceProfilesById - Finds managed preference profiles by ID
• findManagedPreferenceProfilesByIdSubset - Finds a subset of data for a managed preference profile by ID
• findManagedPreferenceProfilesByName - Finds managed preference profiles by name
• findManagedPreferenceProfilesByNameSubset - Finds a subset of data for managed preference profiles by name
• updateManagedPreferenceProfilesById - Updates an existing managed preference profiles by ID
• updateManagedPreferenceProfilesByName - Updates an existing managed preference profiles by name

mobiledeviceapplications

• createMobileDeviceApplicationById - Creates a new mobile device application by ID
• deleteMobileDeviceApplicationByBundleID - Deletes a mobile device application by bundle ID
• deleteMobileDeviceApplicationByBundleIDandVersion - Deletes a mobile device application by bundle ID and version
• deleteMobileDeviceApplicationById - Deletes a mobile device application by ID
• deleteMobileDeviceApplicationByName - Deletes a mobile device application by name
• findMobileDeviceApplications - Finds all mobile device applications
• findMobileDeviceApplicationsByBundleID - Finds mobile device applications by bundle ID
• findMobileDeviceApplicationsByBundleIDandVersion - Finds mobile device applications by bundle ID and version
• findMobileDeviceApplicationsById - Finds mobile device applications by ID
• findMobileDeviceApplicationsByName - Finds mobile device applications by name
• findMobileDeviceApplicationsByNameSubset - Finds a subset of data for mobile device applications by name
• findMobileDeviceAppsByIdSubset - Finds a subset of data for a mobile device application by ID
• updateMobileDeviceApplicationByBundleID - Updates an existing mobile device application by bundle ID
• updateMobileDeviceApplicationByBundleIDandVersion - Updates an existing mobile device application by bundle ID and version
• updateMobileDeviceApplicationById - Updates an existing mobile device application by ID
• updateMobileDeviceApplicationByName - Updates an existing mobile device application by name

mobiledevicecommands

• createMobileDeviceCommand - Creates a new mobile device command
• createMobileDeviceCommandURL - Creates a new mobile device command
• createMobileDeviceLockCommandURL - Sends a new lock command to a list of mobile devices
• createMobileDeviceNameCommandURL - Creates a new command to set the name of a mobile device.
• createMobileScheduleOSUpdateCommandURL - Creates a new command to request that a mobile device update its OS. Command and mobile device list specified in URL. Device will be updated to the latest OS version based on device eligibility. (deprecated on 2022-10-17)
• createMobileScheduleOSUpdateCommandWithProductVersionURL - Creates a new command to request that a mobile device update its OS. Command and mobile device list specified in URL. Mixing iOS and tvOS devices in ID list is not advised, as product version is specific to OS type. (deprecated on 2022-10-17)
• findMobileDeviceCommands - Finds all mobile device commands
• findMobileDeviceCommandsByCommand - Finds all mobile device commands for specified command
• findMobileDeviceCommandsByName - Finds all mobile device commands by command name
• findMobileDeviceCommandsByUuid - Finds a mobile device command by UUID

mobiledeviceconfigurationprofiles

• createMobileDeviceConfigurationProfileById - Creates a new mobile device configuration profile by ID
• deleteMobileDeviceConfigurationProfileById - Deletes a mobile device configuration profile by ID
• deleteMobileDeviceConfigurationProfileByName - Deletes a mobile device configuration profile by name
• findMobileDeviceConfigurationProfiles - Finds all mobile device configuration profiles
• findMobileDeviceConfigurationProfilesById - Finds mobile device configuration profiles by ID
• findMobileDeviceConfigurationProfilesByIdSubset - Finds a subset of data for a mobile device configuration profile by ID
• findMobileDeviceConfigurationProfilesByName - Finds mobile device configuration profiles by name
• findMobileDeviceConfigurationProfilesByNameSubset - Finds a subset of data for mobile device configuration profiles by name
• updateMobileDeviceConfigurationProfileById - Updates an existing mobile device configuration profile by ID
• updateMobileDeviceConfigurationProfileByName - Updates an existing mobile device configuration profile by name

mobiledeviceenrollmentprofiles

• createMobileDeviceEnrollmentProfilesById - Creates a new mobile device enrollment profile by ID
• deleteMobileDeviceEnrollmentProfileById - Deletes a mobile device enrollment profile by ID
• deleteMobileDeviceEnrollmentProfileByInvitation - Deletes a mobile device enrollment profile by invitation
• deleteMobileDeviceEnrollmentProfileByName - Deletes a mobile device enrollment profile by name
• findMobileDeviceEnrollmentProfiles - Finds all mobile device enrollment profiles
• findMobileDeviceEnrollmentProfilesById - Finds mobile device enrollment profiles by ID
• findMobileDeviceEnrollmentProfilesByIdSubset - Finds a subset of data for an enrollment profile
• findMobileDeviceEnrollmentProfilesByInvitation - Finds mobile device enrollment profiles by invitation
• findMobileDeviceEnrollmentProfilesByName - Finds mobile device enrollment profiles by name
• findMobileDeviceEnrollmentProfilesByNameSubset - Finds a subset of data for mobile device enrollment profiles by name
• updateMobileDeviceEnrollmentProfileById - Updates an existing mobile device enrollment profile by ID
• updateMobileDeviceEnrollmentProfileByInvitation - Updates an existing mobile device enrollment profile by invitation
• updateMobileDeviceEnrollmentProfileByName - Updates an existing mobile device enrollment profile by name

mobiledeviceextensionattributes

• createMobiledeviceextensionattributeById - Creates a new mobile device extension attribute by ID
• deleteMobiledeviceextensionattributeById - Deletes a mobile device extension attribute by ID
• deleteMobiledeviceextensionattributeByName - Deletes a mobile device extension attribute by name
• findMobiledeviceextensionattributes - Finds all mobile device extension attributes
• findMobiledeviceextensionattributesById - Finds mobile device extension attributes by ID
• findMobiledeviceextensionattributesByName - Finds mobiledeviceextensionattributes by name
• updateMobiledeviceextensionattributeById - Updates an existing mobile device extension attribute by ID
• updateMobiledeviceextensionattributeByName - Updates an existing mobile device extension attribute by name

mobiledevicegroups

• createMobileDeviceGroupById - Creates a new mobile device group by ID
• deleteMobileDeviceGroupById - Deletes a mobile device group by ID
• deleteMobileDeviceGroupByName - Deletes a mobile device group by name
• findMobileDeviceGroups - Finds all mobile device groups
• findMobileDeviceGroupsById - Finds mobile device groups by ID
• findMobileDeviceGroupsByName - Finds mobile device groups by name
• updateMobileDeviceGroupById - Updates an existing mobile device group by ID
• updateMobileDeviceGroupByName - Updates an existing mobile device group by name

mobiledevicehistory

• findMobileDeviceHistoryById - Finds mobile device history by ID
• findMobileDeviceHistoryByIdSubset - finds a subset of data for a mobile device history
• findMobileDeviceHistoryByMacAddress - Finds mobile device history by wifi mac address
• findMobileDeviceHistoryByMacAddressSubset - Finds a subset of data for mobile device history by wifi mac address
• findMobileDeviceHistoryByName - Finds mobile device history by name
• findMobileDeviceHistoryByNameSubset - Finds a subset of data for mobile device history by name
• findMobileDeviceHistoryBySerialNumber - Finds mobile device history by serial number
• findMobileDeviceHistoryBySerialNumberSubset - Finds a subset of data for mobile device history by serial number
• findMobileDeviceHistoryByUDID - Finds mobile device history by UDID
• findMobileDeviceHistoryByUDIDSubset - Finds a subset of data for mobile device history by UDID

mobiledeviceinvitations

• createMobileDeviceInvitationsById - Creates a new mobile device invitation by id
• createMobileDeviceInvitationsByInvitation - Creates a new mobile device invitation by invitation
• deleteMobileDeviceInvitationById - Deletes a mobile device invitation by id
• deleteMobileDeviceInvitationByInvitation - Deletes a mobile device invitation by invitation
• findMobileDeviceInvitations - Finds all mobile device invitations
• findMobileDeviceInvitationsById - Finds mobile device invitations by id
• findMobileDeviceInvitationsByInvitation - Finds mobile device invitations by invitation

mobiledeviceprovisioningprofiles

• createMobileDeviceProvisioningProfilesById - Creates a mobile device provisioning profiles by id
• createMobileDeviceProvisioningProfilesByName - Creates a mobile device provisioning profiles by name
• createMobileDeviceProvisioningProfilesByUUID - Creates a mobile device provisioning profiles by uuid
• deleteMobileDeviceProvisioningProfilesById - Deletes a mobile device provisioning profiles by id
• deleteMobileDeviceProvisioningProfilesByName - Deletes a mobile device provisioning profiles by name
• deleteMobileDeviceProvisioningProfilesByUUID - Deletes a mobile device provisioning profiles by uuid
• findMobileDeviceProvisioningProfiles - Finds all mobile device provisioning profiles
• findMobileDeviceProvisioningProfilesById - Finds a mobile device provisioning profiles by id
• findMobileDeviceProvisioningProfilesByName - Finds a mobile device provisioning profiles by name
• findMobileDeviceProvisioningProfilesByUUID - Finds a mobile device provisioning profiles by uuid
• updateMobileDeviceProvisioningProfilesById - Updates an existing mobile device provisioning profiles by id
• updateMobileDeviceProvisioningProfilesByName - Updates an existing mobile device provisioning profiles by name
• updateMobileDeviceProvisioningProfilesByUUID - Updates an existing mobile device provisioning profiles by uuid

mobiledevices

• createMobileDeviceById - Creates a new mobile device by ID
• deleteMobileDeviceById - Deletes a mobile device by ID
• deleteMobileDeviceByMacAddress - Deletes a mobile device by Mac address
• deleteMobileDeviceByName - Deletes a mobile device by name
• deleteMobileDeviceBySerialNumber - Deletes a mobile device by serial number
• deleteMobileDeviceByUDID - Deletes a mobile device by UDID
• findMobileDevices - Finds all mobile devices
• findMobileDevicesById - Finds mobile devices by ID
• findMobileDevicesByIdSubset - Finds a subset of data for a mobile device
• findMobileDevicesByMacAddress - Finds mobile devices by Mac address
• findMobileDevicesByMacAddressSubset - Finds a subset of data for mobile devices by Mac address
• findMobileDevicesByName - Finds mobile devices by name
• findMobileDevicesByNameSubset - Finds a subset of data for mobile devices by name
• findMobileDevicesBySerialNumber - Finds mobile devices by serial number
• findMobileDevicesBySerialNumberSubset - Finds a subset of data for mobile devices by serial number
• findMobileDevicesByUDID - Finds mobile devices by UDID
• findMobileDevicesByUDIDSubset - Finds a subset of data for mobile devices by UDID
• matchMobileDevices - Searches for mobile devices that match the provided parameter
• updateMobileDeviceById - Updates an existing mobile device by ID
• updateMobileDeviceByMacAddress - Updates an existing mobile device by Mac address
• updateMobileDeviceByName - Updates an existing mobile device by name
• updateMobileDeviceBySerialNumber - Updates an existing mobile device by serial number
• updateMobileDeviceByUDID - Updates an existing mobile device by UDID

networksegments

• createNetworkSegmentById - Creates a new network segment by ID
• deleteNetworkSegmentById - Deletes a network segment by ID
• deleteNetworkSegmentByName - Deletes a network segment by name
• findNetworkSegments - Finds all network segments
• findNetworkSegmentsById - Finds network segments by ID
• findNetworkSegmentsByName - Finds network segments by name
• updateNetworkSegmentById - Updates an existing network segment by ID
• updateNetworkSegmentByName - Updates an existing network segment by name

osxconfigurationprofiles

• createOsxConfigurationProfileById - Creates a new OS X configuration profile by ID
• deleteOsxConfigurationProfileById - Deletes a OS X configuration profile by ID
• deleteOsxConfigurationProfileByName - Deletes a OS X configuration profile by name
• findOsxConfigurationProfiles - Finds all OS X configuration profiles
• findOsxConfigurationProfilesById - Finds OS X configuration profiles by ID
• findOsxConfigurationProfilesByIdSubset - Finds a subset of data for an OS X configuration profile
• findOsxConfigurationProfilesByName - Finds OS X configuration profiles by name
• findOsxConfigurationProfilesByNameSubset - Finds a subset of data for OS X configuration profiles by name
• updateOsxConfigurationProfileById - Updates an existing OS X configuration profile by ID
• updateOsxConfigurationProfileByName - Updates an existing OS X configuration profile by name

packages

• createPackageById - Creates a new package by ID
• deletePackageById - Deletes a package by ID
• deletePackageByName - Deletes a package by name
• findPackages - Finds all packages
• findPackagesById - Finds packages by ID
• findPackagesByName - Finds packages by name
• updatePackageById - Updates an existing package by ID
• updatePackageByName - Updates an existing package by name

patchavailabletitles

• patchavailabletitlesSourceidByIdGet - Finds all available title from a source by ID

patches

• createPatchSoftwareTitlesById - Creates a patch software title (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".) ⚠️ Deprecated
• deleteSoftwareTitlesById - Deletes a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".) ⚠️ Deprecated
• deleteSoftwareTitlesByName - Deletes a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".) ⚠️ Deprecated
• findComputersByIDAndTitleVersion - Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/definitions".) ⚠️ Deprecated
• findComputersByNameAndTitleVersion - Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".) ⚠️ Deprecated
• findPatches - Finds all patches (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations". ⚠️ Deprecated
• findPatchesById - Finds patches by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".) ⚠️ Deprecated
• findPatchesByName - Finds the first patch with the name provided (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".) ⚠️ Deprecated
• updateSoftwareTitlesById - Updates a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".) ⚠️ Deprecated
• updateSoftwareTitlesByName - Updates a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".) ⚠️ Deprecated

patchexternalsources

• createPatchExternalSourcesById - Create a new patch external source by ID
• createPatchExternalSourcesByName - Create a new patch external source by name
• deletePatchExternalSourcesById - Deletes a patch external source by ID
• findPatchExternalSources - Finds all patch external sources
• findPatchExternalSourcesById - Finds a patch external source by ID
• findPatchExternalSourcesByName - Finds the first patch external source with the name provided
• updatePatchExternalSourcesById - Updates a patch external source by ID
• updatePatchExternalSourcesByName - Updates a patch external source by name

patchinternalsources

• findPatchInternalSources - Finds all patch internal sources
• findPatchInternalSourcesById - Finds a patch internal source by ID
• findPatchInternalSourcesByName - Finds the first patch internal source with the name provided

patchpolicies

• createPatchPolicyBySoftwareTitleConfigId - Create a new patch policy associated with a patch software title configuration ID
• deletePatchPolicyById - Deletes a patch policy by ID
• findPatchPolicies - Finds all patch policies. (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies". ⚠️ Deprecated
• findPatchPoliciesByIdSubset - Display subsets of information for a patch policy
• findPatchPoliciesBySoftwareTitleConfigId - Finds all patch policies by patch software title configuration ID (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies". ⚠️ Deprecated
• findPatchPolicyById - Finds a patch policy by ID
• updatePatchPolicyById - Updates an existing patch policy by ID

patchreports

• patchreportsPatchsoftwaretitleidByIdGet - Finds patch reports by patch software title ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/patch-report". ⚠️ Deprecated
• patchreportsPatchsoftwaretitleidVersionByIdAndVersionGet - Display computers for a specific version of a patch report. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/patch-report". ⚠️ Deprecated

patchsoftwaretitles

• patchsoftwaretitlesGet - Finds all patch software titles. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations". ⚠️ Deprecated
• patchsoftwaretitlesIdByIdDelete - Deletes a patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}". ⚠️ Deprecated
• patchsoftwaretitlesIdByIdGet - Finds a patch software titles by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}". ⚠️ Deprecated
• patchsoftwaretitlesIdByIdPost - Creates new patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}". ⚠️ Deprecated
• patchsoftwaretitlesIdByIdPut - Updates a patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}". ⚠️ Deprecated

peripherals

• createPeripheralById - Creates a new peripheral by ID
• deletePeripheralById - Deletes a peripheral by ID
• findPeripherals - Finds all peripherals
• findPeripheralsById - Finds peripherals by ID
• findPeripheralsByIdSubset - Finds a subset of data for a peripheral
• updatePeripheralById - Updates an existing peripheral by ID

peripheraltypes

• createPeripheralTypeById - Creates a new peripheral by ID
• deletePeripheralTypeById - Deletes a peripheral by ID
• findPeripheralTypes - Finds all peripheral types
• findPeripheralTypesById - Finds peripheral types by ID
• updatePeripheralTypeById - Updates an existing peripheral by ID

policies

• createPolicyById - Creates a new policy by ID
• deletePolicyById - Deletes a policy by ID
• deletePolicyByName - Deletes a policy by name
• findPolicies - Finds all policies
• findPoliciesByCategory - Finds all policies by category
• findPoliciesById - Finds policies by ID
• findPoliciesByIdSubset - Finds a subset of data for a policy
• findPoliciesByName - Finds policies by name
• findPoliciesByNameSubset - Finds a subset of data for policies by name
• findPoliciesByType - Finds all policies by type
• updatePolicyById - Updates an existing policy by ID
• updatePolicyByName - Updates an existing policy by name

printers

• createPrinterById - Creates a new printer by ID
• deletePrinterById - Deletes a printer by ID
• deletePrinterByName - Deletes a printer by name
• findPrinters - Finds all printers
• findPrintersById - Finds printers by ID
• findPrintersByName - Finds printers by name
• updatePrinterById - Updates an existing printer by ID
• updatePrinterByName - Updates an existing printer by name

removablemacaddresses

• createRemovableMacAddressById - Creates a new removable Mac address by ID
• deleteRemovableMacAddressById - Deletes a removable Mac address by ID
• deleteRemovableMacAddressByName - Deletes a removable Mac address by name
• findRemovableMacAddresses - Finds all removable Mac addresses
• findRemovableMacAddressesById - Finds removable Mac addresses by ID
• findRemovableMacAddressesByName - Finds removable Mac addresses by name
• updateRemovableMacAddressById - Updates an existing removable Mac address by ID
• updateRemovableMacAddressByName - Updates an existing removable Mac address by name

restrictedsoftware

• createRestrictedSoftwareById - Creates a new restricted software by ID
• deleteRestrictedSoftwareById - Deletes a restricted software by ID
• deleteRestrictedSoftwareByName - Deletes a restricted software by name
• findRestrictedSoftware - Finds all restricted software
• findRestrictedSoftwareById - Finds restricted software by ID
• findRestrictedSoftwareByName - Finds restricted software by name
• updateRestrictedSoftwareById - Updates an existing restricted software by ID
• updateRestrictedSoftwareByName - Updates an existing restricted software by name

savedsearches

• savedsearchesGet - Finds all saved searches (Deprecated - use advancedcomputersearches, advancedmobiledevicesearches and advancedusersearches) ⚠️ Deprecated
• savedsearchesIdByIdGet - Finds saved searches by ID (Deprecated - use advancedcomputersearches, advancedmobiledevicesearches and advancedusersearches) ⚠️ Deprecated
• savedsearchesNameByNameGet - Finds saved searches by name (Deprecated - use advancedcomputersearches, advancedmobiledevicesearches and advancedusersearches) ⚠️ Deprecated

scripts

• createScriptById - Creates a new script by ID
• deleteScriptById - Deletes a script by ID
• deleteScriptByName - Deletes a script by name
• findScripts - Finds all scripts
• findScriptsById - Finds scripts by ID
• findScriptsByName - Finds scripts by name
• updateScriptById - Updates an existing script by ID
• updateScriptByName - Updates an existing script by name

sites

• createSiteById - Creates a new site by ID
• deleteSiteById - Deletes a site by ID
• deleteSiteByName - Deletes a site by name
• findSites - Finds all sites
• findSitesById - Finds sites by ID
• findSitesByName - Finds sites by name
• updateSiteById - Updates an existing site by ID
• updateSiteByName - Updates an existing site by name

smtpserver

• findSMTPServer - Finds the Jamf Pro SMTP server information
• updateSMTPServer - Updates the Jamf Pro SMTP server information

softwareupdateservers

• createSoftwareUpdateServerById - Creates a new software update server by ID
• deleteSoftwareUpdateServerById - Deletes a software update server by ID
• deleteSoftwareUpdateServerByName - Deletes a software update server by name
• findSoftwareUpdateServers - Finds all software update servers
• findSoftwareUpdateServersById - Finds software update servers by ID
• findSoftwareUpdateServersByName - Finds software update servers by name
• updateSoftwareUpdateServerById - Updates an existing software update server by ID
• updateSoftwareUpdateServerByName - Updates an existing software update server by name

userextensionattributes

• createUserextensionattributeById - Creates a new user extension attribute by ID
• deleteUserextensionattributeById - Deletes a user extension attribute by ID
• deleteUserextensionattributeByName - Deletes a user extension attribute by name
• findUserextensionattributes - Finds all user extension attributes
• findUserextensionattributesById - Finds user extension attributes by ID
• findUserextensionattributesByName - Finds user extension attributes by name
• updateUserextensionattributeById - Updates an existing user extension attribute by ID
• updateUserextensionattributeByName - Updates an existing user extension attribute by name

usergroups

• createUserGroupsById - Creates user groups by ID
• deleteUserGroupsById - Deletes user groups by ID
• deleteUserGroupsByName - Deletes user groups by name
• findUserGroups - Finds all user groups
• findUserGroupsById - Finds user groups by ID
• findUserGroupsByName - Finds user groups by name
• updateUserGroupsById - Updates user groups by ID
• updateUserGroupsByName - Updates user groups by name

users

• createUserById - Creates a new user by ID
• deleteUserByEmailAddress - Deletes a user by email address
• deleteUserById - Deletes a user by ID
• deleteUserByName - Deletes a user by name
• findUsers - Finds all users
• findUsersByEmailAddress - Finds users by email address
• findUsersById - Finds users by ID
• findUsersByName - Finds users by name
• updateUserByEmailAddress - Updates an existing user by email address
• updateUserById - Updates an existing user by ID
• updateUserByName - Updates an existing user by name

vppaccounts

• createVPPAdminAccountById - Creates a new VPP account by ID
• deleteVPPAdminAccountById - Deletes a VPP account by ID
• findVPPAdminAccount - Finds all VPP Accounts
• findVPPAdminAccountById - Finds VPP Account by ID
• updateVPPAdminAccountById - Updates a VPP account by ID

vppassignments

• createAssignmentById - Creates a new VPP assignment by ID
• deleteAssignmentById - Deletes a VPP assignment by ID
• findAssignmentById - Finds VPP Assignment by ID
• findVPPAdminAssignment - Finds all VPP Assignments
• updateAssignmentById - Updates a VPP assignment by ID

vppinvitations

• createInvitationById - Creates a new VPP invitation by ID
• deleteInvitationById - Deletes a VPP invitation by ID
• findInvitationById - Finds a VPP Invitation by ID
• findInvitationsByIdSubset - Finds a subset of data for a VPP invitation
• findVPPAdminInvitation - Finds all VPP Invitations
• updateInvitationById - Updates a VPP invitation by ID

webhooks

• createWebhookById - Creates a new webhook by ID
• deleteWebhookById - Deletes a webhook by ID
• deleteWebhookByName - Deletes a webhook by name
• findWebhooks - Finds all webhooks
• findWebhooksById - Finds webhooks by ID
• findWebhooksByName - Finds webhooks by name
• updateWebhookById - Updates an existing webhook by ID
• updateWebhookByName - Updates an existing webhook by name

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

Example

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
    const sdk = new Jamf({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
            username: "<YOUR_USERNAME_HERE>",
        },
    });

    let res;
    try {
        res = await sdk.accounts.createAccountById({
            id: 437973,
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://subdomain-goes-here.jamfcloud.com/JSSResource	None

Example

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
    const sdk = new Jamf({
        serverIdx: 0,
        security: {
            password: "<YOUR_PASSWORD_HERE>",
            username: "<YOUR_USERNAME_HERE>",
        },
    });

    const res = await sdk.accounts.createAccountById({
        id: 437973,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
    const sdk = new Jamf({
        serverURL: "https://subdomain-goes-here.jamfcloud.com/JSSResource",
        security: {
            password: "<YOUR_PASSWORD_HERE>",
            username: "<YOUR_USERNAME_HERE>",
        },
    });

    const res = await sdk.accounts.createAccountById({
        id: 437973,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

import { jamf-classic-sdk-nodejs } from "Jamf";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new Jamf({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme
password	http	HTTP Basic
username	http	HTTP Basic

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
    const sdk = new Jamf({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
            username: "<YOUR_USERNAME_HERE>",
        },
    });

    const res = await sdk.accounts.createAccountById({
        id: 437973,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy