Pro API Models¶

Note

The intended use of SDK models is to provide an easier developer experience when working with requests and responses. All fields are optional, and extra fields are allowed for when Jamf releases a new version that adds additional fields that are not yet reflected in the SDK. These extra fields when present may or may not reflect their actual types. Do not rely solely on the SDK models for data validation.

Packages¶

Package

Represents a full package record.

JCDS2¶

`NewFile`	Create a new model by parsing and validating input data from keyword arguments.
`File`	Create a new model by parsing and validating input data from keyword arguments.
`DownloadUrl`	Create a new model by parsing and validating input data from keyword arguments.

MDM Commands¶

`SendMdmCommand`	Create a new model by parsing and validating input data from keyword arguments.
`SendMdmCommandClientData`	Create a new model by parsing and validating input data from keyword arguments.
`EnableLostModeCommand`	MDM command to enable Lost Mode.
`EraseDeviceCommand`	MDM command to remotely wipe a device.
`EraseDeviceCommandObliterationBehavior`(value)	Define the fallback behavior for erasing a device.
`EraseDeviceCommandReturnToService`	Configuration settings for Return to Service.
`LogOutUserCommand`	MDM command to log a user out of the device.
`RestartDeviceCommand`	MDM command to restart a device.
`ShutDownDeviceCommand`	MDM command to shut down a device.
`SendMdmCommandResponse`	Create a new model by parsing and validating input data from keyword arguments.
`RenewMdmProfileResponse`	This response model flattens the normal API JSON response from a nested `udidsNotProcessed.uuids` array to just `udidsNotProcessed`.
`MdmCommandStatus`	Create a new model by parsing and validating input data from keyword arguments.
`MdmCommandStatusClient`	Create a new model by parsing and validating input data from keyword arguments.
`MdmCommandStatusClientTypes`(value)	An enumeration.
`MdmCommandStatusStates`(value)	An enumeration.
`MdmCommandStatusTypes`(value)	An enumeration.

Mobile Devices¶

`MobileDevice`	Represents a full mobile device inventory record.
`MobileDeviceHardware`
`MobileDeviceUserAndLocation`
`MobileDevicePurchasing`
`MobileDeviceApplication`
`MobileDeviceCertificate`
`MobileDeviceProfile`
`MobileDeviceUserProfile`	Extends `MobileDeviceProfile`.
`MobileDeviceExtensionAttribute`
`MobileDeviceGeneral`
`MobileDeviceOwnershipType`(value)	An enumeration.
`MobileDeviceEnrollmentMethodPrestage`
`MobileDeviceSecurity`	iOS devices only.
`MobileDeviceEbook`	iOS devices only.
`MobileDeviceNetwork`	iOS devices only.
`MobileDeviceServiceSubscription`	iOS devices only.
`ProvisioningProfile`	iOS devices only.
`SharedUser`	iOS devices only.

Pagination¶

`Page`	A page result from a Pro API paginator.
`FilterEntry`(name, op, value)

`Computer`	Represents a full computer inventory record.
`ComputerGeneral`
`ComputerDiskEncryption`
`ComputerPurchase`
`ComputerApplication`
`ComputerStorage`
`ComputerUserAndLocation`
`ComputerConfigurationProfile`
`ComputerPrinter`
`ComputerService`
`ComputerHardware`
`ComputerLocalUserAccount`
`ComputerCertificate`
`ComputerAttachment`
`ComputerPlugin`
`ComputerPackageReceipts`
`ComputerFont`
`ComputerSecurity`
`ComputerOperatingSystem`
`ComputerLicensedSoftware`
`ComputeriBeacon`
`ComputerSoftwareUpdate`
`ComputerExtensionAttribute`
`ComputerContentCaching`
`ComputerGroupMembership`