# Functions

BoolPtr returns a pointer to a bool value.
No description provided by the author
BuildClientWithConfigFile initializes a new Jamf Pro client using a configuration file for the HTTP client, logger, and integration.
BuildClientWithEnv initializes a new Jamf Pro client using environment variables for the HTTP client, logger, and integration.
FalsePtr returns a pointer to a false bool value.
IncrementStringID increments the given ID string.
LogLevelStringtoZap takes a string log level and converts it to a zap level.
TruePtr returns a pointer to a true bool value.

# Constants

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Mobile Device.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ApplicationAttributes represents the application attributes structure in the settings command.
ApplicationConfiguration represents the application configuration structure in the settings command.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClassItem represents a single class item in the list.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClientData represents the client data structure in the request.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CommandData represents the command data structure in the request.
No description provided by the author
No description provided by the author
Computers.
No description provided by the author
ComputerHistorySubsetApp defines the structure for application details in the Mac App Store context.
ComputerHistorySubsetAppStoreApps groups installed, pending, and failed applications from the Mac App Store.
ComputerHistorySubsetAudit stores audit logs.
ComputerHistorySubsetCasperImaging stores logs for Casper imaging actions.
ComputerHistorySubsetCasperRemote stores logs for Casper remote actions.
ComputerHistorySubsetCommand details a command with its issue and completion status.
ComputerHistorySubsetCommands groups completed, pending, and failed commands.
ComputerHistorySubsetEventDetails defines the structure for logging events with timestamps and user information.
ComputerHistorySubsetEventStatus defines a simple structure for logs with status and timestamps.
ComputerHistorySubsetGeneralInfo stores general information about the computer.
ComputerHistorySubsetLocation stores location data related to a user.
ComputerHistorySubsetPolicyDetails defines the details for policy logs.
ComputerHistorySubsetPolicyLog stores logs related to policies.
ComputerHistorySubsetScreenSharing stores logs related to screen sharing.
ComputerHistorySubsetScreenSharingDetails extends event status with details specific to screen sharing.
ComputerHistorySubsetUsageLog stores logs related to computer usage.
ComputerHistorySubsetUserLocation defines the detailed information about a user's location.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BootPartitionEncryptionDetails represents the details of disk encryption.
No description provided by the author
No description provided by the author
No description provided by the author
ContentCachingAlert represents an alert in the content caching details.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtensionAttribute represents a generic extension attribute.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AssignmentItem represents the structure of each assignment within the prestage scope.
No description provided by the author
No description provided by the author
No description provided by the author
Advanced Search DisplayField.
No description provided by the author
No description provided by the author
No description provided by the author
Class represents a class within the scope.
No description provided by the author
No description provided by the author
Building represents a building within the scope.
Computer represents a single computer within the scope.
ComputerGroup represents a group of computers within the scope.
Department represents a department within the scope.
Exclusions represent any exclusions within the scope.
EbooksSubsetLimitations represents any limitations within the scope.
MobileDevice represents a single mobile device within the scope.
EbooksSubsetMobileDeviceGroup represents a group of mobile devices within the scope.
User represents a user within the scope.
UserGroup represents a group of users within the scope.
No description provided by the author
SelfServiceCategories represent the categories within SelfService.
No description provided by the author
ErrorInstance represents a single error in the error response.
FeatureToggleStatusDetail represents the detailed status of the feature toggle (on/off).
FileVaultInventory represents the FileVault information for a single computer.
FileVaultInventoryList represents the paginated FileVault inventory response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MediaSource struct for the media sources within the JSON response.
Category struct represents the categories within SelfServiceSettings.
JamfAppCatalogDeploymentSubsetNotificationSettings struct represents the notification settings within ResourceJamfAppCatalogAppInstaller.
JamfAppCatalogDeploymentSubsetSelfServiceSettings struct represents the self-service settings within ResourceJamfAppCatalogAppInstaller.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MacOSConfigurationProfileSubsetComputer represents the computer subset of a macOS configuration profile.
MacOSConfigurationProfileSubsetExclusions represents the exclusions subset of a macOS configuration profile.
No description provided by the author
MacOSConfigurationProfileSubsetLimitations represents the limitations subset of a macOS configuration profile.
MacOSConfigurationProfileSubsetNetworkSegment represents the network segment subset of a macOS configuration profile.
MacOSConfigurationProfileSubsetScope represents the scope subset of a macOS configuration profile.
MacOSConfigurationProfileSubsetScopeEntity represents the scope entity subset of a macOS configuration profile.
MacOSConfigurationProfileSubsetSelfService represents the self-service subset of a macOS configuration profile.
MacOSConfigurationProfileSubsetSelfServiceCategory represents the self-service category subset of a macOS configuration profile.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specific struct for NetworkSegment due to its unique attribute 'UID'.
No description provided by the author
Generic Entity struct for common use.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MobileDeviceGroupDeviceItem represents a single mobile device within a group.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OnboardingItemResponse represents an item in the onboarding configuration response.
PackageManifest represents the package manifest structure in the deploy package command.
No description provided by the author
PatchPoliciesSubsetBuilding represents a building in the scope.
PatchPoliciesSubsetComputerGroup represents a computer group in the scope.
PatchPoliciesSubsetComputerItem represents a computer in the scope.
PatchPoliciesSubsetDepartment represents a department in the scope.
No description provided by the author
No description provided by the author
PatchPoliciesSubsetGroup is a general struct for group elements.
PatchPoliciesSubsetIBeaconItem represents an iBeacon in limitations.
PatchPoliciesSubsetNetworkSegmentItem represents a network segment in limitations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PolicySubsetAccountMaintenance represents the account maintenance settings of a policy.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PolicySubsetDiskEncryption represents the disk encryption settings of a policy.
No description provided by the author
PolicySubsetFilesProcesses represents the files and processes settings of a policy.
PolicySubsetGeneral represents the general information of a policy.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PolicySubsetMaintenance represents the maintenance settings of a policy.
No description provided by the author
PolicySubsetPackageConfiguration represents the package configuration settings of a policy.
No description provided by the author
No description provided by the author
PolicySubsetPrinters represents the printers settings of a policy.
PolicySubsetReboot represents the reboot settings of a policy.
PolicySubsetScope represents the scope of the policy.
No description provided by the author
No description provided by the author
No description provided by the author
PolicySubsetSelfService represents the self service settings of a policy.
No description provided by the author
No description provided by the author
No description provided by the author
PolicySubsetUserInteraction represents the user interaction settings of a policy.
No description provided by the author
No description provided by the author
ProgressReader wraps an io.Reader to report progress on read operations.
QueuedCommand represents the details of a queued command in the response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseActivationCode represents the structure of the response for an activation code.
No description provided by the author
ResourceAdvancedComputerSearch represents the structure of the response for an advanced computer search.
ResourceAdvancedMobileDeviceSearch represents the structure of the response for an advanced mobile device search.
Structs for Advanced User Search details by ID.
No description provided by the author
Integration represents the details of an individual API integration.
Role represents the details of an individual API role.
ResponseApiRolePrivileges represents the structure of the response for fetching API role privileges.
No description provided by the author
ResponseBuilding represents the structure of each building item in the response.
ResponseBuildingResourceHistory represents the structure of each resource history item in the response.
BYOProfile represents the details of a BYO profile.
ResponseCacheSettings represents the JSON response for cache settings.
No description provided by the author
No description provided by the author
No description provided by the author
Integration represents the details of Api client credentials.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResourceComputerExtensionAttribute represents a computer extension attribute.
No description provided by the author
ResourceComputerHistory represents the root structure of the computer history resource.
ResponseComputerInventory represents an individual computer from the inventory.
No description provided by the author
No description provided by the author
ComputerInventoryCollectionSettingsCustomPath defines the request body for creating a custom path.
No description provided by the author
No description provided by the author
ResourceConditionalAccessDeviceComplianceStatus represents the resource object.
ResourceDeclaration represents the structure of a single declaration associated with a managed software update plan.
No description provided by the author
ResourceDeployPackage represents the request structure for deploying a package.
No description provided by the author
DeviceEnrollment represents a single device enrollment instance.
DiskEncryptionConfiguration represents the top-level XML structure for creating/updating a Disk Encryption Configuration.
Struct to capture the response for a single Dock Item.
Resource.
ResourceEbooks represents the detailed structure of an Ebook response.
ResourceEligiblilityForOnboardingList represents an individual eligible app item.
No description provided by the author
Struct for detailed Distribution Point data.
Resource.
ResponseIBeacons represents the structure of an individual iBeacon.
No description provided by the author
Struct which represents AppInstallers object JSON from Pro API.
No description provided by the author
No description provided by the author
No description provided by the author
Resource Structs.
No description provided by the author
Structs for Jamf Protect API registration.
No description provided by the author
No description provided by the author
No description provided by the author
ResourceLDAPServers represents the structure of an individual LDAP server.
ResourceLicensedSoftware represents the structure of a single licensed software item.
Resource.
ResourceLoginCustomization represents the structure of the response for login customization.
ResourceMacApplications represents the detailed structure of a Mac Application response.
ResourceMacOSConfigurationProfiles represents the response structure for a macOS configuration profile.
ResourceManagedSoftwareUpdateFeatureToggle represents the payload for updating the feature toggle.
ResourceManagedSoftwareUpdatePlan represents the payload structure for creating a managed software update plan.
ResourceMDMCommandRequest represents the overall request structure for the MDM command.
ResourceMDMProfileRenewal represents the request structure for renewing MDM profiles.
ResourceMobileDevice represents the structure for a of a mobile device.
ResourceMobileDeviceApplication represents the detailed structure of a single mobile device application.
ResourceMobileDeviceConfigurationProfile represents the detailed structure of a single mobile device configuration profile.
ResourceMobileDeviceEnrollmentProfile represents the response structure for a mobile device enrollment profile.
ResourceMobileDeviceGroup represents the response for a single mobile device group.
No description provided by the author
ResourceMobileDeviceProvisioningProfile represents the detailed structure for a mobile device provisioning profile.
ResourceMobileExtensionAttribute represents the response structure for a mobile extension attribute.
ResourceNetworkSegment represents the response structure for a Network Segment.
ResourceOIDCKey represents a single key in the OIDC public key response.
ResourceOIDCRedirectURL represents the request body for getting the OIDC redirect URL.
ResourcePackage struct describes the JSON structure for a package in Jamf Pro.
ResourcePackageHistory struct to capture individual package history items in the list.
ResourcePatchExternalSource represents the root element of the patch external source.
ResourcePatchPolicies represents the root element of the patch policy XML.
ResourcePatchPolicy represents a Patch Policy object from Pro API.
No description provided by the author
ResourcePolicy represents the response structure for a single policy.
ResourcePrinter represents the detailed structure of a single printer.
No description provided by the author
Structs for individual Restricted Software.
ResourceReturnToServiceConfiguration represents the structure for a Return to Service configuration.
Struct which represents Script object JSON from Pro API.
SelfServiceBrandingDetail represents the details of a self-service branding configuration.
No description provided by the author
Updated struct for the SMTP server settings based on the new JSON data model.
Struct for individual Software Update Server.
No description provided by the author
ResourceUpdateOnboardingSettings represents the request body for updating onboarding settings.
No description provided by the author
ResponseUserExtensionAttributerepresents a single user extension attribute.
No description provided by the author
ResourceUserGroup represents the detailed information of a user group.
ResponseVolumePurchasingLocation represents the response structure for a single volume purchasing location.
No description provided by the author
Struct for individual VPP Account.
Structs for the detailed VPP assignment response.
Struct for individual Webhook.
ResourcManagedSoftwareUpdatePlanConfig defines the configuration for a managed software update plan.
ResourcManagedSoftwareUpdatePlanDevice defines the structure for device objects in the managed software update plan.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseActiveCertificateAuthority represents the JSON response for the active certificate authority.
No description provided by the author
ResponseAdvancedComputerSearchesList represents the structure for multiple advanced computer searches.
No description provided by the author
ResourceAdvancedMobileDeviceSearchList represents the structure for multiple advanced mobile device searches.
No description provided by the author
Response structure for the list of advanced user searches.
Response structure for the list of allowed file extensions.
ResponseApiIntegrations represents the structure of the response for fetching API integrations.
ResponseApiRoles represents the structure of the response for fetching API roles.
ResponseBuildingCreate represents the response structure for creating a building.
ResponseBuildingResourceHistoryList represents the structure of the response for the building resource history list.
ResponseBuildings represents the structure of the response for the buildings list.
ResponseBYOProfilesList represents the XML response for a list of BYO profiles.
No description provided by the author
ResponseCategoryCreateAndUpdate represents the response structure for creating a category.
ResponseClassesList represents the XML response for a list of classes.
No description provided by the author
No description provided by the author
ResponseCloudIDPCreate represents the response received after creating a Cloud Identity Provider.
No description provided by the author
Response structure for computer resources.
ResponseComputerExtensionAttributeCreated represents the response for a created computer extension attribute.
ResponseComputerExtensionAttributesList represents the paginated response for computer extension attributes.
No description provided by the author
No description provided by the author
ResponseComputerInventoryList represents the top-level JSON response structure.
No description provided by the author
ResponseComputerPrestageCreate represents the response structure for creating a building.
No description provided by the author
Response structure for the list of computers.
ResponseCSATenantID represents the response structure for the CSA tenant ID.
ResponseCSATokenExchangeDetails represents the response structure for the CSA token exchange details.
ResponseDeclarationsList represents the response structure for the list of declarations.
No description provided by the author
No description provided by the author
ResponseDeployPackage represents the response structure for deploying a package.
ResponseDeviceEnrollmentList represents the response for device enrollments list.
ResponseDeviceScope represents the structure of the response for a specific computer prestage scope.
Struct to capture the XML response for a single directory binding.
Struct to capture the XML response for directory bindings.
No description provided by the author
Struct to capture the XML response for disk encryption configurations.
Struct to capture the XML response for distribution points list.
Struct to capture the XML response for dock items list.
Responses.
Struct to capture the XML response for ebooks list.
ResponseEligiblilityForOnboardingList represents the paginated response for eligible apps.
No description provided by the author
No description provided by the author
ResponseError represents the structure of an error response from the API.
No description provided by the author
No description provided by the author
No description provided by the author
ResponseIBeaconsList represents the response structure for a list of iBeacons.
No description provided by the author
No description provided by the author
Struct for paginated response for app installers.
No description provided by the author
Response Structs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseLapsPasswordSet represents the response after setting LAPS passwords.
No description provided by the author
ResponseLicensedSoftwareList represents the response for a list of licensed software.
Resoponse struct for current password.
Response structs for LAPS capable accounts.
Response structs for full LAPS history.
Response structs for password history.
Response structs for pending rotations.
No description provided by the author
ResponseMacOSConfigurationProfileCreation represents the response structure for a new macOS configuration profile.
ResponseMacOSConfigurationProfileList represents the response structure for a list of macOS configuration profiles.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseManagedSoftwareUpdatePlansFeatureToggleStatus represents the response structure for the feature toggle status.
No description provided by the author
No description provided by the author
ResponseMDMCommand represents the response structure for the MDM command.
ResponseMDMProfileRenewal represents the response structure for renewing MDM profiles.
ResponseMobileDeviceApplicationsList represents the response for a list of mobile device applications.
ResponseMacOSConfigurationProfileCreation represents the response structure for a new macOS configuration profile.
ResponseMobileDeviceConfigurationProfilesList represents the response for a list of mobile device configuration profiles.
ResponseMobileDeviceEnrollmentProfilesList represents the response for a list of mobile device enrollment profiles.
ResponseMobileDeviceExtensionAttributesList represents the response for a list of mobile device extension attributes.
ResponseMobileDeviceGroupsList represents the response for a list of mobile device groups.
ResponseMobileDevicesList represents the structure for a list of mobile devices.
No description provided by the author
No description provided by the author
ResponseMobileDeviceProvisioningProfilesList represents the response for a list of mobile device provisioning profiles.
No description provided by the author
ResponseNetworkSegmentList represents the response for a list of Network Segments.
ResponseOIDCPublicKeyrepresents the response structure for the OIDC public key.
ResponseOIDCRedirectURL represents the response structure for the OIDC redirect URL.
ResponseOnboardingSettings represents the structure of the onboarding settings response.
ResponsePackageCreatedAndUpdated represents the response structure for creating and updating a package.
ResponsePackageHistoryList struct to capture the JSON response for package history list.
ResponsePackagesList struct to capture the JSON response for packages list.
ResponsePatchExternalSourcesList represents the list of patch external sources.
ResponsePatchExternalSourcesListItem represents a single external source item.
ResponsePatchPoliciesList represents the paginated response for patch policies.
ResponsePatchPolicyCreate represents the response when creating a patch policy.
ResponsePatchPolicyDashboardStatus represents the response for checking if a patch policy is on the dashboard.
No description provided by the author
No description provided by the author
Policies List Structs.
ResourcePolicyCreateAndUpdate represents the response structure for creating or updating a policy.
No description provided by the author
No description provided by the author
ResponsePrintersList represents the response for a list of printers.
ResponseRecoveryLockPassword represents the response structure for a recovery lock password.
Structs for Removable MAC Addresses List.
ResponseRemoveMDMProfile represents the response structure for removing an MDM profile.
No description provided by the author
Structs for Restricted Software List.
Response.
No description provided by the author
Structs to support JSON data structure.
Response format struct for create function.
Struct for paginated response for scripts.
ResponseSelfServiceBranding is the structure that holds the list of self-service branding configurations for macOS.
No description provided by the author
ResponseSLASAStatus represents the response structure for the SLASA acceptance status.
Structs for Software Update Servers Response.
No description provided by the author
No description provided by the author
ResponseStatusItems represents the response structure for status items.
ResponseUpdateOnboardingSettings represents the response body after updating onboarding settings.
ResponseUploadAttachment represents the response structure for uploading an attachment.
No description provided by the author
No description provided by the author
ResponseUserGroupsList represents the structure for a list of user groups.
No description provided by the author
No description provided by the author
ResponseVolumePurchasingList represents the paginated response for volume purchasing locations.
VolumePurchasingLocationCreateResponse represents the response for creating a volume purchasing location.
No description provided by the author
Structs for VPP Accounts Response.
Struct for the list of VPP assignments.
Structs for Webhooks Response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReturnToService represents the return to service structure in the erase device command.
No description provided by the author
No description provided by the author
SharedDeviceConfiguration represents the shared device configuration structure in the settings command.
No description provided by the author
ErrorDetail represents the details of an error in the response Used by jamfpro api MDM and managed software updates.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseError represents the structure of the error response when the force stop request fails.
No description provided by the author
No description provided by the author
SoftwareUpdateSettings represents the software update settings structure in the settings command.
No description provided by the author
No description provided by the author
No description provided by the author
StatusItem represents a single status item in the status report.
SubsetOnboardingItemRequest represents an item in the onboarding configuration request.
No description provided by the author
No description provided by the author
UserGroupUserItem represents a user of a user group.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VolumePurchasingLocation represents an individual volume purchasing location.
No description provided by the author
No description provided by the author
VolumePurchasingContent represents the content associated with a volume purchasing location.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Struct for VPP user.
Struct for VPP user group.
No description provided by the author