pro

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 15, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package pro provides typed access to Jamf Platform pro API endpoints.

Index

Constants

This section is empty.

Variables

View Source 
var Privileges = map[string]jamfplatform.MethodPrivileges{}/* 704 elements not displayed */

Privileges maps each pro SDK method name to the Jamf API privileges it requires, sourced from the x-required-privileges vendor extensions in the Jamf OpenAPI specs. Identifiers are GA capability permissions in {capability}:{action} form and a multi-entry Scoped slice means all of them are required.

Source names where each entry's Scoped set came from: "spec" for the operation's own x-required-privileges, "gateway-policy" for one the published spec omits and this SDK supplies from the gateway's authorization policy, and "" when Scoped is empty. An empty Scoped slice means nothing declares a privilege for the endpoint, which is NOT the same as none being required — see jamfplatform.MethodPrivileges. Do not render it as "no permission needed".

Scopes lists the scope kinds each endpoint accepts. It is an alternatives set: a client carries one scope, so a consumer needs a credential matching one of the listed kinds. ScopesSource names where the set came from — "spec" for the spec root's own x-scope-types, "config-override" for one this SDK supplies because the published spec understates what the gateway serves or declares no extension at all. A spec-sourced set is what the spec declares, which for the Platform APIs is currently stricter than the gateway — see jamfplatform.MethodPrivileges.

Synthetic Resolve<X>ByName / Apply<X> methods are not present; document the privileges of the operations they call instead.

Functions

func PrivilegesFor 

func PrivilegesFor(method string) (jamfplatform.MethodPrivileges, bool)

PrivilegesFor returns the privilege metadata for the named SDK method and true when the method is present in the registry, or the zero value and false otherwise.

Types

type AccessGroupsPreviewSearchResults 

type AccessGroupsPreviewSearchResults struct {
	Results    []EnrollmentAccessGroupPreview `json:"results"`
	TotalCount int                            `json:"totalCount"`
}

AccessGroupsPreviewSearchResults represents a access groups preview search results.

type AccessManagementSetting 

type AccessManagementSetting struct {
	AutomatedDeviceEnrollmentServerUUID *string `json:"automatedDeviceEnrollmentServerUuid,omitempty"`
}

AccessManagementSetting represents a access management setting.

type Account 

type Account struct {
	// Allowed values: see the AccountAccessLevel constants.
	AccessLevel      string              `json:"accessLevel"`
	CurrentSiteID    int                 `json:"currentSiteId"`
	Email            string              `json:"email"`
	GroupIds         []int               `json:"groupIds"`
	ID               int                 `json:"id"`
	IsMultiSiteAdmin bool                `json:"isMultiSiteAdmin"`
	Preferences      *AccountPreferences `json:"preferences,omitempty"`
	// Allowed values: see the AccountPrivilegeSet constants.
	PrivilegeSet     string              `json:"privilegeSet"`
	PrivilegesBySite map[string][]string `json:"privilegesBySite"`
	RealName         string              `json:"realName"`
	Username         string              `json:"username"`
}

Account represents a account.

type AccountAccessLevel 

type AccountAccessLevel = string

AccountAccessLevel is the set of values accepted by Account.AccessLevel. 

const (
	AccountAccessLevelFullAccess       AccountAccessLevel = "FullAccess"
	AccountAccessLevelSiteAccess       AccountAccessLevel = "SiteAccess"
	AccountAccessLevelGroupBasedAccess AccountAccessLevel = "GroupBasedAccess"
)

AccountAccessLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountAccessLevelValues 

func AccountAccessLevelValues() []AccountAccessLevel

AccountAccessLevelValues returns every value the Jamf API accepts for AccountAccessLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountDrivenUserEnrollmentSessionTokenSettings 

type AccountDrivenUserEnrollmentSessionTokenSettings struct {
	Enabled                   *bool `json:"enabled,omitempty"`
	ExpirationIntervalDays    *int  `json:"expirationIntervalDays,omitempty"`
	ExpirationIntervalSeconds *int  `json:"expirationIntervalSeconds,omitempty"`
}

AccountDrivenUserEnrollmentSessionTokenSettings Settings for Account Driven User Enrollment. Only 1 of expirationIntervalDays or expirationIntervalSeconds can be supplied.

type AccountGroupSearchResultsV1 

type AccountGroupSearchResultsV1 struct {
	// The collection of account groups for the requested page.
	Results []AccountGroupV1 `json:"results"`
	// Total number of account groups matching the filter criteria.
	TotalCount int `json:"totalCount"`
}

AccountGroupSearchResultsV1 represents a account group search results v1.

type AccountGroupV1 

type AccountGroupV1 struct {
	// Access level for the account group.
	// Allowed values: see the AccountGroupV1AccessLevel constants.
	AccessLevel      string `json:"accessLevel"`
	DirectoryGroupID string `json:"directoryGroupId"`
	ID               string `json:"id"`
	LdapServerID     string `json:"ldapServerId"`
	// Members of this account group.
	Members []AccountGroupV1MembersItem `json:"members"`
	Name    string                      `json:"name"`
	// Privilege level for the account group.
	// Allowed values: see the AccountGroupV1PrivilegeLevel constants.
	PrivilegeLevel string `json:"privilegeLevel"`
	// List of privilege strings assigned to this group.
	Privileges []string `json:"privileges"`
	SiteID     string   `json:"siteId"`
}

AccountGroupV1 represents a account group v1.

type AccountGroupV1AccessLevel 

type AccountGroupV1AccessLevel = string

AccountGroupV1AccessLevel is the set of values accepted by AccountGroupV1.AccessLevel. 

const (
	AccountGroupV1AccessLevelFullAccess       AccountGroupV1AccessLevel = "FullAccess"
	AccountGroupV1AccessLevelSiteAccess       AccountGroupV1AccessLevel = "SiteAccess"
	AccountGroupV1AccessLevelGroupBasedAccess AccountGroupV1AccessLevel = "GroupBasedAccess"
)

AccountGroupV1AccessLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountGroupV1AccessLevelValues 

func AccountGroupV1AccessLevelValues() []AccountGroupV1AccessLevel

AccountGroupV1AccessLevelValues returns every value the Jamf API accepts for AccountGroupV1AccessLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountGroupV1MembersItem 

type AccountGroupV1MembersItem struct {
	Email    *string `json:"email,omitempty"`
	ID       string  `json:"id"`
	Realname *string `json:"realname,omitempty"`
	Username *string `json:"username,omitempty"`
}

AccountGroupV1MembersItem represents a account group v1 members item.

type AccountGroupV1PrivilegeLevel 

type AccountGroupV1PrivilegeLevel = string

AccountGroupV1PrivilegeLevel is the set of values accepted by AccountGroupV1.PrivilegeLevel. 

const (
	AccountGroupV1PrivilegeLevelAdministrator AccountGroupV1PrivilegeLevel = "ADMINISTRATOR"
	AccountGroupV1PrivilegeLevelAuditor       AccountGroupV1PrivilegeLevel = "AUDITOR"
	AccountGroupV1PrivilegeLevelEnrollment    AccountGroupV1PrivilegeLevel = "ENROLLMENT"
	AccountGroupV1PrivilegeLevelCustom        AccountGroupV1PrivilegeLevel = "CUSTOM"
)

AccountGroupV1PrivilegeLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountGroupV1PrivilegeLevelValues 

func AccountGroupV1PrivilegeLevelValues() []AccountGroupV1PrivilegeLevel

AccountGroupV1PrivilegeLevelValues returns every value the Jamf API accepts for AccountGroupV1PrivilegeLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountPreferences 

type AccountPreferences struct {
	DateFormat             string `json:"dateFormat"`
	IsDisableRelativeDates bool   `json:"isDisableRelativeDates"`
	Language               string `json:"language"`
	Region                 string `json:"region"`
	Timezone               string `json:"timezone"`
}

AccountPreferences represents a account preferences.

type AccountPreferencesSearchType 

type AccountPreferencesSearchType = string

AccountPreferencesSearchType represents a account preferences search type value. 

const (
	AccountPreferencesSearchTypeExactMatch AccountPreferencesSearchType = "EXACT_MATCH"
	AccountPreferencesSearchTypeStartsWith AccountPreferencesSearchType = "STARTS_WITH"
	AccountPreferencesSearchTypeContains   AccountPreferencesSearchType = "CONTAINS"
)

AccountPreferencesSearchType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountPreferencesSearchTypeValues 

func AccountPreferencesSearchTypeValues() []AccountPreferencesSearchType

AccountPreferencesSearchTypeValues returns every value the Jamf API accepts for AccountPreferencesSearchType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountPreferencesUserInterfaceDisplayTheme 

type AccountPreferencesUserInterfaceDisplayTheme = string

AccountPreferencesUserInterfaceDisplayTheme represents a account preferences user interface display theme value. 

const (
	AccountPreferencesUserInterfaceDisplayThemeMatchSystem AccountPreferencesUserInterfaceDisplayTheme = "MATCH_SYSTEM"
	AccountPreferencesUserInterfaceDisplayThemeLight       AccountPreferencesUserInterfaceDisplayTheme = "LIGHT"
	AccountPreferencesUserInterfaceDisplayThemeDark        AccountPreferencesUserInterfaceDisplayTheme = "DARK"
)

AccountPreferencesUserInterfaceDisplayTheme values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountPreferencesUserInterfaceDisplayThemeValues 

func AccountPreferencesUserInterfaceDisplayThemeValues() []AccountPreferencesUserInterfaceDisplayTheme

AccountPreferencesUserInterfaceDisplayThemeValues returns every value the Jamf API accepts for AccountPreferencesUserInterfaceDisplayTheme, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountPreferencesV6 

type AccountPreferencesV6 struct {
	ComputerApplicationSearchMethod      AccountPreferencesSearchType  `json:"computerApplicationSearchMethod"`
	ComputerApplicationUsageSearchMethod AccountPreferencesSearchType  `json:"computerApplicationUsageSearchMethod"`
	ComputerLocalUserAccountSearchMethod AccountPreferencesSearchType  `json:"computerLocalUserAccountSearchMethod"`
	ComputerPackageReceiptSearchMethod   AccountPreferencesSearchType  `json:"computerPackageReceiptSearchMethod"`
	ComputerPeripheralSearchMethod       *AccountPreferencesSearchType `json:"computerPeripheralSearchMethod,omitempty"`
	ComputerPrinterSearchMethod          AccountPreferencesSearchType  `json:"computerPrinterSearchMethod"`
	ComputerSearchMethod                 AccountPreferencesSearchType  `json:"computerSearchMethod"`
	ComputerServiceSearchMethod          AccountPreferencesSearchType  `json:"computerServiceSearchMethod"`
	ComputerSoftwareUpdateSearchMethod   *AccountPreferencesSearchType `json:"computerSoftwareUpdateSearchMethod,omitempty"`
	ConfigProfilesSortingMethod          string                        `json:"configProfilesSortingMethod"`
	DateFormat                           string                        `json:"dateFormat"`
	DisablePageLeaveCheck                bool                          `json:"disablePageLeaveCheck"`
	DisableRelativeDates                 bool                          `json:"disableRelativeDates"`
	DisableShortcutsTooltips             bool                          `json:"disableShortcutsTooltips"`
	DisableTablePagination               bool                          `json:"disableTablePagination"`
	// Language codes supported by Jamf Pro.
	// Allowed values: see the AccountPreferencesV6Language constants.
	Language                        string                                      `json:"language"`
	MobileDeviceAppSearchMethod     AccountPreferencesSearchType                `json:"mobileDeviceAppSearchMethod"`
	MobileDeviceSearchMethod        AccountPreferencesSearchType                `json:"mobileDeviceSearchMethod"`
	ResultsPerPage                  int                                         `json:"resultsPerPage"`
	ShowDirectoryGroupUUIDColumn    bool                                        `json:"showDirectoryGroupUuidColumn"`
	Timezone                        string                                      `json:"timezone"`
	UserAllContentSearchMethod      AccountPreferencesSearchType                `json:"userAllContentSearchMethod"`
	UserEbookSearchMethod           AccountPreferencesSearchType                `json:"userEbookSearchMethod"`
	UserInterfaceDisplayTheme       AccountPreferencesUserInterfaceDisplayTheme `json:"userInterfaceDisplayTheme"`
	UserMacAppStoreAppSearchMethod  AccountPreferencesSearchType                `json:"userMacAppStoreAppSearchMethod"`
	UserMobileDeviceAppSearchMethod AccountPreferencesSearchType                `json:"userMobileDeviceAppSearchMethod"`
	UserSearchMethod                AccountPreferencesSearchType                `json:"userSearchMethod"`
}

AccountPreferencesV6 represents a account preferences v6.

type AccountPreferencesV6Language 

type AccountPreferencesV6Language = string

AccountPreferencesV6Language is the set of values accepted by AccountPreferencesV6.Language. 

const (
	AccountPreferencesV6LanguageEn     AccountPreferencesV6Language = "en"
	AccountPreferencesV6LanguageDe     AccountPreferencesV6Language = "de"
	AccountPreferencesV6LanguageFr     AccountPreferencesV6Language = "fr"
	AccountPreferencesV6LanguageEs     AccountPreferencesV6Language = "es"
	AccountPreferencesV6LanguageJa     AccountPreferencesV6Language = "ja"
	AccountPreferencesV6LanguageZhHant AccountPreferencesV6Language = "zh-hant"
)

AccountPreferencesV6Language values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountPreferencesV6LanguageValues 

func AccountPreferencesV6LanguageValues() []AccountPreferencesV6Language

AccountPreferencesV6LanguageValues returns every value the Jamf API accepts for AccountPreferencesV6Language, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountPrivilegeSet 

type AccountPrivilegeSet = string

AccountPrivilegeSet is the set of values accepted by Account.PrivilegeSet. 

const (
	AccountPrivilegeSetAdministrator AccountPrivilegeSet = "ADMINISTRATOR"
	AccountPrivilegeSetAuditor       AccountPrivilegeSet = "AUDITOR"
	AccountPrivilegeSetEnrollment    AccountPrivilegeSet = "ENROLLMENT"
	AccountPrivilegeSetCustom        AccountPrivilegeSet = "CUSTOM"
)

AccountPrivilegeSet values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountPrivilegeSetValues 

func AccountPrivilegeSetValues() []AccountPrivilegeSet

AccountPrivilegeSetValues returns every value the Jamf API accepts for AccountPrivilegeSet, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountSettingsRequest 

type AccountSettingsRequest struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	AdminPassword      *string `json:"adminPassword,omitempty"`
	AdminUsername      *string `json:"adminUsername,omitempty"`
	HiddenAdminAccount *bool   `json:"hiddenAdminAccount,omitempty"`
	// id of Account Settings.
	ID                                      *string `json:"id,omitempty"`
	LocalAdminAccountEnabled                *bool   `json:"localAdminAccountEnabled,omitempty"`
	LocalUserManaged                        *bool   `json:"localUserManaged,omitempty"`
	PayloadConfigured                       *bool   `json:"payloadConfigured,omitempty"`
	PrefillAccountFullName                  *string `json:"prefillAccountFullName,omitempty"`
	PrefillAccountUserName                  *string `json:"prefillAccountUserName,omitempty"`
	PrefillPrimaryAccountInfoFeatureEnabled *bool   `json:"prefillPrimaryAccountInfoFeatureEnabled,omitempty"`
	// Values accepted are only CUSTOM and DEVICE_OWNER.
	PrefillType                        *string `json:"prefillType,omitempty"`
	PreventPrefillInfoFromModification *bool   `json:"preventPrefillInfoFromModification,omitempty"`
	// Allowed values: see the AccountSettingsRequestUserAccountType constants.
	UserAccountType *string `json:"userAccountType,omitempty"`
	VersionLock     *int    `json:"versionLock,omitempty"`
}

AccountSettingsRequest represents a account settings request.

type AccountSettingsRequestUserAccountType 

type AccountSettingsRequestUserAccountType = string

AccountSettingsRequestUserAccountType is the set of values accepted by AccountSettingsRequest.UserAccountType. 

const (
	AccountSettingsRequestUserAccountTypeAdministrator AccountSettingsRequestUserAccountType = "ADMINISTRATOR"
	AccountSettingsRequestUserAccountTypeStandard      AccountSettingsRequestUserAccountType = "STANDARD"
	AccountSettingsRequestUserAccountTypeSkip          AccountSettingsRequestUserAccountType = "SKIP"
)

AccountSettingsRequestUserAccountType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountSettingsRequestUserAccountTypeValues 

func AccountSettingsRequestUserAccountTypeValues() []AccountSettingsRequestUserAccountType

AccountSettingsRequestUserAccountTypeValues returns every value the Jamf API accepts for AccountSettingsRequestUserAccountType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AccountSettingsResponse 

type AccountSettingsResponse struct {
	AdminUsername      string `json:"adminUsername"`
	HiddenAdminAccount bool   `json:"hiddenAdminAccount"`
	// id of Account Settings.
	ID                                      string `json:"id"`
	LocalAdminAccountEnabled                bool   `json:"localAdminAccountEnabled"`
	LocalUserManaged                        bool   `json:"localUserManaged"`
	PayloadConfigured                       bool   `json:"payloadConfigured"`
	PrefillAccountFullName                  string `json:"prefillAccountFullName"`
	PrefillAccountUserName                  string `json:"prefillAccountUserName"`
	PrefillPrimaryAccountInfoFeatureEnabled bool   `json:"prefillPrimaryAccountInfoFeatureEnabled"`
	// Values accepted are only CUSTOM and DEVICE_OWNER.
	PrefillType                        string `json:"prefillType"`
	PreventPrefillInfoFromModification bool   `json:"preventPrefillInfoFromModification"`
	// Allowed values: see the AccountSettingsResponseUserAccountType constants.
	UserAccountType string `json:"userAccountType"`
	VersionLock     int    `json:"versionLock"`
}

AccountSettingsResponse represents a account settings response.

type AccountSettingsResponseUserAccountType 

type AccountSettingsResponseUserAccountType = string

AccountSettingsResponseUserAccountType is the set of values accepted by AccountSettingsResponse.UserAccountType. 

const (
	AccountSettingsResponseUserAccountTypeAdministrator AccountSettingsResponseUserAccountType = "ADMINISTRATOR"
	AccountSettingsResponseUserAccountTypeStandard      AccountSettingsResponseUserAccountType = "STANDARD"
	AccountSettingsResponseUserAccountTypeSkip          AccountSettingsResponseUserAccountType = "SKIP"
)

AccountSettingsResponseUserAccountType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AccountSettingsResponseUserAccountTypeValues 

func AccountSettingsResponseUserAccountTypeValues() []AccountSettingsResponseUserAccountType

AccountSettingsResponseUserAccountTypeValues returns every value the Jamf API accepts for AccountSettingsResponseUserAccountType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ActivationCode 

type ActivationCode struct {
	// Activation Code for Jamf Pro. Hyphens are optional.
	ActivationCode string `json:"activationCode"`
}

ActivationCode represents a activation code.

type ActiveUserSession 

type ActiveUserSession struct {
	// Timestamp of when the session was created.
	CreationTime *time.Time `json:"creationTime,omitempty"`
	// IP address associated with the session.
	IPAddress *string `json:"ipAddress,omitempty"`
	// Timestamp of when the session was last accessed.
	LastAccessedTime *time.Time `json:"lastAccessedTime,omitempty"`
	// Unique session identifier.
	SessionID string `json:"sessionId"`
	// User agent string from the session.
	UserAgent *string `json:"userAgent,omitempty"`
	// Username of the logged in user.
	Username string `json:"username"`
}

ActiveUserSession represents a active user session.

type ActiveUsersCount 

type ActiveUsersCount struct {
	// Number of currently logged in users.
	ActiveUserCount int `json:"activeUserCount"`
}

ActiveUsersCount represents a active users count.

type AdcsCertificate 

type AdcsCertificate struct {
	// Must be base-64 encoded data obtainable by `openssl base64 < /file/path/filename.pfx | tr -d '\n' |
	// pbcopy` in linux terminal, or similar parsing methods.
	Data []byte `json:"data"`
	// Server certificate filename should extend .cer or .pem, and client certificate filename should
	// extend .p12 or .pfx.
	Filename string `json:"filename"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password *string `json:"password,omitempty"`
}

AdcsCertificate represents a adcs certificate.

type AdcsCertificateResponse 

type AdcsCertificateResponse struct {
	ExpirationDate *string `json:"expirationDate"`
	// Server certificate filename should extend .cer or .pem, and client certificate filename should
	// extend .p12 or .pfx.
	Filename     string `json:"filename"`
	Issuer       string `json:"issuer"`
	SerialNumber string `json:"serialNumber"`
	Subject      string `json:"subject"`
}

AdcsCertificateResponse represents a adcs certificate response.

type AdcsDependencies 

type AdcsDependencies struct {
	Results    []AdcsDependency `json:"results"`
	TotalCount int              `json:"totalCount"`
}

AdcsDependencies represents a adcs dependencies.

type AdcsDependency 

type AdcsDependency struct {
	ConfigProfileID   int    `json:"configProfileId"`
	ConfigProfileName string `json:"configProfileName"`
	// Allowed values: see the AdcsDependencyConfigProfileType constants.
	ConfigProfileType string `json:"configProfileType"`
}

AdcsDependency represents a adcs dependency.

type AdcsDependencyConfigProfileType 

type AdcsDependencyConfigProfileType = string

AdcsDependencyConfigProfileType is the set of values accepted by AdcsDependency.ConfigProfileType. 

const (
	AdcsDependencyConfigProfileTypeOsxConfigurationProfile AdcsDependencyConfigProfileType = "OSX_CONFIGURATION_PROFILE"
	AdcsDependencyConfigProfileTypeIosConfigurationProfile AdcsDependencyConfigProfileType = "IOS_CONFIGURATION_PROFILE"
)

AdcsDependencyConfigProfileType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AdcsDependencyConfigProfileTypeValues 

func AdcsDependencyConfigProfileTypeValues() []AdcsDependencyConfigProfileType

AdcsDependencyConfigProfileTypeValues returns every value the Jamf API accepts for AdcsDependencyConfigProfileType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AdcsSettings 

type AdcsSettings struct {
	AdcsURL           *string          `json:"adcsUrl,omitempty"`
	ApiClientID       *string          `json:"apiClientId,omitempty"`
	CaName            *string          `json:"caName,omitempty"`
	ClientCert        *AdcsCertificate `json:"clientCert,omitempty"`
	DisplayName       *string          `json:"displayName,omitempty"`
	Fqdn              *string          `json:"fqdn,omitempty"`
	Outbound          *bool            `json:"outbound,omitempty"`
	RevocationEnabled *bool            `json:"revocationEnabled,omitempty"`
	ServerCert        *AdcsCertificate `json:"serverCert,omitempty"`
}

AdcsSettings AD CS Settings object to create, or update with a merge-patch strategy. Certificate data must be provided in full, or not at all for update with merge-patch strategy.

type AdcsSettingsResponse 

type AdcsSettingsResponse struct {
	AdcsURL                       string                   `json:"adcsUrl"`
	ApiClientID                   string                   `json:"apiClientId"`
	CaName                        string                   `json:"caName"`
	ClientCert                    *AdcsCertificateResponse `json:"clientCert,omitempty"`
	ConnectorLastCheckInTimestamp *time.Time               `json:"connectorLastCheckInTimestamp,omitempty"`
	DisplayName                   string                   `json:"displayName"`
	Fqdn                          string                   `json:"fqdn"`
	ID                            string                   `json:"id"`
	Outbound                      bool                     `json:"outbound"`
	RevocationEnabled             bool                     `json:"revocationEnabled"`
	ServerCert                    *AdcsCertificateResponse `json:"serverCert,omitempty"`
}

AdcsSettingsResponse represents a adcs settings response.

type AdvancedSearch 

type AdvancedSearch struct {
	Criteria      *[]SmartSearchCriterion `json:"criteria,omitempty"`
	DisplayFields *[]string               `json:"displayFields,omitempty"`
	ID            *string                 `json:"id,omitempty"`
	Name          string                  `json:"name"`
	SiteID        *string                 `json:"siteId,omitempty"`
}

AdvancedSearch represents a advanced search.

type AdvancedSearchCriteriaChoices 

type AdvancedSearchCriteriaChoices struct {
	Choices []string `json:"choices"`
}

AdvancedSearchCriteriaChoices represents a advanced search criteria choices.

type AdvancedSearchSearchResults 

type AdvancedSearchSearchResults struct {
	Results    []AdvancedSearch `json:"results"`
	TotalCount int              `json:"totalCount"`
}

AdvancedSearchSearchResults represents a advanced search search results.

type AdvancedUserContentSearch 

type AdvancedUserContentSearch struct {
	Criteria      *[]SmartSearchCriterion `json:"criteria,omitempty"`
	DisplayFields *[]string               `json:"displayFields,omitempty"`
	ID            *string                 `json:"id,omitempty"`
	Name          string                  `json:"name"`
	SiteID        *string                 `json:"siteId,omitempty"`
}

AdvancedUserContentSearch represents a advanced user content search.

type AdvancedUserContentSearchSearchResults 

type AdvancedUserContentSearchSearchResults struct {
	Results    []AdvancedUserContentSearch `json:"results"`
	TotalCount int                         `json:"totalCount"`
}

AdvancedUserContentSearchSearchResults represents a advanced user content search search results.

type ApiError 

type ApiError struct {
	Errors []ApiErrorCause `json:"errors"`
	// HTTP status of the response.
	HttpStatus int `json:"httpStatus"`
}

ApiError represents a api error.

type ApiErrorCause 

type ApiErrorCause struct {
	// Error-specific code that can be used to identify localization string, etc.
	Code string `json:"code"`
	// A general description of error for troubleshooting/debugging. Generally this text should not be
	// displayed to a user; instead refer to errorCode and it's localized text.
	Description string `json:"description"`
	// Name of the field that caused the error.
	Field string `json:"field"`
	// id of object with error. Optional.
	ID *string `json:"id,omitempty"`
}

ApiErrorCause represents a api error cause.

type ApnsClientPushStatus 

type ApnsClientPushStatus struct {
	// Id of the Computer or Device record in Jamf Pro.
	ClientID string `json:"clientId"`
	// The type of MDM client device.
	// Allowed values: see the ApnsClientPushStatusDeviceType constants.
	DeviceType string `json:"deviceType"`
	// Timestamp when push notifications were disabled for this client (ISO-8601 format).
	DisabledAt *time.Time `json:"disabledAt,omitempty"`
	// Unique identifier for the device management record.
	ManagementID string `json:"managementId"`
}

ApnsClientPushStatus Information about a client with push notifications disabled.

type ApnsClientPushStatusDeviceType 

type ApnsClientPushStatusDeviceType = string

ApnsClientPushStatusDeviceType is the set of values accepted by ApnsClientPushStatus.DeviceType. 

const (
	ApnsClientPushStatusDeviceTypeMobileDevice     ApnsClientPushStatusDeviceType = "MOBILE_DEVICE"
	ApnsClientPushStatusDeviceTypeMobileDeviceUser ApnsClientPushStatusDeviceType = "MOBILE_DEVICE_USER"
	ApnsClientPushStatusDeviceTypeComputer         ApnsClientPushStatusDeviceType = "COMPUTER"
	ApnsClientPushStatusDeviceTypeComputerUser     ApnsClientPushStatusDeviceType = "COMPUTER_USER"
	ApnsClientPushStatusDeviceTypeTv               ApnsClientPushStatusDeviceType = "TV"
	ApnsClientPushStatusDeviceTypeWatch            ApnsClientPushStatusDeviceType = "WATCH"
	ApnsClientPushStatusDeviceTypeVisionPro        ApnsClientPushStatusDeviceType = "VISION_PRO"
	ApnsClientPushStatusDeviceTypeUnknown          ApnsClientPushStatusDeviceType = "UNKNOWN"
)

ApnsClientPushStatusDeviceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ApnsClientPushStatusDeviceTypeValues 

func ApnsClientPushStatusDeviceTypeValues() []ApnsClientPushStatusDeviceType

ApnsClientPushStatusDeviceTypeValues returns every value the Jamf API accepts for ApnsClientPushStatusDeviceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ApnsClientPushStatusSearchResults 

type ApnsClientPushStatusSearchResults struct {
	// Array of APNS client push status records.
	Results []ApnsClientPushStatus `json:"results"`
	// Total number of records matching the query.
	TotalCount int64 `json:"totalCount"`
}

ApnsClientPushStatusSearchResults Search results containing APNS client push status records.

type ApnsPushEnableRequest 

type ApnsPushEnableRequest struct {
	// Timestamp when the request was processed (ISO-8601 format), null if not yet processed.
	ProcessedTime *time.Time `json:"processedTime,omitempty"`
	// Timestamp when the request was created (ISO-8601 format).
	RequestedTime *time.Time `json:"requestedTime,omitempty"`
	// Current status of the request.
	// Allowed values: see the ApnsPushEnableRequestStatus constants.
	Status string `json:"status"`
}

ApnsPushEnableRequest Status information for an enable all clients push request.

type ApnsPushEnableRequestStatus 

type ApnsPushEnableRequestStatus = string

ApnsPushEnableRequestStatus is the set of values accepted by ApnsPushEnableRequest.Status. 

const (
	ApnsPushEnableRequestStatusQueued    ApnsPushEnableRequestStatus = "QUEUED"
	ApnsPushEnableRequestStatusStarted   ApnsPushEnableRequestStatus = "STARTED"
	ApnsPushEnableRequestStatusCompleted ApnsPushEnableRequestStatus = "COMPLETED"
)

ApnsPushEnableRequestStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ApnsPushEnableRequestStatusValues 

func ApnsPushEnableRequestStatusValues() []ApnsPushEnableRequestStatus

ApnsPushEnableRequestStatusValues returns every value the Jamf API accepts for ApnsPushEnableRequestStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppConfigReinstallCode 

type AppConfigReinstallCode struct {
	ReinstallCode *string `json:"reinstallCode,omitempty"`
}

AppConfigReinstallCode represents a app config reinstall code.

type AppInstallerFeatureState 

type AppInstallerFeatureState struct {
	// Describes if client is authorized for App Installers.
	CloudServicesEnabled bool `json:"cloudServicesEnabled"`
	// An array of enabled features.
	Features []string `json:"features"`
}

AppInstallerFeatureState represents a app installer feature state.

type AppInstallersCategory 

type AppInstallersCategory struct {
	// An identifier of a category to which the deployment is assigned. A value of '-1' means no
	// assignment.
	ID string `json:"id"`
	// A name of a category to which the deployment is assigned. A value of null means no assignment or no
	// permission to read categories.
	Name *string `json:"name,omitempty"`
}

AppInstallersCategory represents a app installers category.

type AppInstallersDeploymentProcessControls 

type AppInstallersDeploymentProcessControls struct {
	// The frequency in minutes at which batches of deployments are queued. Must be between 10 and 1440.
	BatchFrequencyInMinutes *int `json:"batchFrequencyInMinutes,omitempty"`
	// The size of the batch of deployments to be processed. Must be between 1 and 50,000.
	CommandsBatchSize *int `json:"commandsBatchSize,omitempty"`
	// The days of the week when the deployments are going to be queued for device delivery.
	// Allowed values: see the AppInstallersDeploymentProcessControlsDaysOfWeek constants.
	DaysOfWeek *[]string `json:"daysOfWeek,omitempty"`
	// The UTC start time of day when the deployments are going to be queued for device delivery.
	FromTimeOfDay *string `json:"fromTimeOfDay,omitempty"`
	// The UTC end time of day when the deployments are going to be queued for device delivery.
	ToTimeOfDay *string `json:"toTimeOfDay,omitempty"`
}

AppInstallersDeploymentProcessControls Controls time and frequency when deployments are queued for device delivery.

type AppInstallersDeploymentProcessControlsDaysOfWeek 

type AppInstallersDeploymentProcessControlsDaysOfWeek = string

AppInstallersDeploymentProcessControlsDaysOfWeek is the set of values accepted by AppInstallersDeploymentProcessControls.DaysOfWeek. 

const (
	AppInstallersDeploymentProcessControlsDaysOfWeekMonday    AppInstallersDeploymentProcessControlsDaysOfWeek = "MONDAY"
	AppInstallersDeploymentProcessControlsDaysOfWeekTuesday   AppInstallersDeploymentProcessControlsDaysOfWeek = "TUESDAY"
	AppInstallersDeploymentProcessControlsDaysOfWeekWednesday AppInstallersDeploymentProcessControlsDaysOfWeek = "WEDNESDAY"
	AppInstallersDeploymentProcessControlsDaysOfWeekThursday  AppInstallersDeploymentProcessControlsDaysOfWeek = "THURSDAY"
	AppInstallersDeploymentProcessControlsDaysOfWeekFriday    AppInstallersDeploymentProcessControlsDaysOfWeek = "FRIDAY"
	AppInstallersDeploymentProcessControlsDaysOfWeekSaturday  AppInstallersDeploymentProcessControlsDaysOfWeek = "SATURDAY"
	AppInstallersDeploymentProcessControlsDaysOfWeekSunday    AppInstallersDeploymentProcessControlsDaysOfWeek = "SUNDAY"
)

AppInstallersDeploymentProcessControlsDaysOfWeek values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppInstallersDeploymentProcessControlsDaysOfWeekValues 

func AppInstallersDeploymentProcessControlsDaysOfWeekValues() []AppInstallersDeploymentProcessControlsDaysOfWeek

AppInstallersDeploymentProcessControlsDaysOfWeekValues returns every value the Jamf API accepts for AppInstallersDeploymentProcessControlsDaysOfWeek, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppInstallersDeploymentProcessControlsDefaultSettings 

type AppInstallersDeploymentProcessControlsDefaultSettings struct {
	// The frequency in minutes at which batches of deployments are queued.
	BatchFrequencyInMinutes int `json:"batchFrequencyInMinutes"`
	// The size of the batch of deployments to be processed.
	CommandsBatchSize int `json:"commandsBatchSize"`
	// The days of the week when the deployments are going to be queued for device delivery.
	// Allowed values: see the AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek constants.
	DaysOfWeek []string `json:"daysOfWeek"`
	// The UTC start time of day when the deployments are going to be queued for device delivery.
	FromTimeOfDay string `json:"fromTimeOfDay"`
	// The UTC end time of day when the deployments are going to be queued for device delivery.
	ToTimeOfDay string `json:"toTimeOfDay"`
}

AppInstallersDeploymentProcessControlsDefaultSettings Default settings for App Installers Deployment Process Controls.

type AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek 

type AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = string

AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek is the set of values accepted by AppInstallersDeploymentProcessControlsDefaultSettings.DaysOfWeek. 

const (
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekMonday    AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "MONDAY"
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekTuesday   AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "TUESDAY"
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekWednesday AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "WEDNESDAY"
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekThursday  AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "THURSDAY"
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekFriday    AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "FRIDAY"
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekSaturday  AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "SATURDAY"
	AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekSunday    AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek = "SUNDAY"
)

AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekValues 

func AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekValues() []AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek

AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeekValues returns every value the Jamf API accepts for AppInstallersDeploymentProcessControlsDefaultSettingsDaysOfWeek, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppInstallersGlobalSettings 

type AppInstallersGlobalSettings struct {
	// Controls time and frequency when deployments are queued for device delivery.
	DeploymentProcessControls *AppInstallersDeploymentProcessControls `json:"deploymentProcessControls,omitempty"`
	// End user experience settings in global app installers settings.
	EndUserExperienceSettings GlobalSettingsEndUserExperience `json:"endUserExperienceSettings"`
}

AppInstallersGlobalSettings Global settings for app installers.

type AppInstallersInstallationSummary 

type AppInstallersInstallationSummary struct {
	// Number of computers with an available app from the App Installer deployment in Self Service. If the
	// App Installer deployment has distribution method different than 'SELF_SERVICE', this value will be
	// always indicate 0.
	Available int `json:"available"`
	// Number of computers with failed installation of app from App Installer deployment.
	Failed int `json:"failed"`
	// Number of computers with in progress installation of app from App Installer deployment.
	InProgress int `json:"inProgress"`
	// Number of computers with installed app from App Installer deployment.
	Installed int `json:"installed"`
	// Number of computers in scope for App Installer deployment but assign to another deployment.
	Unqualified int `json:"unqualified"`
}

AppInstallersInstallationSummary represents a app installers installation summary.

type AppInstallersSite 

type AppInstallersSite struct {
	// An identifier of a site to which the deployment is assigned. A value of '-1' means no assignment.
	ID string `json:"id"`
	// A name of a site to which the deployment is assigned. A value of null means no assignment or no
	// permission to read the sites.
	Name *string `json:"name,omitempty"`
}

AppInstallersSite represents a app installers site.

type AppInstallersSmartGroup 

type AppInstallersSmartGroup struct {
	// An identifier of a smart group to which the deployment is assigned. A value of '-1' means no
	// assignment.
	ID string `json:"id"`
	// A name of a smart group to which the deployment is assigned. A value of null means no assignment or
	// no permission to read the smart groups.
	Name *string `json:"name,omitempty"`
}

AppInstallersSmartGroup represents a app installers smart group.

type AppPath 

type AppPath struct {
	// A "-1" id indicates a built-in path that cannot be deleted or modified.
	ID   string `json:"id"`
	Path string `json:"path"`
}

AppPath represents a app path.

type AppRequestFormInputField 

type AppRequestFormInputField struct {
	Description *string `json:"description,omitempty"`
	ID          *int    `json:"id,omitempty"`
	// Highest priority is 1, lowest is 255.
	Priority int    `json:"priority"`
	Title    string `json:"title"`
}

AppRequestFormInputField represents a app request form input field.

type AppRequestFormInputFieldSearchResults 

type AppRequestFormInputFieldSearchResults struct {
	Results    []AppRequestFormInputField `json:"results"`
	TotalCount int                        `json:"totalCount"`
}

AppRequestFormInputFieldSearchResults represents a app request form input field search results.

type AppRequestSettings 

type AppRequestSettings struct {
	// Can be any of the country codes from /v1/app-store-country-codes or "deviceLocale" to use each
	// individual device's locale.
	AppStoreLocale       *string   `json:"appStoreLocale,omitempty"`
	ApproverEmails       *[]string `json:"approverEmails,omitempty"`
	IsEnabled            *bool     `json:"isEnabled,omitempty"`
	RequesterUserGroupID *int      `json:"requesterUserGroupId,omitempty"`
}

AppRequestSettings represents a app request settings.

type AppTitle 

type AppTitle struct {
	// Bundle ID.
	BundleID string `json:"bundleId"`
	// URL that provides an icon for the application.
	IconURL string `json:"iconUrl"`
	// Unique App Title identifier that represents an application in the App Installers system.
	ID string `json:"id"`
	// If set to true - another App ID might be installed on the same path.
	InstallationPathShared bool `json:"installationPathShared"`
	// Publisher name.
	Publisher string `json:"publisher"`
	// Human readable name of the application.
	TitleName string `json:"titleName"`
	// Version.
	Version string `json:"version"`
}

AppTitle represents a app title.

type AppTitleDeployment 

type AppTitleDeployment struct {
	// ID of app titles to be deployed.
	AppTitleID string `json:"appTitleId"`
	// A category that this deployment should be assigned to, '-1' means no assignment.
	CategoryID *string `json:"categoryId,omitempty"`
	// Defines the 'deployment type' for an App Title. - **INSTALL_AUTOMATICALLY** - the app will be
	// installed as soon as possible - **SELF_SERVICE** - the app will be available in Self Service where
	// user can decide if the app should be installed.
	// Allowed values: see the AppTitleDeploymentDeploymentType constants.
	DeploymentType string `json:"deploymentType"`
	// Is deployment active or is it a draft.
	Enabled *bool   `json:"enabled,omitempty"`
	ID      *string `json:"id,omitempty"`
	// Determines whether the predefined configuration profiles will be automatically installed on client
	// computers.
	InstallPredefinedConfigProfiles *bool `json:"installPredefinedConfigProfiles,omitempty"`
	// Human readable name of the deployment.
	Name string `json:"name"`
	// Computer notification settings for running app with pending update; Settings are used only if
	// version of the app supports notifications.
	NotificationSettings *AppTitleDeploymentNotificationSettings `json:"notificationSettings,omitempty"`
	// Self Service settings to be used when deployment type is set to SELF_SERVICE.
	SelfServiceSettings *AppTitleDeploymentSelfServiceSettings `json:"selfServiceSettings,omitempty"`
	// A site that this deployment should be assigned to, '-1' means no assigment.
	SiteID *string `json:"siteId,omitempty"`
	// A smart group to which the app should be deployed. Default value, which means that the app installer
	// will not be deployed, will be used if it is set to null and deployment is not active.
	SmartGroupID *string `json:"smartGroupId,omitempty"`
	// If the app title is available in App Installer Service.
	TitleAvailableInAis *bool `json:"titleAvailableInAis,omitempty"`
	// Determines whether events related to this deployment will trigger admin notifications.
	TriggerAdminNotifications *bool `json:"triggerAdminNotifications,omitempty"`
	// Strategy for app updates. - **MANUAL** - the app will not get automatic updates without admin
	// interaction - **AUTOMATIC** - the app will get automatic updates.
	// Allowed values: see the AppTitleDeploymentUpdateBehavior constants.
	UpdateBehavior string `json:"updateBehavior"`
}

AppTitleDeployment represents a app title deployment.

type AppTitleDeploymentDeploymentType 

type AppTitleDeploymentDeploymentType = string

AppTitleDeploymentDeploymentType is the set of values accepted by AppTitleDeployment.DeploymentType. 

const (
	AppTitleDeploymentDeploymentTypeInstallAutomatically AppTitleDeploymentDeploymentType = "INSTALL_AUTOMATICALLY"
	AppTitleDeploymentDeploymentTypeSelfService          AppTitleDeploymentDeploymentType = "SELF_SERVICE"
)

AppTitleDeploymentDeploymentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentDeploymentTypeValues 

func AppTitleDeploymentDeploymentTypeValues() []AppTitleDeploymentDeploymentType

AppTitleDeploymentDeploymentTypeValues returns every value the Jamf API accepts for AppTitleDeploymentDeploymentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentNotificationSettings 

type AppTitleDeploymentNotificationSettings struct {
	// Custom notification displayed on computers when an app update has been successfully completed.
	// Default value will be used if set to null.
	CompleteMessage *string `json:"completeMessage,omitempty"`
	// Duration in hours before the app is forcefully closed.
	Deadline *int64 `json:"deadline,omitempty"`
	// Custom notification message displayed on computers when app is about to be forcefully closed.
	// Default value will be used if set to null.
	DeadlineMessage *string `json:"deadlineMessage,omitempty"`
	// Custom interval in hours to display notifications on computers. Default value will be used if set to
	// null.
	NotificationInterval *int64 `json:"notificationInterval,omitempty"`
	// Custom notification message to display on computers when app update is available but the app is
	// running. Default value will be used if set to null.
	NotificationMessage *string `json:"notificationMessage,omitempty"`
	// Additional duration in minutes before the app is forcefully closed. Default value will be used if
	// set to null.
	QuitDelay *int64 `json:"quitDelay,omitempty"`
	// Determines whether the app should be restarted after a successful update.
	Relaunch *bool `json:"relaunch,omitempty"`
	// Determines whether all notifications should be suppressed.
	Suppress *bool `json:"suppress,omitempty"`
}

AppTitleDeploymentNotificationSettings Computer notification settings for running app with pending update; Settings are used only if version of the app supports notifications.

type AppTitleDeploymentRead 

type AppTitleDeploymentRead struct {
	// ID of app titles to be deployed.
	AppTitleID string `json:"appTitleId"`
	// A category that this deployment should be assigned to, '-1' means no assignment.
	CategoryID string `json:"categoryId"`
	// Defines the 'deployment type' for an App Title. - **INSTALL_AUTOMATICALLY** - the app will be
	// installed as soon as possible - **SELF_SERVICE** - the app will be available in Self Service where
	// user can decide if the app should be installed.
	// Allowed values: see the AppTitleDeploymentReadDeploymentType constants.
	DeploymentType string `json:"deploymentType"`
	// Is deployment active or is it a draft.
	Enabled bool   `json:"enabled"`
	ID      string `json:"id"`
	// Determines whether the predefined configuration profiles will be automatically installed on client
	// computers.
	InstallPredefinedConfigProfiles bool `json:"installPredefinedConfigProfiles"`
	// Latest available app version.
	LatestAvailableVersion string `json:"latestAvailableVersion"`
	// Human readable name of the deployment.
	Name string `json:"name"`
	// Computer notification settings for running app with pending update; Settings are used only if
	// version of the app supports notifications.
	NotificationSettings *AppTitleDeploymentNotificationSettings `json:"notificationSettings,omitempty"`
	// App version to use for this deployment, contains value only if 'update behavior' is set to
	// **MANUAL**.
	SelectedVersion string `json:"selectedVersion"`
	// Self Service settings to be used when deployment type is set to SELF_SERVICE.
	SelfServiceSettings *AppTitleDeploymentSelfServiceSettings `json:"selfServiceSettings,omitempty"`
	// A site that this deployment should be assigned to, '-1' means no assigment.
	SiteID string `json:"siteId"`
	// A smart group to which the app should be deployed. Default value, which means that the app installer
	// will not be deployed, will be used if it is set to null and deployment is not active.
	SmartGroupID string `json:"smartGroupId"`
	// If the app title is available in App Installer Service.
	TitleAvailableInAis bool `json:"titleAvailableInAis"`
	// Determines whether events related to this deployment will trigger admin notifications.
	TriggerAdminNotifications bool `json:"triggerAdminNotifications"`
	// Strategy for app updates. - **MANUAL** - the app will not get automatic updates without admin
	// interaction - **AUTOMATIC** - the app will get automatic updates.
	// Allowed values: see the AppTitleDeploymentReadUpdateBehavior constants.
	UpdateBehavior string `json:"updateBehavior"`
	// If the app title version was removed from App Installer Service.
	VersionRemoved bool `json:"versionRemoved"`
}

AppTitleDeploymentRead represents a app title deployment read.

type AppTitleDeploymentReadDeploymentType 

type AppTitleDeploymentReadDeploymentType = string

AppTitleDeploymentReadDeploymentType is the set of values accepted by AppTitleDeploymentRead.DeploymentType. 

const (
	AppTitleDeploymentReadDeploymentTypeInstallAutomatically AppTitleDeploymentReadDeploymentType = "INSTALL_AUTOMATICALLY"
	AppTitleDeploymentReadDeploymentTypeSelfService          AppTitleDeploymentReadDeploymentType = "SELF_SERVICE"
)

AppTitleDeploymentReadDeploymentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentReadDeploymentTypeValues 

func AppTitleDeploymentReadDeploymentTypeValues() []AppTitleDeploymentReadDeploymentType

AppTitleDeploymentReadDeploymentTypeValues returns every value the Jamf API accepts for AppTitleDeploymentReadDeploymentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentReadUpdateBehavior 

type AppTitleDeploymentReadUpdateBehavior = string

AppTitleDeploymentReadUpdateBehavior is the set of values accepted by AppTitleDeploymentRead.UpdateBehavior. 

const (
	AppTitleDeploymentReadUpdateBehaviorManual    AppTitleDeploymentReadUpdateBehavior = "MANUAL"
	AppTitleDeploymentReadUpdateBehaviorAutomatic AppTitleDeploymentReadUpdateBehavior = "AUTOMATIC"
)

AppTitleDeploymentReadUpdateBehavior values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentReadUpdateBehaviorValues 

func AppTitleDeploymentReadUpdateBehaviorValues() []AppTitleDeploymentReadUpdateBehavior

AppTitleDeploymentReadUpdateBehaviorValues returns every value the Jamf API accepts for AppTitleDeploymentReadUpdateBehavior, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentSelfServiceSettings 

type AppTitleDeploymentSelfServiceSettings struct {
	// List of categories.
	Categories *[]AppTitleDeploymentSelfServiceSettingsCategoriesItem `json:"categories,omitempty"`
	// Custom text to display as a description for the app.
	Description *string `json:"description,omitempty"`
	// Computer user will be forced to view description when installing the app.
	ForceViewDescription *bool `json:"forceViewDescription,omitempty"`
	// App will be displayed in 'Compliance' category if system configuration supports it.
	IncludeInComplianceCategory *bool `json:"includeInComplianceCategory,omitempty"`
	// App will be displayed in 'Featured' category.
	IncludeInFeaturedCategory *bool `json:"includeInFeaturedCategory,omitempty"`
}

AppTitleDeploymentSelfServiceSettings Self Service settings to be used when deployment type is set to SELF_SERVICE.

type AppTitleDeploymentSelfServiceSettingsCategoriesItem 

type AppTitleDeploymentSelfServiceSettingsCategoriesItem struct {
	// App will be featured in given displayed category.
	Featured *bool `json:"featured,omitempty"`
	// category id.
	ID string `json:"id"`
}

AppTitleDeploymentSelfServiceSettingsCategoriesItem represents a app title deployment self service settings categories item.

type AppTitleDeploymentSummary 

type AppTitleDeploymentSummary struct {
	App              *AppTitleDeploymentSummaryApp     `json:"app,omitempty"`
	Category         *AppInstallersCategory            `json:"category,omitempty"`
	ComputerStatuses *AppInstallersInstallationSummary `json:"computerStatuses,omitempty"`
	// Defines the 'deployment type' for an App Title. - **INSTALL_AUTOMATICALLY** - the app will be
	// installed as soon as possible - **SELF_SERVICE** - the app will be available in Self Service where
	// user can decide if the app should be installed.
	// Allowed values: see the AppTitleDeploymentSummaryDeploymentType constants.
	DeploymentType string `json:"deploymentType"`
	// Is deployment active or is it a draft.
	Enabled bool `json:"enabled"`
	// Deployment id.
	ID string `json:"id"`
	// Human readable name of the deployment.
	Name       string                   `json:"name"`
	Site       *AppInstallersSite       `json:"site,omitempty"`
	SmartGroup *AppInstallersSmartGroup `json:"smartGroup,omitempty"`
	// Strategy for app updates. - **MANUAL** - the app will not get automatic updates without admin
	// interaction - **AUTOMATIC** - the app will get automatic updates.
	// Allowed values: see the AppTitleDeploymentSummaryUpdateBehavior constants.
	UpdateBehavior string `json:"updateBehavior"`
}

AppTitleDeploymentSummary represents a app title deployment summary.

type AppTitleDeploymentSummaryApp 

type AppTitleDeploymentSummaryApp struct {
	// Bundle ID of app title from deployment.
	BundleID *string `json:"bundleId,omitempty"`
	// App version to be deployed on end user's computers.
	DeployedVersion string `json:"deployedVersion"`
	// URL that provides an icon for the application.
	IconURL *string `json:"iconUrl,omitempty"`
	// App Title identifier.
	ID string `json:"id"`
	// Latest version of app title from deployment.
	LatestVersion *string `json:"latestVersion,omitempty"`
	// Indication on the source which app is downloaded from Values: - **EXTERNAL_URL** - app is downloaded
	// from external source which usually means vendor site - **JAMF_SERVER** - app is downloaded from JAMF
	// server.
	// Allowed values: see the AppTitleDeploymentSummaryAppMediaSourceType constants.
	MediaSourceType string `json:"mediaSourceType"`
	// App version to use for this deployment, contains value only if 'update behavior' is set to
	// **MANUAL**.
	SelectedVersion string `json:"selectedVersion"`
	// If the app title is available in App Installer Service.
	TitleAvailableInAis bool `json:"titleAvailableInAis"`
	// If selected app title version was removed from App Installer Service.
	VersionRemoved bool `json:"versionRemoved"`
}

AppTitleDeploymentSummaryApp represents a app title deployment summary app.

type AppTitleDeploymentSummaryAppMediaSourceType 

type AppTitleDeploymentSummaryAppMediaSourceType = string

AppTitleDeploymentSummaryAppMediaSourceType is the set of values accepted by AppTitleDeploymentSummaryApp.MediaSourceType. 

const (
	AppTitleDeploymentSummaryAppMediaSourceTypeExternalURL AppTitleDeploymentSummaryAppMediaSourceType = "EXTERNAL_URL"
	AppTitleDeploymentSummaryAppMediaSourceTypeJamfServer  AppTitleDeploymentSummaryAppMediaSourceType = "JAMF_SERVER"
)

AppTitleDeploymentSummaryAppMediaSourceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentSummaryAppMediaSourceTypeValues 

func AppTitleDeploymentSummaryAppMediaSourceTypeValues() []AppTitleDeploymentSummaryAppMediaSourceType

AppTitleDeploymentSummaryAppMediaSourceTypeValues returns every value the Jamf API accepts for AppTitleDeploymentSummaryAppMediaSourceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentSummaryDeploymentType 

type AppTitleDeploymentSummaryDeploymentType = string

AppTitleDeploymentSummaryDeploymentType is the set of values accepted by AppTitleDeploymentSummary.DeploymentType. 

const (
	AppTitleDeploymentSummaryDeploymentTypeInstallAutomatically AppTitleDeploymentSummaryDeploymentType = "INSTALL_AUTOMATICALLY"
	AppTitleDeploymentSummaryDeploymentTypeSelfService          AppTitleDeploymentSummaryDeploymentType = "SELF_SERVICE"
)

AppTitleDeploymentSummaryDeploymentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentSummaryDeploymentTypeValues 

func AppTitleDeploymentSummaryDeploymentTypeValues() []AppTitleDeploymentSummaryDeploymentType

AppTitleDeploymentSummaryDeploymentTypeValues returns every value the Jamf API accepts for AppTitleDeploymentSummaryDeploymentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentSummaryUpdateBehavior 

type AppTitleDeploymentSummaryUpdateBehavior = string

AppTitleDeploymentSummaryUpdateBehavior is the set of values accepted by AppTitleDeploymentSummary.UpdateBehavior. 

const (
	AppTitleDeploymentSummaryUpdateBehaviorManual    AppTitleDeploymentSummaryUpdateBehavior = "MANUAL"
	AppTitleDeploymentSummaryUpdateBehaviorAutomatic AppTitleDeploymentSummaryUpdateBehavior = "AUTOMATIC"
)

AppTitleDeploymentSummaryUpdateBehavior values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentSummaryUpdateBehaviorValues 

func AppTitleDeploymentSummaryUpdateBehaviorValues() []AppTitleDeploymentSummaryUpdateBehavior

AppTitleDeploymentSummaryUpdateBehaviorValues returns every value the Jamf API accepts for AppTitleDeploymentSummaryUpdateBehavior, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentUpdateBehavior 

type AppTitleDeploymentUpdateBehavior = string

AppTitleDeploymentUpdateBehavior is the set of values accepted by AppTitleDeployment.UpdateBehavior. 

const (
	AppTitleDeploymentUpdateBehaviorManual    AppTitleDeploymentUpdateBehavior = "MANUAL"
	AppTitleDeploymentUpdateBehaviorAutomatic AppTitleDeploymentUpdateBehavior = "AUTOMATIC"
)

AppTitleDeploymentUpdateBehavior values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDeploymentUpdateBehaviorValues 

func AppTitleDeploymentUpdateBehaviorValues() []AppTitleDeploymentUpdateBehavior

AppTitleDeploymentUpdateBehaviorValues returns every value the Jamf API accepts for AppTitleDeploymentUpdateBehavior, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleDeploymentsSummaryResult 

type AppTitleDeploymentsSummaryResult struct {
	Results    []AppTitleDeploymentSummary `json:"results"`
	TotalCount int                         `json:"totalCount"`
}

AppTitleDeploymentsSummaryResult represents a app title deployments summary result.

type AppTitleDetails 

type AppTitleDetails struct {
	// Computer architecture type supported by this version of the App. Values: - **universal** - the app
	// can be installed on computers with arm64 or x86_64 processor - **x86_64** - the app can be installed
	// on computers with x86_64 processor - **arm64** - the app can be installed on computers with arm64
	// processor.
	Architecture string `json:"architecture"`
	// Date when the app version was made available in Jamf App Catalog.
	AvailabilityDate string `json:"availabilityDate"`
	// Bundle ID.
	BundleID string `json:"bundleId"`
	// URL that provides an icon for the application.
	IconURL string `json:"iconUrl"`
	// Unique App Title identifier that represents an application in the App Installers system.
	ID string `json:"id"`
	// If set to true - another App ID might be installed on the same path.
	InstallationPathShared bool `json:"installationPathShared"`
	// Hash used to verify integrity of the final package.
	InstallerPackageHash string `json:"installerPackageHash"`
	// Type of package integrity hash for final package.
	InstallerPackageHashType string `json:"installerPackageHashType"`
	// Language included if app has locale-specific build.
	Language string `json:"language"`
	// If a launch daemon is included.
	LaunchDaemonIncluded bool `json:"launchDaemonIncluded"`
	// Indication on the source which app is downloaded from Values: - **EXTERNAL_URL** - app is downloaded
	// from external source which usually means vendor site - **JAMF_SERVER** - app is downloaded from JAMF
	// server.
	// Allowed values: see the AppTitleDetailsMediaSourceType constants.
	MediaSourceType string `json:"mediaSourceType"`
	// Minimal operating system version required for this app.
	MinimumOsVersion string `json:"minimumOsVersion"`
	// If notifications are enabled.
	NotificationAvailable bool `json:"notificationAvailable"`
	// An array of original media sources.
	OriginalMediaSources []OriginalMediaSource `json:"originalMediaSources"`
	// An array of terms and conditions URLs provided by the software vendor.
	OriginalTermsAndConditions []string `json:"originalTermsAndConditions"`
	// Entity that signed the final package.
	PackageSigningIdentity string `json:"packageSigningIdentity"`
	// Publisher name.
	Publisher string `json:"publisher"`
	// Application version string visible on device.
	ShortVersion string `json:"shortVersion"`
	// Package size in bytes.
	SizeInBytes int `json:"sizeInBytes"`
	// If auto update of the App Title are suppressed.
	SuppressAutoUpdate bool `json:"suppressAutoUpdate"`
	// Human readable name of the application.
	TitleName string `json:"titleName"`
	// Version.
	Version string `json:"version"`
}

AppTitleDetails represents a app title details.

type AppTitleDetailsMediaSourceType 

type AppTitleDetailsMediaSourceType = string

AppTitleDetailsMediaSourceType is the set of values accepted by AppTitleDetails.MediaSourceType. 

const (
	AppTitleDetailsMediaSourceTypeExternalURL AppTitleDetailsMediaSourceType = "EXTERNAL_URL"
	AppTitleDetailsMediaSourceTypeJamfServer  AppTitleDetailsMediaSourceType = "JAMF_SERVER"
)

AppTitleDetailsMediaSourceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleDetailsMediaSourceTypeValues 

func AppTitleDetailsMediaSourceTypeValues() []AppTitleDetailsMediaSourceType

AppTitleDetailsMediaSourceTypeValues returns every value the Jamf API accepts for AppTitleDetailsMediaSourceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleVersion 

type AppTitleVersion struct {
	// App Installer version.
	Version *string `json:"version,omitempty"`
}

AppTitleVersion represents a app title version.

type AppTitleVersionAndMediaSourceType 

type AppTitleVersionAndMediaSourceType struct {
	// Indication on the source which app is downloaded from Values: - **EXTERNAL_URL** - app is downloaded
	// from external source which usually means vendor site - **JAMF_SERVER** - app is downloaded from JAMF
	// server.
	// Allowed values: see the AppTitleVersionAndMediaSourceTypeMediaSourceType constants.
	MediaSourceType string `json:"mediaSourceType"`
	// App Installer version.
	Version *string `json:"version,omitempty"`
}

AppTitleVersionAndMediaSourceType represents a app title version and media source type.

type AppTitleVersionAndMediaSourceTypeMediaSourceType 

type AppTitleVersionAndMediaSourceTypeMediaSourceType = string

AppTitleVersionAndMediaSourceTypeMediaSourceType is the set of values accepted by AppTitleVersionAndMediaSourceType.MediaSourceType. 

const (
	AppTitleVersionAndMediaSourceTypeMediaSourceTypeExternalURL AppTitleVersionAndMediaSourceTypeMediaSourceType = "EXTERNAL_URL"
	AppTitleVersionAndMediaSourceTypeMediaSourceTypeJamfServer  AppTitleVersionAndMediaSourceTypeMediaSourceType = "JAMF_SERVER"
)

AppTitleVersionAndMediaSourceTypeMediaSourceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AppTitleVersionAndMediaSourceTypeMediaSourceTypeValues 

func AppTitleVersionAndMediaSourceTypeMediaSourceTypeValues() []AppTitleVersionAndMediaSourceTypeMediaSourceType

AppTitleVersionAndMediaSourceTypeMediaSourceTypeValues returns every value the Jamf API accepts for AppTitleVersionAndMediaSourceTypeMediaSourceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AppTitleVersionsResult 

type AppTitleVersionsResult struct {
	// list of available versions for app installer.
	Results    []AppTitleVersionAndMediaSourceType `json:"results"`
	TotalCount int                                 `json:"totalCount"`
}

AppTitleVersionsResult represents a app title versions result.

type AppTitlesResult 

type AppTitlesResult struct {
	Results    []AppTitle `json:"results"`
	TotalCount int        `json:"totalCount"`
}

AppTitlesResult represents a app titles result.

type AssignRemoveProfileResponseSyncState 

type AssignRemoveProfileResponseSyncState struct {
	FailureCount int    `json:"failureCount"`
	ID           int    `json:"id"`
	ProfileUUID  string `json:"profileUUID"`
	SerialNumber string `json:"serialNumber"`
	SyncStatus   string `json:"syncStatus"`
	Timestamp    int    `json:"timestamp"`
}

AssignRemoveProfileResponseSyncState represents a assign remove profile response sync state.

type Assignment 

type Assignment struct {
	MobileDeviceID *string `json:"mobileDeviceId,omitempty"`
	// If true the device should be added to the group, if false should be removed from the group.
	Selected *bool `json:"selected,omitempty"`
}

Assignment represents a assignment.

type AssignmentDtoV1 

type AssignmentDtoV1 struct {
	DeviceID string `json:"deviceId"`
	Selected bool   `json:"selected"`
}

AssignmentDtoV1 represents a assignment dto v1.

type AvailableOsUpdates 

type AvailableOsUpdates struct {
	AvailableUpdates *AvailableOsUpdatesAvailableUpdates `json:"availableUpdates,omitempty"`
}

AvailableOsUpdates represents a available os updates.

type AvailableOsUpdatesAvailableUpdates 

type AvailableOsUpdatesAvailableUpdates struct {
	IOS   []string `json:"iOS"`
	MacOS []string `json:"macOS"`
}

AvailableOsUpdatesAvailableUpdates represents a available os updates available updates.

type AzureConfiguration 

type AzureConfiguration struct {
	// A Cloud Identity Provider information.
	CloudIDPCommon *CloudIDPCommon `json:"cloudIdPCommon,omitempty"`
	// Azure Cloud Identity Provider configuration.
	Server *AzureServerConfiguration `json:"server,omitempty"`
}

AzureConfiguration A Cloud Identity Provider Azure configuration for responses.

type AzureConfigurationRequest 

type AzureConfigurationRequest struct {
	// A Cloud Identity Provider information for request.
	CloudIDPCommon CloudIDPCommonRequest `json:"cloudIdPCommon"`
	// Azure Cloud Identity Provider configuration request.
	Server AzureServerConfigurationRequest `json:"server"`
}

AzureConfigurationRequest A Cloud Identity Provider Azure configuration for responses.

type AzureConfigurationUpdate 

type AzureConfigurationUpdate struct {
	// A Cloud Identity Provider information.
	CloudIDPCommon CloudIDPCommon `json:"cloudIdPCommon"`
	// Azure Cloud Identity Provider configuration update.
	Server AzureServerConfigurationUpdate `json:"server"`
}

AzureConfigurationUpdate A Cloud Identity Provider Azure configuration for update.

type AzureMappings 

type AzureMappings struct {
	Building   string `json:"building"`
	Department string `json:"department"`
	Email      string `json:"email"`
	GroupID    string `json:"groupId"`
	GroupName  string `json:"groupName"`
	Phone      string `json:"phone"`
	Position   string `json:"position"`
	RealName   string `json:"realName"`
	Room       string `json:"room"`
	UserID     string `json:"userId"`
	UserName   string `json:"userName"`
}

AzureMappings Azure Cloud Identity Provider mappings.

type AzureServerConfiguration 

type AzureServerConfiguration struct {
	DeprecatedConsent bool   `json:"deprecatedConsent"`
	Enabled           bool   `json:"enabled"`
	ID                string `json:"id"`
	// Azure Cloud Identity Provider mappings.
	Mappings *AzureMappings `json:"mappings,omitempty"`
	// Use this field to enable membership calculation optimization. This setting would not apply to Single
	// Sign On.
	MembershipCalculationOptimizationEnabled bool   `json:"membershipCalculationOptimizationEnabled"`
	Migrated                                 bool   `json:"migrated"`
	SearchTimeout                            int    `json:"searchTimeout"`
	TenantID                                 string `json:"tenantId"`
	// Use this field to enable transitive membership lookup. This setting would not apply to Single Sign
	// On.
	TransitiveDirectoryMembershipEnabled bool `json:"transitiveDirectoryMembershipEnabled"`
	// Use this field to enable transitive membership lookup with Single Sign On.
	TransitiveMembershipEnabled bool `json:"transitiveMembershipEnabled"`
	// Use this field to set user field mapping for transitive membership lookup with Single Sign On.
	TransitiveMembershipUserField string `json:"transitiveMembershipUserField"`
	// Type of Entra ID connection.
	// Allowed values: see the AzureServerConfigurationType constants.
	Type string `json:"type"`
}

AzureServerConfiguration Azure Cloud Identity Provider configuration.

type AzureServerConfigurationRequest 

type AzureServerConfigurationRequest struct {
	Code    string  `json:"code"`
	Enabled bool    `json:"enabled"`
	ID      *string `json:"id,omitempty"`
	// Azure Cloud Identity Provider mappings.
	Mappings AzureMappings `json:"mappings"`
	// Use this field to enable membership calculation optimization. This setting would not apply to Single
	// Sign On.
	MembershipCalculationOptimizationEnabled *bool  `json:"membershipCalculationOptimizationEnabled,omitempty"`
	SearchTimeout                            int    `json:"searchTimeout"`
	TenantID                                 string `json:"tenantId"`
	// Use this field to enable transitive membership lookup. This setting would not apply to Single Sign
	// On.
	TransitiveDirectoryMembershipEnabled bool `json:"transitiveDirectoryMembershipEnabled"`
	// Use this field to enable transitive membership lookup with Single Sign On.
	TransitiveMembershipEnabled bool `json:"transitiveMembershipEnabled"`
	// Use this field to set user field mapping for transitive membership lookup with Single Sign On.
	TransitiveMembershipUserField string `json:"transitiveMembershipUserField"`
	// Type of Entra ID connection.
	// Allowed values: see the AzureServerConfigurationRequestType constants.
	Type *string `json:"type,omitempty"`
}

AzureServerConfigurationRequest Azure Cloud Identity Provider configuration request.

type AzureServerConfigurationRequestType 

type AzureServerConfigurationRequestType = string

AzureServerConfigurationRequestType is the set of values accepted by AzureServerConfigurationRequest.Type. 

const (
	AzureServerConfigurationRequestTypePublic  AzureServerConfigurationRequestType = "PUBLIC"
	AzureServerConfigurationRequestTypeGccHigh AzureServerConfigurationRequestType = "GCC_HIGH"
)

AzureServerConfigurationRequestType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AzureServerConfigurationRequestTypeValues 

func AzureServerConfigurationRequestTypeValues() []AzureServerConfigurationRequestType

AzureServerConfigurationRequestTypeValues returns every value the Jamf API accepts for AzureServerConfigurationRequestType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AzureServerConfigurationType 

type AzureServerConfigurationType = string

AzureServerConfigurationType is the set of values accepted by AzureServerConfiguration.Type. 

const (
	AzureServerConfigurationTypePublic  AzureServerConfigurationType = "PUBLIC"
	AzureServerConfigurationTypeGccHigh AzureServerConfigurationType = "GCC_HIGH"
)

AzureServerConfigurationType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func AzureServerConfigurationTypeValues 

func AzureServerConfigurationTypeValues() []AzureServerConfigurationType

AzureServerConfigurationTypeValues returns every value the Jamf API accepts for AzureServerConfigurationType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type AzureServerConfigurationUpdate 

type AzureServerConfigurationUpdate struct {
	Enabled bool   `json:"enabled"`
	ID      string `json:"id"`
	// Azure Cloud Identity Provider mappings.
	Mappings AzureMappings `json:"mappings"`
	// Use this field to enable membership calculation optimization. This setting would not apply to Single
	// Sign On.
	MembershipCalculationOptimizationEnabled *bool `json:"membershipCalculationOptimizationEnabled,omitempty"`
	SearchTimeout                            int   `json:"searchTimeout"`
	// Use this field to enable transitive membership lookup. This setting would not apply to Single Sign
	// On.
	TransitiveDirectoryMembershipEnabled bool `json:"transitiveDirectoryMembershipEnabled"`
	// Use this field to enable transitive membership lookup with Single Sign On.
	TransitiveMembershipEnabled bool `json:"transitiveMembershipEnabled"`
	// Use this field to set user field mapping for transitive membership lookup with Single Sign On.
	TransitiveMembershipUserField string `json:"transitiveMembershipUserField"`
}

AzureServerConfigurationUpdate Azure Cloud Identity Provider configuration update.

type BlankPushRequest 

type BlankPushRequest struct {
	ClientManagementIds []string `json:"clientManagementIds"`
}

BlankPushRequest represents a blank push request.

type BlankPushResponse 

type BlankPushResponse struct {
	ErrorUuids []string `json:"errorUuids"`
}

BlankPushResponse represents a blank push response.

type BrandingImageURL 

type BrandingImageURL struct {
	URL string `json:"url"`
}

BrandingImageURL represents a branding image u r l.

type Building 

type Building struct {
	City           *string `json:"city,omitempty"`
	Country        *string `json:"country,omitempty"`
	ID             *string `json:"id,omitempty"`
	Name           string  `json:"name"`
	StateProvince  *string `json:"stateProvince,omitempty"`
	StreetAddress1 *string `json:"streetAddress1,omitempty"`
	StreetAddress2 *string `json:"streetAddress2,omitempty"`
	ZipPostalCode  *string `json:"zipPostalCode,omitempty"`
}

Building represents a building.

type BuildingSearchResults 

type BuildingSearchResults struct {
	Results    []Building `json:"results"`
	TotalCount int        `json:"totalCount"`
}

BuildingSearchResults represents a building search results.

type CacheSettings 

type CacheSettings struct {
	CacheType string `json:"cacheType"`
	// The default is for Jamf Pro to generate a UUID, so we can only give an example instead.
	CacheUniqueID              string               `json:"cacheUniqueId"`
	DirectoryTimeToLiveSeconds *int                 `json:"directoryTimeToLiveSeconds,omitempty"`
	EhcacheMaxBytesLocalHeap   *string              `json:"ehcacheMaxBytesLocalHeap,omitempty"`
	Elasticache                *bool                `json:"elasticache,omitempty"`
	ID                         *string              `json:"id,omitempty"`
	MemcachedEndpoints         []MemcachedEndpoints `json:"memcachedEndpoints"`
	Name                       *string              `json:"name,omitempty"`
	TimeToIdleSeconds          *int                 `json:"timeToIdleSeconds,omitempty"`
	TimeToLiveSeconds          int                  `json:"timeToLiveSeconds"`
}

CacheSettings represents a cache settings.

type CategoriesSearchResults 

type CategoriesSearchResults struct {
	Results    []Category `json:"results"`
	TotalCount int        `json:"totalCount"`
}

CategoriesSearchResults represents a categories search results.

type Category 

type Category struct {
	ID       *string `json:"id,omitempty"`
	Name     string  `json:"name"`
	Priority int     `json:"priority"`
}

Category represents a category.

type CeaTemplatesResults 

type CeaTemplatesResults struct {
	Results    []ComputerExtensionAttributeTemplates `json:"results"`
	TotalCount int                                   `json:"totalCount"`
}

CeaTemplatesResults represents a cea templates results.

type Certificate 

type Certificate struct {
	// Must be base-64 encoded data obtainable by `openssl base64 < /file/path/filename.p12 | tr -d '\n' |
	// pbcopy` in linux terminal, or similar parsing methods.
	Data []byte `json:"data"`
	// Client certificate filename should extend .p12.
	Filename string `json:"filename"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password *string `json:"password,omitempty"`
}

Certificate represents a certificate.

type CertificateDetails 

type CertificateDetails struct {
	SerialNumber *string `json:"serialNumber,omitempty"`
	Subject      *string `json:"subject,omitempty"`
}

CertificateDetails represents a certificate details.

type CertificateIdentityV2 

type CertificateIdentityV2 struct {
	Filename *string `json:"filename,omitempty"`
	// The base 64 encoded certificate.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	IdentityKeystore *[]byte `json:"identityKeystore,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	KeystorePassword *string `json:"keystorePassword,omitempty"`
	// The md5 checksum of the certificate file. Intended to be used in verification the cert being used to
	// sign QuickAdd packages.
	Md5Sum *string `json:"md5Sum,omitempty"`
}

CertificateIdentityV2 represents a certificate identity v2.

type CertificateKey 

type CertificateKey struct {
	ID    *string `json:"id,omitempty"`
	Valid *bool   `json:"valid,omitempty"`
}

CertificateKey represents a certificate key.

type CertificateRecord 

type CertificateRecord struct {
	IssuerX500Principal  string     `json:"issuerX500Principal"`
	KeyUsage             []string   `json:"keyUsage"`
	KeyUsageExtended     []string   `json:"keyUsageExtended"`
	NotAfter             int        `json:"notAfter"`
	NotBefore            int        `json:"notBefore"`
	SerialNumber         string     `json:"serialNumber"`
	Sha1Fingerprint      string     `json:"sha1Fingerprint"`
	Sha256Fingerprint    string     `json:"sha256Fingerprint"`
	Signature            *Signature `json:"signature,omitempty"`
	SubjectX500Principal string     `json:"subjectX500Principal"`
	Version              int        `json:"version"`
}

CertificateRecord represents a certificate record.

type CertificateResponse 

type CertificateResponse struct {
	ExpirationDate *string `json:"expirationDate"`
	// Client certificate filename with .p12 extension.
	Filename     string `json:"filename"`
	Issuer       string `json:"issuer"`
	SerialNumber string `json:"serialNumber"`
	Subject      string `json:"subject"`
}

CertificateResponse represents a certificate response.

type ChangePassword 

type ChangePassword struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	CurrentPassword string `json:"currentPassword"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	NewPassword string `json:"newPassword"`
}

ChangePassword represents a change password.

type ClassicLdapMappings 

type ClassicLdapMappings struct {
	UserGroupObjectMapGroupNameTo string `json:"userGroupObjectMapGroupNameTo"`
	UserGroupObjectMapIDTo        string `json:"userGroupObjectMapIdTo"`
	UserGroupObjectMapUUIDTo      string `json:"userGroupObjectMapUuidTo"`
	UserObjectMapBuildingTo       string `json:"userObjectMapBuildingTo"`
	UserObjectMapDepartmentTo     string `json:"userObjectMapDepartmentTo"`
	UserObjectMapEmailTo          string `json:"userObjectMapEmailTo"`
	UserObjectMapIDTo             string `json:"userObjectMapIdTo"`
	UserObjectMapPhoneTo          string `json:"userObjectMapPhoneTo"`
	UserObjectMapPositionTo       string `json:"userObjectMapPositionTo"`
	UserObjectMapRealNameTo       string `json:"userObjectMapRealNameTo"`
	UserObjectMapRoomTo           string `json:"userObjectMapRoomTo"`
	UserObjectMapUsernameTo       string `json:"userObjectMapUsernameTo"`
	UserObjectMapUUIDTo           string `json:"userObjectMapUuidTo"`
}

ClassicLdapMappings Classic Ldap mappings configuration.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides typed methods for pro operations.

func New 

func New(base *jamfplatform.Client) *Client

New creates a pro client that shares the authenticated transport of the given root client.

func (*Client) AbandonManagedSoftwareUpdateFeatureToggleV1 

func (c *Client) AbandonManagedSoftwareUpdateFeatureToggleV1(ctx context.Context) error

AbandonManagedSoftwareUpdateFeatureToggleV1 force stops any ongoing or stalled feature-toggle processes.

Required privileges: managed-software-updates:create, managed-software-updates:read, managed-software-updates:update. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Create Managed Software Updates, Update Managed Software Updates. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) AcceptPatchManagementDisclaimerV2 

func (c *Client) AcceptPatchManagementDisclaimerV2(ctx context.Context) error

AcceptPatchManagementDisclaimerV2 accept Patch Management disclaimer.

Required privileges: patch-management-software-titles:update. Legacy Jamf Pro privilege name(s): Update Patch Management Software Titles.

func (*Client) AcceptSlasaV1 

func (c *Client) AcceptSlasaV1(ctx context.Context) error

AcceptSlasaV1 accept the SLASA.

Required privileges: activation-code:update, jss-information:read. Legacy Jamf Pro privilege name(s): Update License Information, View JSS Information. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) AddPatchPolicyToDashboardV2 

func (c *Client) AddPatchPolicyToDashboardV2(ctx context.Context, id string) error

AddPatchPolicyToDashboardV2 add a patch policy to the dashboard.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.

func (*Client) AddPatchSoftwareTitleToDashboardV3 

func (c *Client) AddPatchSoftwareTitleToDashboardV3(ctx context.Context, id string) error

AddPatchSoftwareTitleToDashboardV3 add a software title configuration to the dashboard.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: software title configuration id.

func (*Client) AddToComputerPrestageScopeV2 

func (c *Client) AddToComputerPrestageScopeV2(ctx context.Context, id string, request *PrestageScopeUpdate) (*PrestageScopeResponseV2, error)

AddToComputerPrestageScopeV2 add device Scope for a specific Computer Prestage.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) AddToMobileDevicePrestageScopeV2 

func (c *Client) AddToMobileDevicePrestageScopeV2(ctx context.Context, id string, request *PrestageScopeUpdate) (*PrestageScopeResponseV2, error)

AddToMobileDevicePrestageScopeV2 add Device Scope for a specific Mobile Device Prestage.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) ApplyAdvancedMobileDeviceSearchV1 

func (c *Client) ApplyAdvancedMobileDeviceSearchV1(ctx context.Context, request *AdvancedSearch) (string, bool, error)

ApplyAdvancedMobileDeviceSearchV1 creates or updates a AdvancedMobileDeviceSearchV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyAdvancedUserContentSearchV1 

func (c *Client) ApplyAdvancedUserContentSearchV1(ctx context.Context, request *AdvancedUserContentSearch) (string, bool, error)

ApplyAdvancedUserContentSearchV1 creates or updates a AdvancedUserContentSearchV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyAppRequestFormInputFieldV1 

func (c *Client) ApplyAppRequestFormInputFieldV1(ctx context.Context, request *AppRequestFormInputField) (string, bool, error)

ApplyAppRequestFormInputFieldV1 creates or updates a AppRequestFormInputFieldV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyBuildingV1 

func (c *Client) ApplyBuildingV1(ctx context.Context, request *Building) (string, bool, error)

ApplyBuildingV1 creates or updates a BuildingV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyCategoryV1 

func (c *Client) ApplyCategoryV1(ctx context.Context, request *Category) (string, bool, error)

ApplyCategoryV1 creates or updates a CategoryV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyComputerExtensionAttributeV1 

func (c *Client) ApplyComputerExtensionAttributeV1(ctx context.Context, request *ComputerExtensionAttributes) (string, bool, error)

ApplyComputerExtensionAttributeV1 creates or updates a ComputerExtensionAttributeV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyComputerPrestageV3 

func (c *Client) ApplyComputerPrestageV3(ctx context.Context, request *PostComputerPrestageV3) (string, bool, error)

ApplyComputerPrestageV3 creates or updates a ComputerPrestageV3 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyDepartmentV1 

func (c *Client) ApplyDepartmentV1(ctx context.Context, request *Department) (string, bool, error)

ApplyDepartmentV1 creates or updates a DepartmentV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyDeviceEnrollmentV1 

func (c *Client) ApplyDeviceEnrollmentV1(ctx context.Context, request *DeviceEnrollmentInstance, token string) (string, bool, error)

ApplyDeviceEnrollmentV1 creates or updates a DeviceEnrollmentV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyDistributionPointV1 

func (c *Client) ApplyDistributionPointV1(ctx context.Context, request *DistributionPoint) (string, bool, error)

ApplyDistributionPointV1 creates or updates a DistributionPointV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyEnrollmentAccessGroupV3 

func (c *Client) ApplyEnrollmentAccessGroupV3(ctx context.Context, request *EnrollmentAccessGroupPreview) (string, bool, error)

ApplyEnrollmentAccessGroupV3 creates or updates a EnrollmentAccessGroupV3 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyEnrollmentCustomizationV2 

func (c *Client) ApplyEnrollmentCustomizationV2(ctx context.Context, request *EnrollmentCustomizationV2) (string, bool, error)

ApplyEnrollmentCustomizationV2 creates or updates a EnrollmentCustomizationV2 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyIOSBrandingConfigurationV1 

func (c *Client) ApplyIOSBrandingConfigurationV1(ctx context.Context, request *IosBrandingConfiguration) (string, bool, error)

ApplyIOSBrandingConfigurationV1 creates or updates a IOSBrandingConfigurationV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyInventoryPreloadRecordV2 

func (c *Client) ApplyInventoryPreloadRecordV2(ctx context.Context, request *InventoryPreloadRecordV2) (string, bool, error)

ApplyInventoryPreloadRecordV2 creates or updates a InventoryPreloadRecordV2 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyMacOSBrandingConfigurationV1 

func (c *Client) ApplyMacOSBrandingConfigurationV1(ctx context.Context, request *MacOsBrandingConfiguration) (string, bool, error)

ApplyMacOSBrandingConfigurationV1 creates or updates a MacOSBrandingConfigurationV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyMobileDeviceExtensionAttributeV1 

func (c *Client) ApplyMobileDeviceExtensionAttributeV1(ctx context.Context, request *MobileDeviceExtensionAttributes) (string, bool, error)

ApplyMobileDeviceExtensionAttributeV1 creates or updates a MobileDeviceExtensionAttributeV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyMobileDevicePrestageV3 

func (c *Client) ApplyMobileDevicePrestageV3(ctx context.Context, request *MobileDevicePrestageV3) (string, bool, error)

ApplyMobileDevicePrestageV3 creates or updates a MobileDevicePrestageV3 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyPackageV1 

func (c *Client) ApplyPackageV1(ctx context.Context, request *Package) (string, bool, error)

ApplyPackageV1 creates or updates a PackageV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyPatchSoftwareTitleConfigurationV3 

func (c *Client) ApplyPatchSoftwareTitleConfigurationV3(ctx context.Context, request *PatchSoftwareTitleConfigurationBase) (string, bool, error)

ApplyPatchSoftwareTitleConfigurationV3 creates or updates a PatchSoftwareTitleConfigurationV3 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyReturnToServiceConfigurationV1 

func (c *Client) ApplyReturnToServiceConfigurationV1(ctx context.Context, request *ReturnToServiceConfigurationRequest) (string, bool, error)

ApplyReturnToServiceConfigurationV1 creates or updates a ReturnToServiceConfigurationV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyScriptV1 

func (c *Client) ApplyScriptV1(ctx context.Context, request *Script) (string, bool, error)

ApplyScriptV1 creates or updates a ScriptV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplySmartComputerGroupV3 

func (c *Client) ApplySmartComputerGroupV3(ctx context.Context, request *SmartComputerGroupV3, platform bool) (string, bool, error)

ApplySmartComputerGroupV3 creates or updates a SmartComputerGroupV3 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplySmartMobileDeviceGroupV2 

func (c *Client) ApplySmartMobileDeviceGroupV2(ctx context.Context, request *SmartGroupAssignmentV2, platform bool) (string, bool, error)

ApplySmartMobileDeviceGroupV2 creates or updates a SmartMobileDeviceGroupV2 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyStaticComputerGroupV3 

func (c *Client) ApplyStaticComputerGroupV3(ctx context.Context, request *StaticComputerGroupAssignment, platform bool) (string, bool, error)

ApplyStaticComputerGroupV3 creates or updates a StaticComputerGroupV3 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyStaticMobileDeviceGroupV2 

func (c *Client) ApplyStaticMobileDeviceGroupV2(ctx context.Context, request *StaticGroupAssignment, platform bool) (string, bool, error)

ApplyStaticMobileDeviceGroupV2 creates or updates a StaticMobileDeviceGroupV2 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplySupervisionIdentityV1 

func (c *Client) ApplySupervisionIdentityV1(ctx context.Context, request *SupervisionIdentityCreate) (string, bool, error)

ApplySupervisionIdentityV1 creates or updates a SupervisionIdentityV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyUserV1 

func (c *Client) ApplyUserV1(ctx context.Context, request *UserInventory, platform bool) (string, bool, error)

ApplyUserV1 creates or updates a UserV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyVolumePurchasingLocationV1 

func (c *Client) ApplyVolumePurchasingLocationV1(ctx context.Context, request *VolumePurchasingLocationPost) (string, bool, error)

ApplyVolumePurchasingLocationV1 creates or updates a VolumePurchasingLocationV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ApplyVolumePurchasingSubscriptionV1 

func (c *Client) ApplyVolumePurchasingSubscriptionV1(ctx context.Context, request *VolumePurchasingSubscriptionBase) (string, bool, error)

ApplyVolumePurchasingSubscriptionV1 creates or updates a VolumePurchasingSubscriptionV1 by name. If a resource with the specified name exists, it is updated; if not found, a new resource is created. Returns the resource ID, whether it was created (true) or updated (false), and any error. An *AmbiguousMatchError is returned if multiple resources match the name.

func (*Client) ChangeUserPasswordV1 

func (c *Client) ChangeUserPasswordV1(ctx context.Context, request *ChangePassword) error

ChangeUserPasswordV1 changes the user account password.

This endpoint is rate-limited. The transport automatically retries a 429 with backoff (honoring a server-supplied Retry-After when present, clamped to a ceiling), giving up only after exhausting its retry budget — at which point the 429 surfaces as an APIResponseError so the caller can apply its own backoff policy.

Required privileges: change-password:execute. Legacy Jamf Pro privilege name(s): Change Password.

func (*Client) CheckDigicertTrustLifecycleManagerPrivilegesV1 

func (c *Client) CheckDigicertTrustLifecycleManagerPrivilegesV1(ctx context.Context, id string) error

CheckDigicertTrustLifecycleManagerPrivilegesV1 check DigiCert account permissions for certificate deployment.

Required privileges: digicert-settings:read. Legacy Jamf Pro privilege name(s): Read DigiCert Settings.

Parameters:

  • id: ID of the DigiCert Trust Lifecycle Manager settings.

func (*Client) CloseTeamViewerSessionPreview 

func (c *Client) CloseTeamViewerSessionPreview(ctx context.Context, configurationID string, sessionID string) error

CloseTeamViewerSessionPreview close a session.

Required privileges: remote-administration:update. Legacy Jamf Pro privilege name(s): Update Remote Administration.

Parameters:

  • configurationID: ID of the Team Viewer connection configuration.
  • sessionID: ID of the Team Viewer session.

func (*Client) CreateAccountV1 

func (c *Client) CreateAccountV1(ctx context.Context, request *UserAccount) (*UserAccount, error)

CreateAccountV1 adds new account.

Required privileges: accounts:create. Legacy Jamf Pro privilege name(s): Create Accounts.

func (*Client) CreateActivationCodeHistoryNoteV1 

func (c *Client) CreateActivationCodeHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateActivationCodeHistoryNoteV1 add Activation Code object note.

Required privileges: activation-code:update. Legacy Jamf Pro privilege name(s): Update License Information.

func (*Client) CreateAdcsSettingsHistoryNoteV1 

func (c *Client) CreateAdcsSettingsHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreateAdcsSettingsHistoryNoteV1 add specified AD CS Settings object note.

Required privileges: ad-cs-settings:update. Legacy Jamf Pro privilege name(s): Update AD CS Settings.

Parameters:

  • id: Instance ID of AD CS Settings history record.

func (*Client) CreateAdcsSettingsV1 

func (c *Client) CreateAdcsSettingsV1(ctx context.Context, request *AdcsSettings) (*HrefResponse, error)

CreateAdcsSettingsV1 create AD CS Settings configuration for either inbound or outbound mode.

Required privileges: ad-cs-settings:create. Legacy Jamf Pro privilege name(s): Create AD CS Settings.

func (*Client) CreateAdvancedMobileDeviceSearchV1 

func (c *Client) CreateAdvancedMobileDeviceSearchV1(ctx context.Context, request *AdvancedSearch) (*HrefResponse, error)

CreateAdvancedMobileDeviceSearchV1 create Advanced Search object.

Required privileges: advanced-device-searches:create. Legacy Jamf Pro privilege name(s): Create Advanced Mobile Device Searches.

func (*Client) CreateAdvancedUserContentSearchV1 

func (c *Client) CreateAdvancedUserContentSearchV1(ctx context.Context, request *AdvancedUserContentSearch) (*HrefResponse, error)

CreateAdvancedUserContentSearchV1 create Advanced User Content Search object.

Required privileges: advanced-user-searches:create. Legacy Jamf Pro privilege name(s): Create Advanced User Content Searches.

func (*Client) CreateAppInstallerDeploymentHistoryNoteV1 

func (c *Client) CreateAppInstallerDeploymentHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateAppInstallerDeploymentHistoryNoteV1 add specified App Installer deployment history object notes.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

Parameters:

  • id: instance id of App Installer deployment history record.

func (*Client) CreateAppInstallerDeploymentV1 

func (c *Client) CreateAppInstallerDeploymentV1(ctx context.Context, request *AppTitleDeployment) (*HrefResponse, error)

CreateAppInstallerDeploymentV1 create a new App Installer deployment.

Required privileges: applications:create. Legacy Jamf Pro privilege name(s): Create Mac Applications.

func (*Client) CreateAppInstallerGlobalSettingsHistoryNoteV1 

func (c *Client) CreateAppInstallerGlobalSettingsHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateAppInstallerGlobalSettingsHistoryNoteV1 add App Installer global settings history object note.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

func (*Client) CreateAppRequestFormInputFieldV1 

func (c *Client) CreateAppRequestFormInputFieldV1(ctx context.Context, request *AppRequestFormInputField) (*AppRequestFormInputField, error)

CreateAppRequestFormInputFieldV1 create Form Input Field record.

Required privileges: app-request:update. Legacy Jamf Pro privilege name(s): Update App Request Settings.

func (*Client) CreateBuildingHistoryNoteV1 

func (c *Client) CreateBuildingHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateBuildingHistoryNoteV1 add specified Building history object notes.

Required privileges: buildings:update. Legacy Jamf Pro privilege name(s): Update Buildings.

Parameters:

  • id: instance id of building history record.

func (*Client) CreateBuildingV1 

func (c *Client) CreateBuildingV1(ctx context.Context, request *Building) (*HrefResponse, error)

CreateBuildingV1 create Building record.

Required privileges: buildings:create. Legacy Jamf Pro privilege name(s): Create Buildings.

func (*Client) CreateCategoryHistoryNoteV1 

func (c *Client) CreateCategoryHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateCategoryHistoryNoteV1 add specified Category history object notes.

Required privileges: categories:update. Legacy Jamf Pro privilege name(s): Update Categories.

Parameters:

  • id: instance id of category history record.

func (*Client) CreateCategoryV1 

func (c *Client) CreateCategoryV1(ctx context.Context, request *Category) (*HrefResponse, error)

CreateCategoryV1 create Category record.

Required privileges: categories:create. Legacy Jamf Pro privilege name(s): Create Categories.

func (*Client) CreateCheckInHistoryNoteV3 

func (c *Client) CreateCheckInHistoryNoteV3(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateCheckInHistoryNoteV3 add a Note to Client Check-In History.

Required privileges: computer-check-in:update. Legacy Jamf Pro privilege name(s): Update Computer Check-In.

func (*Client) CreateCloudAzureV1 

func (c *Client) CreateCloudAzureV1(ctx context.Context, request *AzureConfigurationRequest) (*HrefResponse, error)

CreateCloudAzureV1 create Azure Cloud Identity Provider configuration.

Required privileges: ldap-servers:create. Legacy Jamf Pro privilege name(s): Create LDAP Servers.

func (*Client) CreateCloudDistributionPointHistoryNoteV1 

func (c *Client) CreateCloudDistributionPointHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateCloudDistributionPointHistoryNoteV1 add specified cloud distribution point history object notes.

Required privileges: cloud-distribution-point:update. Legacy Jamf Pro privilege name(s): Update Cloud Distribution Point.

func (*Client) CreateCloudDistributionPointV1 

func (c *Client) CreateCloudDistributionPointV1(ctx context.Context, request *CloudDistributionPoint) (*CloudDistributionPoint, error)

CreateCloudDistributionPointV1 create cloud distribution point.

Required privileges: cloud-distribution-point:update. Legacy Jamf Pro privilege name(s): Update Cloud Distribution Point.

func (*Client) CreateCloudIdpHistoryNoteV1 

func (c *Client) CreateCloudIdpHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateCloudIdpHistoryNoteV1 add Cloud Identity Provider history note.

Required privileges: ldap-servers:update. Legacy Jamf Pro privilege name(s): Update LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) CreateCloudLdapV2 

func (c *Client) CreateCloudLdapV2(ctx context.Context, request *LdapConfigurationRequest) (*HrefResponse, error)

CreateCloudLdapV2 create Cloud Identity Provider configuration.

Required privileges: ldap-servers:create. Legacy Jamf Pro privilege name(s): Create LDAP Servers.

func (*Client) CreateComputerExtensionAttributeHistoryNoteV1 

func (c *Client) CreateComputerExtensionAttributeHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateComputerExtensionAttributeHistoryNoteV1 add specified Computer Extension Attribute history object notes.

Required privileges: extension-attributes:update. Legacy Jamf Pro privilege name(s): Update Computer Extension Attributes.

Parameters:

  • id: Instance ID of Computer Extension Attribute history.

func (*Client) CreateComputerExtensionAttributeV1 

func (c *Client) CreateComputerExtensionAttributeV1(ctx context.Context, request *ComputerExtensionAttributes) (*HrefResponse, error)

CreateComputerExtensionAttributeV1 create Computer Extension Attribute.

Required privileges: extension-attributes:create. Legacy Jamf Pro privilege name(s): Create Computer Extension Attributes.

func (*Client) CreateComputerInventoryCollectionCustomPathV2 

func (c *Client) CreateComputerInventoryCollectionCustomPathV2(ctx context.Context, request *CreatePathV2) (*HrefResponse, error)

CreateComputerInventoryCollectionCustomPathV2 create Computer Inventory Collection Settings Custom Path.

Required privileges: custom-paths:create. Legacy Jamf Pro privilege name(s): Create Custom Paths.

func (*Client) CreateComputerInventoryV3 deprecated 

func (c *Client) CreateComputerInventoryV3(ctx context.Context, request *ComputerInventoryCreateRequestV2) (*HrefResponse, error)

CreateComputerInventoryV3 create Computer Inventory record.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:create. Legacy Jamf Pro privilege name(s): Create Computers.

func (*Client) CreateComputerInventoryV4 

func (c *Client) CreateComputerInventoryV4(ctx context.Context, request *ComputerInventoryCreateRequestV4) (*HrefResponse, error)

CreateComputerInventoryV4 create Computer Inventory record.

Required privileges: devices:create. Legacy Jamf Pro privilege name(s): Create Computers.

func (*Client) CreateComputerPrestageV3 

func (c *Client) CreateComputerPrestageV3(ctx context.Context, request *PostComputerPrestageV3) (*HrefResponse, error)

CreateComputerPrestageV3 create a Computer Prestage.

Required privileges: prestage-enrollments:create. Legacy Jamf Pro privilege name(s): Create Computer PreStage Enrollments.

func (*Client) CreateDepartmentHistoryNoteV1 

func (c *Client) CreateDepartmentHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreateDepartmentHistoryNoteV1 add specified Department history object notes.

Required privileges: departments:update. Legacy Jamf Pro privilege name(s): Update Departments.

Parameters:

  • id: instance id of department history record.

func (*Client) CreateDepartmentV1 

func (c *Client) CreateDepartmentV1(ctx context.Context, request *Department) (*HrefResponse, error)

CreateDepartmentV1 create department record.

Required privileges: departments:create. Legacy Jamf Pro privilege name(s): Create Departments.

func (*Client) CreateDeviceCommunicationSettingsHistoryNoteV1 

func (c *Client) CreateDeviceCommunicationSettingsHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateDeviceCommunicationSettingsHistoryNoteV1 add Device Communication Settings history notes.

Required privileges: mdm-profile-renewal-settings:update. Legacy Jamf Pro privilege name(s): Update Automatically Renew MDM Profile Settings.

func (*Client) CreateDeviceEnrollmentHistoryNoteV1 

func (c *Client) CreateDeviceEnrollmentHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreateDeviceEnrollmentHistoryNoteV1 add Device Enrollment history object notes.

Required privileges: device-enrollment-program-instances:update. Legacy Jamf Pro privilege name(s): Update Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) CreateDigicertTrustLifecycleManagerV1 

func (c *Client) CreateDigicertTrustLifecycleManagerV1(ctx context.Context, request *DigiCertSetting) (*HrefResponse, error)

CreateDigicertTrustLifecycleManagerV1 create DigiCert Trust Lifecycle Manager configuration with client authentication via client certificate.

Required privileges: digicert-settings:create. Legacy Jamf Pro privilege name(s): Create DigiCert Settings.

func (*Client) CreateDistributionPointHistoryNoteV1 

func (c *Client) CreateDistributionPointHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateDistributionPointHistoryNoteV1 add specified distribution point History object notes.

Required privileges: distribution-points:update. Legacy Jamf Pro privilege name(s): Update Distribution Points.

Parameters:

  • id: Instance id of distribution point history.

func (*Client) CreateDistributionPointV1 

func (c *Client) CreateDistributionPointV1(ctx context.Context, request *DistributionPoint) (*HrefResponse, error)

CreateDistributionPointV1 create distribution point.

Required privileges: distribution-points:create. Legacy Jamf Pro privilege name(s): Create Distribution Points.

func (*Client) CreateDockItemV1 

func (c *Client) CreateDockItemV1(ctx context.Context, request *DockItem) (*HrefResponse, error)

CreateDockItemV1 create a DockItem.

Required privileges: dock-items:create. Legacy Jamf Pro privilege name(s): Create Dock Items.

func (*Client) CreateEnrollmentAccessGroupV3 

func (c *Client) CreateEnrollmentAccessGroupV3(ctx context.Context, request *EnrollmentAccessGroupPreview) (*HrefResponse, error)

CreateEnrollmentAccessGroupV3 add the configured LDAP group for User-Initiated Enrollment.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

func (*Client) CreateEnrollmentCustomizationHistoryNoteV2 

func (c *Client) CreateEnrollmentCustomizationHistoryNoteV2(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateEnrollmentCustomizationHistoryNoteV2 add Enrollment Customization history object notes.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) CreateEnrollmentCustomizationLdapPanelV1 

func (c *Client) CreateEnrollmentCustomizationLdapPanelV1(ctx context.Context, id string, request *EnrollmentCustomizationPanelLdapAuth) (*GetEnrollmentCustomizationPanelLdapAuth, error)

CreateEnrollmentCustomizationLdapPanelV1 create an LDAP Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) CreateEnrollmentCustomizationSsoPanelV1 

func (c *Client) CreateEnrollmentCustomizationSsoPanelV1(ctx context.Context, id string, request *EnrollmentCustomizationPanelSsoAuth) (*GetEnrollmentCustomizationPanelSsoAuth, error)

CreateEnrollmentCustomizationSsoPanelV1 create an SSO Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) CreateEnrollmentCustomizationTextPanelV1 

func (c *Client) CreateEnrollmentCustomizationTextPanelV1(ctx context.Context, id string, request *EnrollmentCustomizationPanelText) (*GetEnrollmentCustomizationPanelText, error)

CreateEnrollmentCustomizationTextPanelV1 create a Text Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) CreateEnrollmentCustomizationV2 

func (c *Client) CreateEnrollmentCustomizationV2(ctx context.Context, request *EnrollmentCustomizationV2) (*HrefResponse, error)

CreateEnrollmentCustomizationV2 create an Enrollment Customization.

Required privileges: enrollment-customization:create. Legacy Jamf Pro privilege name(s): Create Enrollment Customizations.

func (*Client) CreateEnrollmentHistoryNoteV2 

func (c *Client) CreateEnrollmentHistoryNoteV2(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateEnrollmentHistoryNoteV2 add Enrollment history object notes.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

func (*Client) CreateGSXConnectionHistoryNoteV1 

func (c *Client) CreateGSXConnectionHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateGSXConnectionHistoryNoteV1 add specified GSX Connection history object notes.

Required privileges: gsx-connection:update. Legacy Jamf Pro privilege name(s): Update GSX Connection.

func (*Client) CreateIOSBrandingConfigurationV1 

func (c *Client) CreateIOSBrandingConfigurationV1(ctx context.Context, request *IosBrandingConfiguration) (*HrefResponse, error)

CreateIOSBrandingConfigurationV1 create a Self Service iOS branding configuration with the supplied.

Required privileges: self-service:create. Legacy Jamf Pro privilege name(s): Create Self Service Branding Configuration.

func (*Client) CreateInventoryPreloadHistoryNoteV2 

func (c *Client) CreateInventoryPreloadHistoryNoteV2(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateInventoryPreloadHistoryNoteV2 add Inventory Preload history object notes.

Required privileges: inventory-preload-records:update. Legacy Jamf Pro privilege name(s): Update Inventory Preload Records.

func (*Client) CreateInventoryPreloadRecordV2 

func (c *Client) CreateInventoryPreloadRecordV2(ctx context.Context, request *InventoryPreloadRecordV2) (*HrefResponse, error)

CreateInventoryPreloadRecordV2 create a new Inventory Preload record using JSON.

Required privileges: inventory-preload-records:create. Legacy Jamf Pro privilege name(s): Create Inventory Preload Records.

func (*Client) CreateJamfConnectHistoryNoteV1 

func (c *Client) CreateJamfConnectHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateJamfConnectHistoryNoteV1 add Jamf Connect history notes.

Required privileges: jamf-connect-deployments:update. Legacy Jamf Pro privilege name(s): Update Jamf Connect Settings.

func (*Client) CreateJamfProServerURLHistoryNoteV1 

func (c *Client) CreateJamfProServerURLHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateJamfProServerURLHistoryNoteV1 add Jamf Pro Server URL settings history notes.

Required privileges: jss-url:update. Legacy Jamf Pro privilege name(s): Update JSS URL.

func (*Client) CreateJamfProtectHistoryNoteV1 

func (c *Client) CreateJamfProtectHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateJamfProtectHistoryNoteV1 add Jamf Protect history notes.

Required privileges: jamf-protect-deployments:update. Legacy Jamf Pro privilege name(s): Update Jamf Protect Settings.

func (*Client) CreateLogFlushingTaskV1 

func (c *Client) CreateLogFlushingTaskV1(ctx context.Context, request *LogFlushingTaskV1) (*HrefResponse, error)

CreateLogFlushingTaskV1 queue a log flushing task.

Required privileges: retention-policy:update. Legacy Jamf Pro privilege name(s): Update Retention Policy.

func (*Client) CreateMacOSBrandingConfigurationV1 

func (c *Client) CreateMacOSBrandingConfigurationV1(ctx context.Context, request *MacOsBrandingConfiguration) (*HrefResponse, error)

CreateMacOSBrandingConfigurationV1 create a Self Service macOS branding configuration with the supplied.

Required privileges: self-service:create. Legacy Jamf Pro privilege name(s): Create Self Service Branding Configuration.

func (*Client) CreateManagedSoftwareUpdateGroupPlanV1 

func (c *Client) CreateManagedSoftwareUpdateGroupPlanV1(ctx context.Context, request *ManagedSoftwareUpdatePlanGroupPost) (*ManagedSoftwareUpdatePlanPostResponse, error)

CreateManagedSoftwareUpdateGroupPlanV1 create Managed Software Update Plans for a Group.

This endpoint is rate-limited. The transport automatically retries a 429 with backoff (honoring a server-supplied Retry-After when present, clamped to a ceiling), giving up only after exhausting its retry budget — at which point the 429 surfaces as an APIResponseError so the caller can apply its own backoff policy.

Required privileges: device-actions:execute, device-groups:read, devices:read, managed-software-updates:create. Legacy Jamf Pro privilege name(s): Create Managed Software Updates, Read Computers, Read Mobile Devices, Read Smart Computer Groups, Read Static Computer Groups, Read Smart Mobile Device Groups, Read Static Mobile Device Groups, Send Computer Remote Command to Download and Install OS X Update, Send Mobile Device Remote Command to Download and Install iOS Update. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) CreateManagedSoftwareUpdatePlanV1 

func (c *Client) CreateManagedSoftwareUpdatePlanV1(ctx context.Context, request *ManagedSoftwareUpdatePlanPost) (*ManagedSoftwareUpdatePlanPostResponse, error)

CreateManagedSoftwareUpdatePlanV1 create a Managed Software Update Plan.

This endpoint is rate-limited. The transport automatically retries a 429 with backoff (honoring a server-supplied Retry-After when present, clamped to a ceiling), giving up only after exhausting its retry budget — at which point the 429 surfaces as an APIResponseError so the caller can apply its own backoff policy.

Required privileges: device-actions:execute, devices:read, managed-software-updates:create. Legacy Jamf Pro privilege name(s): Create Managed Software Updates, Read Computers, Read Mobile Devices, Send Computer Remote Command to Download and Install OS X Update, Send Mobile Device Remote Command to Download and Install iOS Update. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) CreateMobileDeviceExtensionAttributeHistoryNoteV1 

func (c *Client) CreateMobileDeviceExtensionAttributeHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateMobileDeviceExtensionAttributeHistoryNoteV1 add specified Mobile Device Extension Attribute history object notes.

Required privileges: extension-attributes:update. Legacy Jamf Pro privilege name(s): Update Mobile Device Extension Attributes.

Parameters:

  • id: Instance ID of Mobile Device Extension Attribute.

func (*Client) CreateMobileDeviceExtensionAttributeV1 

func (c *Client) CreateMobileDeviceExtensionAttributeV1(ctx context.Context, request *MobileDeviceExtensionAttributes) (*HrefResponse, error)

CreateMobileDeviceExtensionAttributeV1 create Mobile Device Extension Attribute.

Required privileges: extension-attributes:create. Legacy Jamf Pro privilege name(s): Create Mobile Device Extension Attributes.

func (*Client) CreateMobileDevicePrestageHistoryNoteV3 

func (c *Client) CreateMobileDevicePrestageHistoryNoteV3(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreateMobileDevicePrestageHistoryNoteV3 add Mobile Device Prestage history object notes.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) CreateMobileDevicePrestageV3 

func (c *Client) CreateMobileDevicePrestageV3(ctx context.Context, request *MobileDevicePrestageV3) (*HrefResponse, error)

CreateMobileDevicePrestageV3 create a Mobile Device Prestage.

Required privileges: prestage-enrollments:create. Legacy Jamf Pro privilege name(s): Create Mobile Device PreStage Enrollments.

func (*Client) CreateOnboardingHistoryNoteV1 

func (c *Client) CreateOnboardingHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateOnboardingHistoryNoteV1 add Onboarding history object notes.

Required privileges: onboarding:update. Legacy Jamf Pro privilege name(s): Update Onboarding Configuration.

func (*Client) CreatePackageHistoryNoteV1 

func (c *Client) CreatePackageHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreatePackageHistoryNoteV1 add specified Package history object notes.

Required privileges: packages:update. Legacy Jamf Pro privilege name(s): Update Packages.

Parameters:

  • id: Instance ID of package history.

func (*Client) CreatePackageV1 

func (c *Client) CreatePackageV1(ctx context.Context, request *Package) (*HrefResponse, error)

CreatePackageV1 create package.

Required privileges: packages:create. Legacy Jamf Pro privilege name(s): Create Packages.

func (*Client) CreateParentAppHistoryNoteV1 

func (c *Client) CreateParentAppHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateParentAppHistoryNoteV1 add Jamf Parent app settings history notes.

Required privileges: parent-app:update. Legacy Jamf Pro privilege name(s): Update Parent App Settings.

func (*Client) CreatePatchSoftwareTitleConfigurationV3 

func (c *Client) CreatePatchSoftwareTitleConfigurationV3(ctx context.Context, request *PatchSoftwareTitleConfigurationBase) (*HrefResponse, error)

CreatePatchSoftwareTitleConfigurationV3 create Patch Software Title Configurations.

Required privileges: patch-management-software-titles:create. Legacy Jamf Pro privilege name(s): Create Patch Management Software Titles.

func (*Client) CreatePatchSoftwareTitleHistoryNoteV3 

func (c *Client) CreatePatchSoftwareTitleHistoryNoteV3(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreatePatchSoftwareTitleHistoryNoteV3 add Patch Software Title Configuration history object notes.

Required privileges: patch-management-software-titles:update. Legacy Jamf Pro privilege name(s): Update Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configuration Id.

func (*Client) CreateReenrollmentHistoryNoteV1 

func (c *Client) CreateReenrollmentHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateReenrollmentHistoryNoteV1 add specified Re-enrollment history object notes.

Required privileges: re-enrollment:update. Legacy Jamf Pro privilege name(s): Update Re-enrollment.

func (*Client) CreateReturnToServiceConfigurationV1 

func (c *Client) CreateReturnToServiceConfigurationV1(ctx context.Context, request *ReturnToServiceConfigurationRequest) (*HrefResponse, error)

CreateReturnToServiceConfigurationV1 create a Return to Service Configuration.

Required privileges: return-to-service:update. Legacy Jamf Pro privilege name(s): Edit Return To Service Configurations.

func (*Client) CreateScriptHistoryNoteV1 

func (c *Client) CreateScriptHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateScriptHistoryNoteV1 add specified Script history object notes.

Required privileges: scripts:update. Legacy Jamf Pro privilege name(s): Update Scripts.

Parameters:

  • id: instance id of script history record.

func (*Client) CreateScriptV1 

func (c *Client) CreateScriptV1(ctx context.Context, request *Script) (*HrefResponse, error)

CreateScriptV1 create a Script.

Required privileges: scripts:create. Legacy Jamf Pro privilege name(s): Create Scripts.

func (*Client) CreateSelfServiceSettingsHistoryNoteV1 

func (c *Client) CreateSelfServiceSettingsHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateSelfServiceSettingsHistoryNoteV1 add Self Service settings history notes.

Required privileges: self-service:update. Legacy Jamf Pro privilege name(s): Update Self Service.

func (*Client) CreateSmartComputerGroupV3 

func (c *Client) CreateSmartComputerGroupV3(ctx context.Context, request *SmartComputerGroupV3, platform bool) (*HrefResponse, error)

CreateSmartComputerGroupV3 create a Smart Computer Group.

Required privileges: device-groups:create. Legacy Jamf Pro privilege name(s): Create Smart Computer Groups.

Parameters:

  • platform: Optional. Return platform identifiers instead of internal identifiers when set to true.

func (*Client) CreateSmartMobileDeviceGroupV2 

func (c *Client) CreateSmartMobileDeviceGroupV2(ctx context.Context, request *SmartGroupAssignmentV2, platform bool) (*HrefResponse, error)

CreateSmartMobileDeviceGroupV2 create a smart group.

Required privileges: device-groups:create. Legacy Jamf Pro privilege name(s): Create Smart Mobile Device Groups.

Parameters:

  • platform: Optional. Return platform identifiers instead of internal identifiers when set to true.

func (*Client) CreateSmtpServerHistoryNoteV1 

func (c *Client) CreateSmtpServerHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateSmtpServerHistoryNoteV1 add SMTP Server history object notes.

Required privileges: smtp-server:update. Legacy Jamf Pro privilege name(s): Update SMTP Server.

func (*Client) CreateSsoHistoryNoteV3 

func (c *Client) CreateSsoHistoryNoteV3(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateSsoHistoryNoteV3 add SSO history object notes.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) CreateStaticComputerGroupV3 

func (c *Client) CreateStaticComputerGroupV3(ctx context.Context, request *StaticComputerGroupAssignment, platform bool) (*HrefResponse, error)

CreateStaticComputerGroupV3 create membership of a static computer group.

Required privileges: device-groups:create. Legacy Jamf Pro privilege name(s): Create Static Computer Groups.

Parameters:

  • platform: Optional. Return platform identifiers instead of internal identifiers when set to true.

func (*Client) CreateStaticMobileDeviceGroupV2 

func (c *Client) CreateStaticMobileDeviceGroupV2(ctx context.Context, request *StaticGroupAssignment, platform bool) (*HrefResponse, error)

CreateStaticMobileDeviceGroupV2 create a static group.

Required privileges: device-groups:create. Legacy Jamf Pro privilege name(s): Create Static Mobile Device Groups.

Parameters:

  • platform: Optional. Return platform identifiers instead of internal identifiers when set to true.

func (*Client) CreateSupervisionIdentityV1 

func (c *Client) CreateSupervisionIdentityV1(ctx context.Context, request *SupervisionIdentityCreate) (*SupervisionIdentity, error)

CreateSupervisionIdentityV1 create a Supervision Identity for the supplied information.

Required privileges: apple-configurator-enrollment:update. Legacy Jamf Pro privilege name(s): Update Apple Configurator Enrollment.

func (*Client) CreateTeacherAppHistoryNoteV1 

func (c *Client) CreateTeacherAppHistoryNoteV1(ctx context.Context, request *ObjectHistoryNote) (*HrefResponse, error)

CreateTeacherAppHistoryNoteV1 add Jamf Teacher app settings history notes.

Required privileges: teacher-app:update. Legacy Jamf Pro privilege name(s): Update Teacher App Settings.

func (*Client) CreateTeamViewerConfigurationPreview 

func (c *Client) CreateTeamViewerConfigurationPreview(ctx context.Context, request *ConnectionConfigurationCandidateRequest) (*HrefResponse, error)

CreateTeamViewerConfigurationPreview create Team Viewer Remote Administration connection configuration.

Required privileges: remote-administration:create. Legacy Jamf Pro privilege name(s): Create Remote Administration.

func (*Client) CreateTeamViewerSessionPreview 

func (c *Client) CreateTeamViewerSessionPreview(ctx context.Context, configurationID string, request *SessionCandidateRequest) (*HrefResponse, error)

CreateTeamViewerSessionPreview create a new session.

Required privileges: remote-administration:create. Legacy Jamf Pro privilege name(s): Create Remote Administration.

Parameters:

  • configurationID: ID of the Team Viewer connection configuration.

func (*Client) CreateUserV1 

func (c *Client) CreateUserV1(ctx context.Context, request *UserInventory, platform bool) (*HrefResponse, error)

CreateUserV1 create a new user in inventory.

Required privileges: users:create. Legacy Jamf Pro privilege name(s): Create User.

Parameters:

  • platform: Internal platform request indicator.

func (*Client) CreateVenafiHistoryNoteV1 

func (c *Client) CreateVenafiHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreateVenafiHistoryNoteV1 add specified Venafi CA Object Note.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

Parameters:

  • id: instance id of Venafi CA history record.

func (*Client) CreateVenafiV1 

func (c *Client) CreateVenafiV1(ctx context.Context, request *VenafiCaRecord) (*HrefResponse, error)

CreateVenafiV1 create a PKI configuration in Jamf Pro for Venafi.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

func (*Client) CreateVolumePurchasingLocationHistoryNoteV1 

func (c *Client) CreateVolumePurchasingLocationHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*ObjectHistory, error)

CreateVolumePurchasingLocationHistoryNoteV1 add specified Volume Purchasing Location history object notes.

Required privileges: volume-purchasing-locations:update. Legacy Jamf Pro privilege name(s): Update Volume Purchasing Locations.

Parameters:

  • id: instance id of Volume Purchasing Location history record.

func (*Client) CreateVolumePurchasingLocationV1 

func (c *Client) CreateVolumePurchasingLocationV1(ctx context.Context, request *VolumePurchasingLocationPost) (*HrefResponse, error)

CreateVolumePurchasingLocationV1 create a Volume Purchasing Location.

Required privileges: volume-purchasing-locations:create. Legacy Jamf Pro privilege name(s): Create Volume Purchasing Locations.

func (*Client) CreateVolumePurchasingSubscriptionHistoryNoteV1 

func (c *Client) CreateVolumePurchasingSubscriptionHistoryNoteV1(ctx context.Context, id string, request *ObjectHistoryNote) (*HrefResponse, error)

CreateVolumePurchasingSubscriptionHistoryNoteV1 add Volume Purchasing Subscription history object notes.

Required privileges: volume-purchasing-locations:update. Legacy Jamf Pro privilege name(s): Update Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Subscription Id.

func (*Client) CreateVolumePurchasingSubscriptionV1 

func (c *Client) CreateVolumePurchasingSubscriptionV1(ctx context.Context, request *VolumePurchasingSubscriptionBase) (*HrefResponse, error)

CreateVolumePurchasingSubscriptionV1 create a Volume Purchasing Subscription.

Required privileges: volume-purchasing-locations:create. Legacy Jamf Pro privilege name(s): Create Volume Purchasing Locations.

func (*Client) DeleteAccountV1 

func (c *Client) DeleteAccountV1(ctx context.Context, id string) error

DeleteAccountV1 deletes the user account.

Required privileges: accounts:delete. Legacy Jamf Pro privilege name(s): Delete Accounts.

Parameters:

  • id: id of target account.

func (*Client) DeleteAdcsSettingsV1 

func (c *Client) DeleteAdcsSettingsV1(ctx context.Context, id string) error

DeleteAdcsSettingsV1 delete AD CS Settings configuration by ID.

Required privileges: ad-cs-settings:delete. Legacy Jamf Pro privilege name(s): Delete AD CS Settings.

Parameters:

  • id: ID of the AD CS Settings configuration.

func (*Client) DeleteAdvancedMobileDeviceSearchV1 

func (c *Client) DeleteAdvancedMobileDeviceSearchV1(ctx context.Context, id string) error

DeleteAdvancedMobileDeviceSearchV1 remove specified Advanced Search object.

Required privileges: advanced-device-searches:delete. Legacy Jamf Pro privilege name(s): Delete Advanced Mobile Device Searches.

Parameters:

  • id: instance id of advanced search record.

func (*Client) DeleteAdvancedUserContentSearchV1 

func (c *Client) DeleteAdvancedUserContentSearchV1(ctx context.Context, id string) error

DeleteAdvancedUserContentSearchV1 remove specified Advanced User Content Search object.

Required privileges: advanced-user-searches:delete. Legacy Jamf Pro privilege name(s): Delete Advanced User Content Searches.

Parameters:

  • id: instance id of Advanced User Content Search record.

func (*Client) DeleteAllInventoryPreloadRecordsV2 

func (c *Client) DeleteAllInventoryPreloadRecordsV2(ctx context.Context) error

DeleteAllInventoryPreloadRecordsV2 delete all Inventory Preload records.

Required privileges: inventory-preload-records:delete. Legacy Jamf Pro privilege name(s): Delete Inventory Preload Records.

func (*Client) DeleteAppInstallerDeploymentV1 

func (c *Client) DeleteAppInstallerDeploymentV1(ctx context.Context, id string) error

DeleteAppInstallerDeploymentV1 delete an App Installer deployment.

Required privileges: applications:delete. Legacy Jamf Pro privilege name(s): Delete Mac Applications.

Parameters:

  • id: App Title deployment identifier.

func (*Client) DeleteAppRequestFormInputFieldV1 

func (c *Client) DeleteAppRequestFormInputFieldV1(ctx context.Context, id string) error

DeleteAppRequestFormInputFieldV1 remove specified Form Input Field record.

Required privileges: app-request:update. Legacy Jamf Pro privilege name(s): Update App Request Settings.

Parameters:

  • id: Instance id of form input field record.

func (*Client) DeleteBuildingV1 

func (c *Client) DeleteBuildingV1(ctx context.Context, id string) error

DeleteBuildingV1 remove specified Building record.

Required privileges: buildings:delete. Legacy Jamf Pro privilege name(s): Delete Buildings.

Parameters:

  • id: instance id of building record.

func (*Client) DeleteCategoryV1 

func (c *Client) DeleteCategoryV1(ctx context.Context, id string) error

DeleteCategoryV1 remove specified Category record.

Required privileges: categories:delete. Legacy Jamf Pro privilege name(s): Delete Categories.

Parameters:

  • id: instance id of category record.

func (*Client) DeleteCloudAzureV1 

func (c *Client) DeleteCloudAzureV1(ctx context.Context, id string) error

DeleteCloudAzureV1 delete Cloud Identity Provider configuration.

Required privileges: ldap-servers:delete. Legacy Jamf Pro privilege name(s): Delete LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) DeleteCloudDistributionPointV1 

func (c *Client) DeleteCloudDistributionPointV1(ctx context.Context) error

DeleteCloudDistributionPointV1 delete cloud distribution point.

Required privileges: cloud-distribution-point:update. Legacy Jamf Pro privilege name(s): Update Cloud Distribution Point.

func (*Client) DeleteCloudLdapV2 

func (c *Client) DeleteCloudLdapV2(ctx context.Context, id string) error

DeleteCloudLdapV2 delete Cloud Identity Provider configuration.

Required privileges: ldap-servers:delete. Legacy Jamf Pro privilege name(s): Delete LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) DeleteComputerExtensionAttributeV1 

func (c *Client) DeleteComputerExtensionAttributeV1(ctx context.Context, id string) error

DeleteComputerExtensionAttributeV1 remove specified Computer Extension Attribute.

Required privileges: extension-attributes:delete. Legacy Jamf Pro privilege name(s): Delete Computer Extension Attributes.

Parameters:

  • id: Unique ID of Computer Extension Attribute.

func (*Client) DeleteComputerInventoryAttachmentV3 deprecated 

func (c *Client) DeleteComputerInventoryAttachmentV3(ctx context.Context, id string, attachmentID string) error

DeleteComputerInventoryAttachmentV3 remove attachment.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Computers.

Parameters:

  • id: instance id of computer record.
  • attachmentID: instance id of attachment object.

func (*Client) DeleteComputerInventoryAttachmentV4 

func (c *Client) DeleteComputerInventoryAttachmentV4(ctx context.Context, id string, attachmentID string) error

DeleteComputerInventoryAttachmentV4 remove attachment.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Computers.

Parameters:

  • id: instance id of computer record.
  • attachmentID: instance id of attachment object.

func (*Client) DeleteComputerInventoryCollectionCustomPathV2 

func (c *Client) DeleteComputerInventoryCollectionCustomPathV2(ctx context.Context, id string) error

DeleteComputerInventoryCollectionCustomPathV2 delete Custom Path from Computer Inventory Collection Settings.

Required privileges: custom-paths:delete. Legacy Jamf Pro privilege name(s): Delete Custom Paths.

Parameters:

  • id: id of Custom Path.

func (*Client) DeleteComputerInventoryV3 deprecated 

func (c *Client) DeleteComputerInventoryV3(ctx context.Context, id string) error

DeleteComputerInventoryV3 remove specified Computer record.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Delete Computers.

Parameters:

  • id: instance id of computer record.

func (*Client) DeleteComputerInventoryV4 

func (c *Client) DeleteComputerInventoryV4(ctx context.Context, id string) error

DeleteComputerInventoryV4 remove specified Computer record.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Delete Computers.

Parameters:

  • id: instance id of computer record.

func (*Client) DeleteComputerPrestageV3 

func (c *Client) DeleteComputerPrestageV3(ctx context.Context, id string) error

DeleteComputerPrestageV3 delete a Computer Prestage with the supplied id.

Required privileges: prestage-enrollments:delete. Legacy Jamf Pro privilege name(s): Delete Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) DeleteCsaTokenV1 

func (c *Client) DeleteCsaTokenV1(ctx context.Context) error

DeleteCsaTokenV1 delete the CSA token exchange - This will disable Jamf Pro's ability to authenticate with cloud-hosted services.

Required privileges: cloud-services-settings:update. Legacy Jamf Pro privilege name(s): Update Cloud Services Settings.

func (*Client) DeleteDepartmentV1 

func (c *Client) DeleteDepartmentV1(ctx context.Context, id string) error

DeleteDepartmentV1 remove specified department record.

Required privileges: departments:delete. Legacy Jamf Pro privilege name(s): Delete Departments.

Parameters:

  • id: instance id of department record.

func (*Client) DeleteDeviceEnrollmentV1 

func (c *Client) DeleteDeviceEnrollmentV1(ctx context.Context, id string) error

DeleteDeviceEnrollmentV1 delete a Device Enrollment Instance with the supplied id.

Required privileges: device-enrollment-program-instances:delete. Legacy Jamf Pro privilege name(s): Delete Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) DeleteDigicertTrustLifecycleManagerV1 

func (c *Client) DeleteDigicertTrustLifecycleManagerV1(ctx context.Context, id string) error

DeleteDigicertTrustLifecycleManagerV1 delete DigiCert Trust Lifecycle Manager configuration.

Required privileges: digicert-settings:delete. Legacy Jamf Pro privilege name(s): Delete DigiCert Settings.

Parameters:

  • id: ID of the DigiCert Trust Lifecycle Manager configuration.

func (*Client) DeleteDistributionPointV1 

func (c *Client) DeleteDistributionPointV1(ctx context.Context, id string) error

DeleteDistributionPointV1 remove specified distribution point.

Required privileges: distribution-points:delete. Legacy Jamf Pro privilege name(s): Delete Distribution Points.

Parameters:

  • id: Instance id of distribution point.

func (*Client) DeleteDockItemV1 

func (c *Client) DeleteDockItemV1(ctx context.Context, id string) error

DeleteDockItemV1 delete a DockItem at the specified id.

Required privileges: dock-items:delete. Legacy Jamf Pro privilege name(s): Delete Dock Items.

Parameters:

  • id: DockItem object identifier.

func (*Client) DeleteEnrollmentAccessGroupV3 

func (c *Client) DeleteEnrollmentAccessGroupV3(ctx context.Context, id string) error

DeleteEnrollmentAccessGroupV3 delete an LDAP group's access to user initiated Enrollment.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

Parameters:

  • id: Autogenerated Access Group ID.

func (*Client) DeleteEnrollmentCustomizationLdapPanelV1 

func (c *Client) DeleteEnrollmentCustomizationLdapPanelV1(ctx context.Context, id string, panelID string) error

DeleteEnrollmentCustomizationLdapPanelV1 delete an LDAP single panel from an Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) DeleteEnrollmentCustomizationPanelV1 

func (c *Client) DeleteEnrollmentCustomizationPanelV1(ctx context.Context, id string, panelID string) error

DeleteEnrollmentCustomizationPanelV1 delete a single Panel from an Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) DeleteEnrollmentCustomizationSsoPanelV1 

func (c *Client) DeleteEnrollmentCustomizationSsoPanelV1(ctx context.Context, id string, panelID string) error

DeleteEnrollmentCustomizationSsoPanelV1 delete a single SSO Panel from an Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) DeleteEnrollmentCustomizationTextPanelV1 

func (c *Client) DeleteEnrollmentCustomizationTextPanelV1(ctx context.Context, id string, panelID string) error

DeleteEnrollmentCustomizationTextPanelV1 delete a Text single Panel from an Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) DeleteEnrollmentCustomizationV2 

func (c *Client) DeleteEnrollmentCustomizationV2(ctx context.Context, id string) error

DeleteEnrollmentCustomizationV2 delete an Enrollment Customization with the supplied id.

Required privileges: enrollment-customization:delete, enrollment-customization:read. Legacy Jamf Pro privilege name(s): Delete Enrollment Customizations, Read Enrollment Customizations. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) DeleteEnrollmentLanguageV3 

func (c *Client) DeleteEnrollmentLanguageV3(ctx context.Context, languageID string) error

DeleteEnrollmentLanguageV3 delete the Enrollment messaging for a language.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

Parameters:

  • languageID: Two letter ISO 639-1 Language Code.

func (*Client) DeleteGroupV2 

func (c *Client) DeleteGroupV2(ctx context.Context, id string) error

DeleteGroupV2 delete a group by platform UUID.

Required privileges: device-groups:delete.

Parameters:

  • id: The platform UUID of a group.

func (*Client) DeleteIOSBrandingConfigurationV1 

func (c *Client) DeleteIOSBrandingConfigurationV1(ctx context.Context, id string) error

DeleteIOSBrandingConfigurationV1 delete the Self Service iOS branding configuration indicated by the provided id.

Required privileges: self-service:delete. Legacy Jamf Pro privilege name(s): Delete Self Service Branding Configuration.

Parameters:

  • id: id of iOS branding configuration.

func (*Client) DeleteInventoryPreloadRecordV2 

func (c *Client) DeleteInventoryPreloadRecordV2(ctx context.Context, id string) error

DeleteInventoryPreloadRecordV2 delete an Inventory Preload record.

Required privileges: inventory-preload-records:delete. Legacy Jamf Pro privilege name(s): Delete Inventory Preload Records.

Parameters:

  • id: Inventory Preload identifier.

func (*Client) DeleteJCDSFileV1 deprecated 

func (c *Client) DeleteJCDSFileV1(ctx context.Context, fileName string) error

DeleteJCDSFileV1 delete a file from the Jamf Cloud Distribution Service.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-08-28) and may be removed in a future release.

Required privileges: jamf-cloud-distribution-service-files:delete. Legacy Jamf Pro privilege name(s): Delete Jamf Cloud Distribution Service Files.

Parameters:

  • fileName: Name of the file that will be deleted from the Jamf Cloud Distribution Service.

func (*Client) DeleteLogFlushingTaskV1 

func (c *Client) DeleteLogFlushingTaskV1(ctx context.Context, id string) error

DeleteLogFlushingTaskV1 cancels a log flushing task.

Required privileges: retention-policy:update. Legacy Jamf Pro privilege name(s): Update Retention Policy.

Parameters:

  • id: The identifier of the log flushing task.

func (*Client) DeleteMacOSBrandingConfigurationV1 

func (c *Client) DeleteMacOSBrandingConfigurationV1(ctx context.Context, id string) error

DeleteMacOSBrandingConfigurationV1 delete the Self Service macOS branding configuration indicated by the provided id.

Required privileges: self-service:delete. Legacy Jamf Pro privilege name(s): Delete Self Service Branding Configuration.

Parameters:

  • id: id of macOS branding configuration.

func (*Client) DeleteMdmRenewalStrategiesV1 

func (c *Client) DeleteMdmRenewalStrategiesV1(ctx context.Context, clientManagementID string) error

DeleteMdmRenewalStrategiesV1 delete MDM renewal strategies for a client management ID.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send Command to Renew MDM Profile.

Parameters:

  • clientManagementID: The client management ID to delete renewal strategies for.

func (*Client) DeleteMobileDeviceExtensionAttributeV1 

func (c *Client) DeleteMobileDeviceExtensionAttributeV1(ctx context.Context, id string) error

DeleteMobileDeviceExtensionAttributeV1 delete a Mobile Device Extension Attribute by ID.

Required privileges: extension-attributes:delete. Legacy Jamf Pro privilege name(s): Delete Mobile Device Extension Attributes.

Parameters:

  • id: Unique ID of Mobile Device Extension Attribute.

func (*Client) DeleteMobileDevicePrestageV3 

func (c *Client) DeleteMobileDevicePrestageV3(ctx context.Context, id string) error

DeleteMobileDevicePrestageV3 delete a Mobile Device Prestage with the supplied id.

Required privileges: prestage-enrollments:delete. Legacy Jamf Pro privilege name(s): Delete Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) DeleteMultipleAdvancedMobileDeviceSearchesV1 

func (c *Client) DeleteMultipleAdvancedMobileDeviceSearchesV1(ctx context.Context, request *Ids) error

DeleteMultipleAdvancedMobileDeviceSearchesV1 remove specified Advanced Search objects.

Required privileges: advanced-device-searches:delete. Legacy Jamf Pro privilege name(s): Delete Advanced Mobile Device Searches.

func (*Client) DeleteMultipleBuildingsV1 

func (c *Client) DeleteMultipleBuildingsV1(ctx context.Context, request *Ids) error

DeleteMultipleBuildingsV1 delete multiple Buildings by their ids.

Required privileges: buildings:delete. Legacy Jamf Pro privilege name(s): Delete Buildings.

func (*Client) DeleteMultipleCategoriesV1 

func (c *Client) DeleteMultipleCategoriesV1(ctx context.Context, request *Ids) error

DeleteMultipleCategoriesV1 delete multiple Categories by their IDs.

Required privileges: categories:delete. Legacy Jamf Pro privilege name(s): Delete Categories.

func (*Client) DeleteMultipleComputerExtensionAttributesV1 

func (c *Client) DeleteMultipleComputerExtensionAttributesV1(ctx context.Context, request *Ids) error

DeleteMultipleComputerExtensionAttributesV1 delete multiple Computer Extension Attribute at once.

Required privileges: extension-attributes:delete. Legacy Jamf Pro privilege name(s): Delete Computer Extension Attributes.

func (*Client) DeleteMultipleDepartmentsV1 

func (c *Client) DeleteMultipleDepartmentsV1(ctx context.Context, request *Ids) error

DeleteMultipleDepartmentsV1 deletes all departments by ids passed in body.

Required privileges: departments:delete. Legacy Jamf Pro privilege name(s): Delete Departments.

func (*Client) DeleteMultipleDistributionPointsV1 

func (c *Client) DeleteMultipleDistributionPointsV1(ctx context.Context, request *Ids) error

DeleteMultipleDistributionPointsV1 delete multiple distribution points at once.

Required privileges: distribution-points:delete. Legacy Jamf Pro privilege name(s): Delete Distribution Points.

func (*Client) DeleteMultipleEnrollmentLanguagesV3 

func (c *Client) DeleteMultipleEnrollmentLanguagesV3(ctx context.Context, request *Ids) error

DeleteMultipleEnrollmentLanguagesV3 delete multiple configured languages from User-Initiated Enrollment settings.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

func (*Client) DeleteMultipleMobileDevicePrestageAttachmentsV3 

func (c *Client) DeleteMultipleMobileDevicePrestageAttachmentsV3(ctx context.Context, id string, request *Ids) error

DeleteMultipleMobileDevicePrestageAttachmentsV3 remove an attachment for a Mobile Device Prestage.

Required privileges: prestage-enrollments:delete. Legacy Jamf Pro privilege name(s): Delete Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) DeleteMultiplePackagesV1 

func (c *Client) DeleteMultiplePackagesV1(ctx context.Context, request *Ids) error

DeleteMultiplePackagesV1 delete multiple packages at once.

Required privileges: packages:delete. Legacy Jamf Pro privilege name(s): Delete Packages.

func (*Client) DeleteNotificationV1 

func (c *Client) DeleteNotificationV1(ctx context.Context, notificationType string, id string) error

DeleteNotificationV1 delete Notifications.

Required privileges: dismiss-notifications:execute. Legacy Jamf Pro privilege name(s): Dismiss Notifications.

Parameters:

  • notificationType: type of the notification. Allowed values: see the NotificationType constants.
  • id: instance ID of the notification.

func (*Client) DeletePackageManifestV1 

func (c *Client) DeletePackageManifestV1(ctx context.Context, id string) error

DeletePackageManifestV1 delete the manifest for a specified package.

Required privileges: packages:read, packages:update. Legacy Jamf Pro privilege name(s): Update Packages, Read Packages. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Id of the package to delete manifest from.

func (*Client) DeletePackageV1 

func (c *Client) DeletePackageV1(ctx context.Context, id string) error

DeletePackageV1 remove specified package.

Required privileges: packages:delete. Legacy Jamf Pro privilege name(s): Delete Packages.

Parameters:

  • id: Instance ID of package.

func (*Client) DeletePatchSoftwareTitleConfigurationV3 

func (c *Client) DeletePatchSoftwareTitleConfigurationV3(ctx context.Context, id string) error

DeletePatchSoftwareTitleConfigurationV3 delete Patch Software Title Configurations with the supplied id.

Required privileges: patch-management-software-titles:delete. Legacy Jamf Pro privilege name(s): Delete Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configurations identifier.

func (*Client) DeleteReturnToServiceConfigurationV1 

func (c *Client) DeleteReturnToServiceConfigurationV1(ctx context.Context, id string) error

DeleteReturnToServiceConfigurationV1 delete a Return To Service Configuration with the supplied id.

Required privileges: return-to-service:delete. Legacy Jamf Pro privilege name(s): Delete Return To Service Configurations.

Parameters:

  • id: Return To Service Configurations identifier.

func (*Client) DeleteScriptV1 

func (c *Client) DeleteScriptV1(ctx context.Context, id string) error

DeleteScriptV1 delete a Script at the specified id.

Required privileges: scripts:delete. Legacy Jamf Pro privilege name(s): Delete Scripts.

Parameters:

  • id: Script object identifier.

func (*Client) DeleteSmartComputerGroupV3 

func (c *Client) DeleteSmartComputerGroupV3(ctx context.Context, id string) error

DeleteSmartComputerGroupV3 remove specified Smart Computer Group.

Required privileges: device-groups:delete. Legacy Jamf Pro privilege name(s): Delete Smart Computer Groups.

Parameters:

  • id: id of target Smart Computer Group.

func (*Client) DeleteSmartMobileDeviceGroupV2 

func (c *Client) DeleteSmartMobileDeviceGroupV2(ctx context.Context, id string) error

DeleteSmartMobileDeviceGroupV2 remove Smart Group by Id.

Required privileges: device-groups:delete. Legacy Jamf Pro privilege name(s): Delete Smart Mobile Device Groups.

Parameters:

  • id: instance id of smart-group.

func (*Client) DeleteSsoCertificateV2 

func (c *Client) DeleteSsoCertificateV2(ctx context.Context) error

DeleteSsoCertificateV2 delete the currently configured certificate used by SSO.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) DeleteStaticComputerGroupV3 

func (c *Client) DeleteStaticComputerGroupV3(ctx context.Context, id string) error

DeleteStaticComputerGroupV3 remove Static Computer Group by Id.

Required privileges: device-groups:delete. Legacy Jamf Pro privilege name(s): Delete Static Computer Groups.

Parameters:

  • id: instance id of static computer group.

func (*Client) DeleteStaticMobileDeviceGroupV2 

func (c *Client) DeleteStaticMobileDeviceGroupV2(ctx context.Context, id string) error

DeleteStaticMobileDeviceGroupV2 remove Static Group by Id.

Required privileges: device-groups:delete. Legacy Jamf Pro privilege name(s): Delete Static Mobile Device Groups.

Parameters:

  • id: instance id of static-group.

func (*Client) DeleteSupervisionIdentityV1 

func (c *Client) DeleteSupervisionIdentityV1(ctx context.Context, id string) error

DeleteSupervisionIdentityV1 delete a Supervision Identity with the supplied id.

Required privileges: apple-configurator-enrollment:update. Legacy Jamf Pro privilege name(s): Update Apple Configurator Enrollment.

Parameters:

  • id: Supervision Identity identifier.

func (*Client) DeleteTeamViewerConfigurationPreview 

func (c *Client) DeleteTeamViewerConfigurationPreview(ctx context.Context, id string) error

DeleteTeamViewerConfigurationPreview delete Team Viewer Remote Administration connection configuration.

Required privileges: remote-administration:delete. Legacy Jamf Pro privilege name(s): Delete Remote Administration.

Parameters:

  • id: ID of the Team Viewer connection configuration.

func (*Client) DeleteUserPreferenceV1 

func (c *Client) DeleteUserPreferenceV1(ctx context.Context, keyID string) error

DeleteUserPreferenceV1 remove specified setting for authenticated user.

Required privileges: the spec declares none.

Parameters:

  • keyID: unique key of user setting to be persisted.

func (*Client) DeleteUserV1 

func (c *Client) DeleteUserV1(ctx context.Context, id string) error

DeleteUserV1 delete a user from inventory.

Required privileges: users:delete. Legacy Jamf Pro privilege name(s): Delete User.

Parameters:

  • id: ID of the user to delete.

func (*Client) DeleteVenafiProxyTrustStoreV1 

func (c *Client) DeleteVenafiProxyTrustStoreV1(ctx context.Context, id string) error

DeleteVenafiProxyTrustStoreV1 removes the PKI Proxy Server public key used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) DeleteVenafiV1 

func (c *Client) DeleteVenafiV1(ctx context.Context, id string) error

DeleteVenafiV1 delete a Venafi PKI configuration from Jamf Pro.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) DeleteVolumePurchasingLocationV1 

func (c *Client) DeleteVolumePurchasingLocationV1(ctx context.Context, id string) error

DeleteVolumePurchasingLocationV1 delete a Volume Purchasing Location with the supplied id.

Required privileges: volume-purchasing-locations:delete. Legacy Jamf Pro privilege name(s): Delete Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Location identifier.

func (*Client) DeleteVolumePurchasingSubscriptionV1 

func (c *Client) DeleteVolumePurchasingSubscriptionV1(ctx context.Context, id string) error

DeleteVolumePurchasingSubscriptionV1 delete a Volume Purchasing Subscription with the supplied id.

Required privileges: volume-purchasing-locations:delete. Legacy Jamf Pro privilege name(s): Delete Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Subscription identifier.

func (*Client) DeployPackageV1 

func (c *Client) DeployPackageV1(ctx context.Context, request *InstallPackage, verbose bool) (*VerbosePackageDeploymentResponse, error)

DeployPackageV1 deploy packages using MDM.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send Computer Remote Command to Install Package.

Parameters:

  • verbose: Enables the 'verbose' response, which includes information about the commands queued as well as information about commands that failed to queue.

func (*Client) DisableSsoV3 

func (c *Client) DisableSsoV3(ctx context.Context) error

DisableSsoV3 disable SSO.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) DismissAllNotificationsV1 

func (c *Client) DismissAllNotificationsV1(ctx context.Context) error

DismissAllNotificationsV1 dismiss all notifications.

Required privileges: dismiss-notifications:execute. Legacy Jamf Pro privilege name(s): Dismiss Notifications.

Published but not routed at the gateway: every call answers `403 BAD_PERMISSIONS`, whatever privileges the credential holds. The routed item-level `DELETE /v1/notifications/{type}/{id}` answers 204 for the same `dismiss-notifications:execute`, so the gap is the route and not the grant. Until it lands there is no bulk dismiss — enumerate with `ListNotificationsV1` and call `DeleteNotificationV1` per notification. `TestAcceptance_Pro_DismissAllNotificationsUnroutedAtGateway` fails the day the route appears, which is the notification to delete this note.

func (*Client) DisownDeviceEnrollmentDevicesV1 

func (c *Client) DisownDeviceEnrollmentDevicesV1(ctx context.Context, id string, request *DeviceEnrollmentDisownBody) (*DeviceEnrollmentDisownResponse, error)

DisownDeviceEnrollmentDevicesV1 disown devices from the given Device Enrollment Instance.

Required privileges: device-enrollment-program-instances:update. Legacy Jamf Pro privilege name(s): Update Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) DispatchOidcLoginV2 

func (c *Client) DispatchOidcLoginV2(ctx context.Context, request *OidcLoginDispatchRequest) (*OidcLoginDispatchResponseV2, error)

DispatchOidcLoginV2 provide the url to redirect for OIDC login.

Required privileges: the spec declares none.

func (*Client) DownloadActiveCertificateAuthorityDerV1 

func (c *Client) DownloadActiveCertificateAuthorityDerV1(ctx context.Context) ([]byte, error)

DownloadActiveCertificateAuthorityDerV1 returns X.509 of active Certificate Authority (CA) in DER format.

Required privileges: the spec declares none.

func (*Client) DownloadActiveCertificateAuthorityPemV1 

func (c *Client) DownloadActiveCertificateAuthorityPemV1(ctx context.Context) ([]byte, error)

DownloadActiveCertificateAuthorityPemV1 returns active Certificate Authority (CA) in PEM format.

Required privileges: the spec declares none.

func (*Client) DownloadBrandingImageV1 

func (c *Client) DownloadBrandingImageV1(ctx context.Context, id string) ([]byte, error)

DownloadBrandingImageV1 download a self service branding image.

Required privileges: the spec declares none.

Parameters:

  • id: id of the self service branding image.

func (*Client) DownloadCertificateAuthorityDerV1 

func (c *Client) DownloadCertificateAuthorityDerV1(ctx context.Context, id string) ([]byte, error)

DownloadCertificateAuthorityDerV1 returns X.509 current Certificate Authority (CA) with provided ID in DER format.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: UUID of the Certificate Authority (CA).

func (*Client) DownloadCertificateAuthorityPemV1 

func (c *Client) DownloadCertificateAuthorityPemV1(ctx context.Context, id string) ([]byte, error)

DownloadCertificateAuthorityPemV1 returns current Certificate Authority (CA) with provided ID in PEM format.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: UUID of the Certificate Authority (CA).

func (*Client) DownloadComputerExtensionAttributeV1 

func (c *Client) DownloadComputerExtensionAttributeV1(ctx context.Context, id string) ([]byte, error)

DownloadComputerExtensionAttributeV1 download the specified Computer Extension Attribute.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • id: The unique ID of the Computer Extension Attribute to be downloaded.

func (*Client) DownloadComputerInventoryAttachmentV3 deprecated 

func (c *Client) DownloadComputerInventoryAttachmentV3(ctx context.Context, id string, attachmentID string) ([]byte, error)

DownloadComputerInventoryAttachmentV3 download attachment file.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: instance id of computer record.
  • attachmentID: instance id of attachment object.

func (*Client) DownloadComputerInventoryAttachmentV4 

func (c *Client) DownloadComputerInventoryAttachmentV4(ctx context.Context, id string, attachmentID string) ([]byte, error)

DownloadComputerInventoryAttachmentV4 download attachment file.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: instance id of computer record.
  • attachmentID: instance id of attachment object.

func (*Client) DownloadEnrollmentCustomizationImageV2 

func (c *Client) DownloadEnrollmentCustomizationImageV2(ctx context.Context, id string) ([]byte, error)

DownloadEnrollmentCustomizationImageV2 download an enrollment customization image.

Required privileges: the spec declares none.

Parameters:

  • id: id of the enrollment customization image.

func (*Client) DownloadIconV1 

func (c *Client) DownloadIconV1(ctx context.Context, id string, res int, scale string) ([]byte, error)

DownloadIconV1 download a self service icon.

Required privileges: the spec declares none.

Parameters:

  • id: id of the self service icon.
  • res: request a specific resolution of original, 300, or 512; invalid options will result in original resolution.
  • scale: request a scale; 0 results in original image, non-0 results in scaled to 300.

func (*Client) DownloadInventoryPreloadCsvTemplateV2 

func (c *Client) DownloadInventoryPreloadCsvTemplateV2(ctx context.Context) ([]byte, error)

DownloadInventoryPreloadCsvTemplateV2 download the Inventory Preload CSV template.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

func (*Client) DownloadInventoryPreloadCsvV2 

func (c *Client) DownloadInventoryPreloadCsvV2(ctx context.Context) ([]byte, error)

DownloadInventoryPreloadCsvV2 download all Inventory Preload records.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

func (*Client) DownloadMobileDeviceEnrollmentProfileV1 

func (c *Client) DownloadMobileDeviceEnrollmentProfileV1(ctx context.Context, id string) ([]byte, error)

DownloadMobileDeviceEnrollmentProfileV1 retrieve the MDM Enrollment Profile.

Required privileges: enrollment-profiles:read. Legacy Jamf Pro privilege name(s): Read Enrollment Profiles.

Parameters:

  • id: MDM Enrollment Profile identifier.

func (*Client) DownloadScriptV1 

func (c *Client) DownloadScriptV1(ctx context.Context, id string) ([]byte, error)

DownloadScriptV1 download a text file of the Script contents.

Required privileges: scripts:read. Legacy Jamf Pro privilege name(s): Read Scripts.

Parameters:

  • id: id of the script to be downloaded.

func (*Client) DownloadSsoCertificateV2 

func (c *Client) DownloadSsoCertificateV2(ctx context.Context) ([]byte, error)

DownloadSsoCertificateV2 download the certificate currently configured for use with Jamf Pro's SSO configuration.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

func (*Client) DownloadSsoMetadataV3 

func (c *Client) DownloadSsoMetadataV3(ctx context.Context) ([]byte, error)

DownloadSsoMetadataV3 download the Jamf Pro SAML metadata file.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

func (*Client) DownloadSupervisionIdentityV1 

func (c *Client) DownloadSupervisionIdentityV1(ctx context.Context, id string) ([]byte, error)

DownloadSupervisionIdentityV1 download the Supervision Identity .p12 file.

Required privileges: apple-configurator-enrollment:read. Legacy Jamf Pro privilege name(s): Read Apple Configurator Enrollment.

Parameters:

  • id: Supervision Identity identifier.

func (*Client) EnableAllApnsClientsV1 

func (c *Client) EnableAllApnsClientsV1(ctx context.Context) error

EnableAllApnsClientsV1 enable push notifications for all clients.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send MDM command information in Jamf Pro API.

func (*Client) EnableApnsClientV1 

func (c *Client) EnableApnsClientV1(ctx context.Context, request *EnablePushRequest) error

EnableApnsClientV1 enable push notifications for a single client.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send MDM command information in Jamf Pro API.

func (*Client) EraseComputerV4 

func (c *Client) EraseComputerV4(ctx context.Context, id string, request *EraseDeviceComputerRequest) (*EraseDeviceComputerResponse, error)

EraseComputerV4 erase a computer.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Send Computer Remote Wipe Command.

Parameters:

  • id: Id of the computer to erase.

func (*Client) EraseMobileDeviceGroupV2 

func (c *Client) EraseMobileDeviceGroupV2(ctx context.Context, id string, request *GroupResetRequest) error

EraseMobileDeviceGroupV2 erase all devices in the group.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Send MDM command information in Jamf Pro API.

Parameters:

  • id: instance id of mobile-device-group.

func (*Client) EraseMobileDeviceV2 

func (c *Client) EraseMobileDeviceV2(ctx context.Context, id string, request *EraseDeviceMobileDeviceRequest) (*EraseDeviceMobileDeviceResponse, error)

EraseMobileDeviceV2 erase a Mobile Device.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Send Mobile Device Remote Wipe Command.

Parameters:

  • id: Id of the Mobile Device to erase.

func (*Client) ExportActivationCodeHistoryV1 

func (c *Client) ExportActivationCodeHistoryV1(ctx context.Context, request *ExportParameters) ([]byte, error)

ExportActivationCodeHistoryV1 export history object collection in specified format for Activation Code.

Required privileges: activation-code:read. Legacy Jamf Pro privilege name(s): Read License Information.

func (*Client) ExportAppInstallerDeploymentsV1 

func (c *Client) ExportAppInstallerDeploymentsV1(ctx context.Context, request *ExportParameters, sort []string, filter string) ([]byte, error)

ExportAppInstallerDeploymentsV1 export App Installer deployment summary.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: `id`, `name`, `app.deployedVersion`, `bundleId`, `deploymentType`, `updateBehavior`, `app.versionAction`. This param can be combined with paging and sorting. Example: name=="*appInstaller*".

func (*Client) ExportBuildingHistoryV1 

func (c *Client) ExportBuildingHistoryV1(ctx context.Context, id string, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportBuildingHistoryV1 export history object collection in specified format for specified Buildings.

Required privileges: buildings:read. Legacy Jamf Pro privilege name(s): Read Buildings.

Parameters:

  • id: instance id of buildings.
  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ExportBuildingsV1 

func (c *Client) ExportBuildingsV1(ctx context.Context, request *ExportParameters, sort []string, filter string) ([]byte, error)

ExportBuildingsV1 export Buildings collection.

Required privileges: buildings:read. Legacy Jamf Pro privilege name(s): Read Buildings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="*buildings*".

func (*Client) ExportCloudIdpV1 

func (c *Client) ExportCloudIdpV1(ctx context.Context, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportCloudIdpV1 export Cloud Identity Providers collection.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be seperated with a comma. Example: sort=id:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="*department*".

func (*Client) ExportEnrollmentHistoryV2 

func (c *Client) ExportEnrollmentHistoryV2(ctx context.Context, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportEnrollmentHistoryV2 export enrollment history collection.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

Parameters:

  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="*script*".

func (*Client) ExportInventoryPreloadV2 

func (c *Client) ExportInventoryPreloadV2(ctx context.Context, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportInventoryPreloadV2 export a collection of inventory preload records.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

Parameters:

  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `id:asc`. Multiple sort criteria are supported and must be separated with a comma. All inventory preload fields are supported, however fields added by extension attributes are not supported. If sorting by deviceType, use `0` for Computer and `1` for Mobile Device. Example: `sort=date:desc,name:asc`.
  • filter: Allowing to filter inventory preload records. Default search is empty query - returning all results for the requested page. All inventory preload fields are supported, however fields added by extension attributes are not supported. If filtering by deviceType, use `0` for Computer and `1` for Mobile Device. Query in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`. Example: `filter=categoryName=="Category"`.

func (*Client) ExportJamfRemoteAssistSessionsV2 

func (c *Client) ExportJamfRemoteAssistSessionsV2(ctx context.Context, request *ExportParameters) ([]byte, error)

ExportJamfRemoteAssistSessionsV2 export Jamf Remote Assist sessions history.

Required privileges: remote-assist:read. Legacy Jamf Pro privilege name(s): Read Remote Assist.

func (*Client) ExportOnboardingHistoryV1 

func (c *Client) ExportOnboardingHistoryV1(ctx context.Context, request *ExportParameters) ([]byte, error)

ExportOnboardingHistoryV1 export history object collection in specified format for Onboarding.

Required privileges: onboarding:read. Legacy Jamf Pro privilege name(s): Read Onboarding Configuration.

func (*Client) ExportPackageHistoryV1 

func (c *Client) ExportPackageHistoryV1(ctx context.Context, id string, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportPackageHistoryV1 export history object collection in specified format for specified Packages.

Required privileges: packages:read. Legacy Jamf Pro privilege name(s): Read Packages.

Parameters:

  • id: Instance ID of package history note.
  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ExportPackagesV1 

func (c *Client) ExportPackagesV1(ctx context.Context, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportPackagesV1 export Packages collection.

Required privileges: packages:read. Legacy Jamf Pro privilege name(s): Read Packages.

Parameters:

  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ExportPatchSoftwareTitleReportV3 

func (c *Client) ExportPatchSoftwareTitleReportV3(ctx context.Context, id string, filter string, columnsToExport []string, accept string) ([]byte, error)

ExportPatchSoftwareTitleReportV3 export Patch Reporting Data.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configurations identifier.
  • filter: Query in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.
  • columnsToExport: List of column names to export.
  • accept: File. Allowed values, from the operation's declared response content types: text/csv, text/tab. Required in practice: the server answers 400 when this is omitted, although the spec marks the parameter optional. Passing the zero value omits it.

func (*Client) ExportReenrollmentHistoryV1 

func (c *Client) ExportReenrollmentHistoryV1(ctx context.Context, request *ExportParameters, exportFields []string, exportLabels []string, sort []string, filter string) ([]byte, error)

ExportReenrollmentHistoryV1 export reenrollment history collection.

Required privileges: re-enrollment:read. Legacy Jamf Pro privilege name(s): Read Re-enrollment.

Parameters:

  • exportFields: Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username.
  • exportLabels: Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="*script*".

func (*Client) FailCloudDistributionPointUploadV1 

func (c *Client) FailCloudDistributionPointUploadV1(ctx context.Context, id string, fileName string, uploadType string) error

FailCloudDistributionPointUploadV1 marks a specific file upload as failed for the currently configured cloud distribution point.

Required privileges: cloud-distribution-point:update. Legacy Jamf Pro privilege name(s): Update Cloud Distribution Point.

Parameters:

  • id: The identifier of the inventory file to be marked as failed. The type and ID will make a unique identifier for the file.
  • fileName: Name of the file to mark failure for.
  • uploadType: Type of file to mark failure for. Possible values are PACKAGE, EBOOK, MOBILE_DEVICE_APP.

func (*Client) GenerateOidcCertificateV1 

func (c *Client) GenerateOidcCertificateV1(ctx context.Context) error

GenerateOidcCertificateV1 generate a new keystore used for signing OIDC messages.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) GenerateSsoCertificateV2 

func (c *Client) GenerateSsoCertificateV2(ctx context.Context) (*SsoKeystoreResponseWithDetails, error)

GenerateSsoCertificateV2 jamf Pro will generate a new certificate and use it to sign SSO.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) GenerateSsoFailoverV1 

func (c *Client) GenerateSsoFailoverV1(ctx context.Context) (*SsoFailoverData, error)

GenerateSsoFailoverV1 regenerates failover url.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) GetADUESessionTokenSettingsV1 

func (c *Client) GetADUESessionTokenSettingsV1(ctx context.Context) (*AccountDrivenUserEnrollmentSessionTokenSettings, error)

GetADUESessionTokenSettingsV1 retrieve the Account Driven User Enrollment Session Token Settings.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

func (*Client) GetAccountGroupV1 

func (c *Client) GetAccountGroupV1(ctx context.Context, id string) (*AccountGroupV1, error)

GetAccountGroupV1 gets the account group.

Required privileges: account-groups:read. Legacy Jamf Pro privilege name(s): Read Account Groups.

Parameters:

  • id: id of target account group.

func (*Client) GetAccountPreferencesV3 

func (c *Client) GetAccountPreferencesV3(ctx context.Context, acceptLanguage string) (*AccountPreferencesV6, error)

GetAccountPreferencesV3 get Jamf Pro account preferences.

Required privileges: the spec declares none.

Parameters:

  • acceptLanguage: Locale to be used.

func (*Client) GetAccountV1 

func (c *Client) GetAccountV1(ctx context.Context, id string) (*UserAccount, error)

GetAccountV1 gets the user account.

Required privileges: accounts:read. Legacy Jamf Pro privilege name(s): Read Accounts.

Parameters:

  • id: id of target account.

func (*Client) GetActiveCertificateAuthorityV1 

func (c *Client) GetActiveCertificateAuthorityV1(ctx context.Context) (*CertificateRecord, error)

GetActiveCertificateAuthorityV1 returns X.509 details of the active Certificate Authority (CA).

Required privileges: the spec declares none.

func (*Client) GetActiveUsersCountV1 

func (c *Client) GetActiveUsersCountV1(ctx context.Context) (*ActiveUsersCount, error)

GetActiveUsersCountV1 get count of active user sessions.

Required privileges: user-sessions:read. Legacy Jamf Pro privilege name(s): Read User.

func (*Client) GetAdcsSettingsDependenciesV1 

func (c *Client) GetAdcsSettingsDependenciesV1(ctx context.Context, id string) (*AdcsDependencies, error)

GetAdcsSettingsDependenciesV1 retrieve list of AD CS Settings dependencies.

Required privileges: ad-cs-settings:read. Legacy Jamf Pro privilege name(s): Read AD CS Settings.

Parameters:

  • id: AD CS Settings ID.

func (*Client) GetAdcsSettingsV1 

func (c *Client) GetAdcsSettingsV1(ctx context.Context, id string) (*AdcsSettingsResponse, error)

GetAdcsSettingsV1 get AD CS Settings configuration for the ID value.

Required privileges: ad-cs-settings:read. Legacy Jamf Pro privilege name(s): Read AD CS Settings.

Parameters:

  • id: ID of the AD CS Settings configuration.

func (*Client) GetAdvancedMobileDeviceSearchV1 

func (c *Client) GetAdvancedMobileDeviceSearchV1(ctx context.Context, id string) (*AdvancedSearch, error)

GetAdvancedMobileDeviceSearchV1 get specified Advanced Search object.

Required privileges: advanced-device-searches:read. Legacy Jamf Pro privilege name(s): Read Advanced Mobile Device Searches.

Parameters:

  • id: id of target Advanced Search.

func (*Client) GetAdvancedUserContentSearchV1 

func (c *Client) GetAdvancedUserContentSearchV1(ctx context.Context, id string) (*AdvancedUserContentSearch, error)

GetAdvancedUserContentSearchV1 get Specified Advanced User Content Search object.

Required privileges: advanced-user-searches:read. Legacy Jamf Pro privilege name(s): Read Advanced User Content Searches.

Parameters:

  • id: id of target Advanced User Content Search.

func (*Client) GetAllComputerPrestageScopeV2 

func (c *Client) GetAllComputerPrestageScopeV2(ctx context.Context) (*PrestageScopeV2, error)

GetAllComputerPrestageScopeV2 get all device Scope for all Computer Prestages.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Computer PreStage Enrollments.

func (*Client) GetAllMobileDevicePrestageScopeV2 

func (c *Client) GetAllMobileDevicePrestageScopeV2(ctx context.Context) (*PrestageScopeV2, error)

GetAllMobileDevicePrestageScopeV2 get all Device Scope for all Mobile Device Prestages.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

func (*Client) GetAppInstallerDeploymentControlsDefaultsV1 

func (c *Client) GetAppInstallerDeploymentControlsDefaultsV1(ctx context.Context) (*AppInstallersDeploymentProcessControlsDefaultSettings, error)

GetAppInstallerDeploymentControlsDefaultsV1 get default Global Deployment Process Controls settings for app installers.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

func (*Client) GetAppInstallerDeploymentInstallationSummaryV1 

func (c *Client) GetAppInstallerDeploymentInstallationSummaryV1(ctx context.Context, id string) (*AppInstallersInstallationSummary, error)

GetAppInstallerDeploymentInstallationSummaryV1 get installation summary for App Installer deployment.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • id: App Title deployment identifier.

func (*Client) GetAppInstallerDeploymentV1 

func (c *Client) GetAppInstallerDeploymentV1(ctx context.Context, id string) (*AppTitleDeploymentRead, error)

GetAppInstallerDeploymentV1 get details about App Installer deployment.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • id: App Title deployment identifier.

func (*Client) GetAppInstallerGlobalSettingsV1 

func (c *Client) GetAppInstallerGlobalSettingsV1(ctx context.Context) (*AppInstallersGlobalSettings, error)

GetAppInstallerGlobalSettingsV1 get global settings for app installers.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

func (*Client) GetAppInstallerTitleV1 

func (c *Client) GetAppInstallerTitleV1(ctx context.Context, id string, version string) (*AppTitleDetails, error)

GetAppInstallerTitleV1 get details about App Title version available in the App Installers system.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • id: App Title identifier.
  • version: Allow requesting specific app installer version.

func (*Client) GetAppInstallersFeatureStateV1 

func (c *Client) GetAppInstallersFeatureStateV1(ctx context.Context) (*AppInstallerFeatureState, error)

GetAppInstallersFeatureStateV1 checks if App Installers feature is available.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

func (*Client) GetAppRequestFormInputFieldV1 

func (c *Client) GetAppRequestFormInputFieldV1(ctx context.Context, id string) (*AppRequestFormInputField, error)

GetAppRequestFormInputFieldV1 get specified Form Input Field object.

Required privileges: app-request:read. Legacy Jamf Pro privilege name(s): Read App Request Settings.

Parameters:

  • id: Instance id of form input field record.

func (*Client) GetAppRequestSettingsV1 

func (c *Client) GetAppRequestSettingsV1(ctx context.Context) (*AppRequestSettings, error)

GetAppRequestSettingsV1 get Applicastion Request Settings.

Required privileges: app-request:read. Legacy Jamf Pro privilege name(s): Read App Request Settings.

func (*Client) GetBuildingV1 

func (c *Client) GetBuildingV1(ctx context.Context, id string) (*Building, error)

GetBuildingV1 get specified Building object.

Required privileges: buildings:read. Legacy Jamf Pro privilege name(s): Read Buildings.

Parameters:

  • id: instance id of building record.

func (*Client) GetCacheSettingsV1 

func (c *Client) GetCacheSettingsV1(ctx context.Context) (*CacheSettings, error)

GetCacheSettingsV1 get Cache Settings.

Required privileges: cache:read. Legacy Jamf Pro privilege name(s): Read Cache.

func (*Client) GetCategoryV1 

func (c *Client) GetCategoryV1(ctx context.Context, id string) (*Category, error)

GetCategoryV1 get specified Category object.

Required privileges: categories:read. Legacy Jamf Pro privilege name(s): Read Categories.

Parameters:

  • id: instance id of category record.

func (*Client) GetCertificateAuthorityV1 

func (c *Client) GetCertificateAuthorityV1(ctx context.Context, id string) (*CertificateRecord, error)

GetCertificateAuthorityV1 returns X.509 details of Certificate Authority (CA) with provided ID.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: UUID of the Certificate Authority (CA).

func (*Client) GetCheckInSettingsV3 

func (c *Client) GetCheckInSettingsV3(ctx context.Context) (*ClientCheckInV3, error)

GetCheckInSettingsV3 get Client Check-In settings.

Required privileges: computer-check-in:read. Legacy Jamf Pro privilege name(s): Read Computer Check-In.

func (*Client) GetClassicLdapMappingsV1 

func (c *Client) GetClassicLdapMappingsV1(ctx context.Context, id string) (*ClassicLdapMappings, error)

GetClassicLdapMappingsV1 get mappings for OnPrem Ldap configuration with given id.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: OnPrem Ldap identifier.

func (*Client) GetCloudAzureDefaultMappingsV1 deprecated 

func (c *Client) GetCloudAzureDefaultMappingsV1(ctx context.Context) (*AzureMappings, error)

GetCloudAzureDefaultMappingsV1 get default mappings.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-05-21) and may be removed in a future release.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

func (*Client) GetCloudAzureDefaultServerConfigurationV1 

func (c *Client) GetCloudAzureDefaultServerConfigurationV1(ctx context.Context) (*AzureServerConfiguration, error)

GetCloudAzureDefaultServerConfigurationV1 get default server configuration.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

func (*Client) GetCloudAzureV1 

func (c *Client) GetCloudAzureV1(ctx context.Context, id string) (*AzureConfiguration, error)

GetCloudAzureV1 get Azure Cloud Identity Provider configuration with given ID.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetCloudDistributionPointUploadCapabilityV1 

func (c *Client) GetCloudDistributionPointUploadCapabilityV1(ctx context.Context) (*CloudDistributionPointUploadCapability, error)

GetCloudDistributionPointUploadCapabilityV1 finds specific information for the currently configured cloud distribution point.

Required privileges: the spec declares none.

func (*Client) GetCloudDistributionPointV1 

func (c *Client) GetCloudDistributionPointV1(ctx context.Context) (*CloudDistributionPoint, error)

GetCloudDistributionPointV1 get the cloud distribution point Details.

Required privileges: cloud-distribution-point:read. Legacy Jamf Pro privilege name(s): Read Cloud Distribution Point.

func (*Client) GetCloudIdpV1 

func (c *Client) GetCloudIdpV1(ctx context.Context, id string) (*CloudIDPCommon, error)

GetCloudIdpV1 get Cloud Identity Provider configuration with given ID.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetCloudInformationV1 

func (c *Client) GetCloudInformationV1(ctx context.Context) (*CloudResponse, error)

GetCloudInformationV1 retrieve information related to cloud setup.

Required privileges: the spec declares none.

func (*Client) GetCloudLdapBindStatisticsV2 

func (c *Client) GetCloudLdapBindStatisticsV2(ctx context.Context, id string) (*CloudLdapConnectionPoolStatistics, error)

GetCloudLdapBindStatisticsV2 get bind connection pool statistics.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetCloudLdapConnectionStatusV2 

func (c *Client) GetCloudLdapConnectionStatusV2(ctx context.Context, id string) (*CloudLdapConnectionStatus, error)

GetCloudLdapConnectionStatusV2 tests the communication with the specified cloud connection.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetCloudLdapDefaultMappingsV2 

func (c *Client) GetCloudLdapDefaultMappingsV2(ctx context.Context, provider string) (*CloudLdapMappingsResponse, error)

GetCloudLdapDefaultMappingsV2 get default mappings.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • provider: Cloud Identity Provider name.

func (*Client) GetCloudLdapDefaultServerConfigurationV2 

func (c *Client) GetCloudLdapDefaultServerConfigurationV2(ctx context.Context, provider string) (*CloudLdapServerResponse, error)

GetCloudLdapDefaultServerConfigurationV2 get default server configuration.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • provider: Cloud Identity Provider name.

func (*Client) GetCloudLdapMappingsV2 

func (c *Client) GetCloudLdapMappingsV2(ctx context.Context, id string) (*CloudLdapMappingsResponse, error)

GetCloudLdapMappingsV2 get mappings configurations for Cloud Identity Providers server configuration.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetCloudLdapSearchStatisticsV2 

func (c *Client) GetCloudLdapSearchStatisticsV2(ctx context.Context, id string) (*CloudLdapConnectionPoolStatistics, error)

GetCloudLdapSearchStatisticsV2 get search connection pool statistics.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetCloudLdapV2 

func (c *Client) GetCloudLdapV2(ctx context.Context, id string) (*LdapConfigurationResponse, error)

GetCloudLdapV2 get Cloud Identity Provider configuration with given id.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) GetComputerDeviceLockPinV3 deprecated 

func (c *Client) GetComputerDeviceLockPinV3(ctx context.Context, id string) (*ComputerInventoryDeviceLockPinResponse, error)

GetComputerDeviceLockPinV3 return a computer's Device Lock PIN.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: computer-device-lock-pin:read. Legacy Jamf Pro privilege name(s): View Computer Device Lock Pin.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerDeviceLockPinV4 

func (c *Client) GetComputerDeviceLockPinV4(ctx context.Context, id string) (*ComputerInventoryDeviceLockPinResponse, error)

GetComputerDeviceLockPinV4 return a computer's Device Lock PIN.

Required privileges: computer-device-lock-pin:read. Legacy Jamf Pro privilege name(s): View Computer Device Lock Pin.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerExtensionAttributeDataDependencyV1 

func (c *Client) GetComputerExtensionAttributeDataDependencyV1(ctx context.Context, id string) (*DependencyObjectResults, error)

GetComputerExtensionAttributeDataDependencyV1 get smart group/advance search dependent objects for a specified computer extension attribute.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • id: Unique ID of computer extension attribute.

func (*Client) GetComputerExtensionAttributeTemplateV1 

func (c *Client) GetComputerExtensionAttributeTemplateV1(ctx context.Context, id string) (*ComputerExtensionAttributes, error)

GetComputerExtensionAttributeTemplateV1 get specified Computer Extension Attribute Template object.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • id: Unique Id of the Template.

func (*Client) GetComputerExtensionAttributeV1 

func (c *Client) GetComputerExtensionAttributeV1(ctx context.Context, id string) (*ComputerExtensionAttributes, error)

GetComputerExtensionAttributeV1 get specified Computer Extension Attribute object.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • id: Unique ID of Computer Extension Attribute.

func (*Client) GetComputerInventoryCollectionSettingsV2 

func (c *Client) GetComputerInventoryCollectionSettingsV2(ctx context.Context) (*ComputerInventoryCollectionSettingsV2, error)

GetComputerInventoryCollectionSettingsV2 returns computer inventory settings.

Required privileges: computer-inventory-collection-settings:read. Legacy Jamf Pro privilege name(s): Read Computer Inventory Collection Settings.

func (*Client) GetComputerInventoryDetailV3 deprecated 

func (c *Client) GetComputerInventoryDetailV3(ctx context.Context, id string) (*ComputerInventoryV3, error)

GetComputerInventoryDetailV3 return all sections of a computer.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerInventoryDetailV4 

func (c *Client) GetComputerInventoryDetailV4(ctx context.Context, id string) (*ComputerInventoryV4, error)

GetComputerInventoryDetailV4 return all sections of a computer.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerInventoryFileVaultV3 deprecated 

func (c *Client) GetComputerInventoryFileVaultV3(ctx context.Context, id string) (*ComputerInventoryFileVault, error)

GetComputerInventoryFileVaultV3 return FileVault information for a specific computer.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: disk-encryption-recovery-key:read. Legacy Jamf Pro privilege name(s): View Disk Encryption Recovery Key.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerInventoryFileVaultV4 

func (c *Client) GetComputerInventoryFileVaultV4(ctx context.Context, id string) (*ComputerInventoryFileVault, error)

GetComputerInventoryFileVaultV4 return FileVault information for a specific computer.

Required privileges: disk-encryption-recovery-key:read. Legacy Jamf Pro privilege name(s): View Disk Encryption Recovery Key.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerInventoryV3 deprecated 

func (c *Client) GetComputerInventoryV3(ctx context.Context, id string, section []string) (*ComputerInventoryV3, error)

GetComputerInventoryV3 return General section of a Computer.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: instance id of computer record.
  • section: section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&section=hardware. Allowed values: see the ComputerSectionV3 constants.

func (*Client) GetComputerInventoryV4 

func (c *Client) GetComputerInventoryV4(ctx context.Context, id string, section []string) (*ComputerInventoryV4, error)

GetComputerInventoryV4 return General section of a Computer.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: instance id of computer record.
  • section: section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&section=hardware. Allowed values: see the ComputerSectionV4 constants.

func (*Client) GetComputerPrestageScopeV2 

func (c *Client) GetComputerPrestageScopeV2(ctx context.Context, id string) (*PrestageScopeResponseV2, error)

GetComputerPrestageScopeV2 get device Scope for a specific Computer Prestage.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) GetComputerPrestageV3 

func (c *Client) GetComputerPrestageV3(ctx context.Context, id string) (*GetComputerPrestageV3, error)

GetComputerPrestageV3 retrieve a Computer Prestage with the supplied id.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) GetComputerRecoveryLockPasswordV3 deprecated 

func (c *Client) GetComputerRecoveryLockPasswordV3(ctx context.Context, id string) (*ComputerInventoryRecoveryLockPasswordResponse, error)

GetComputerRecoveryLockPasswordV3 return a Computers Recovery Lock Password.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: recovery-lock:read. Legacy Jamf Pro privilege name(s): View Recovery Lock.

Parameters:

  • id: instance id of computer record.

func (*Client) GetComputerRecoveryLockPasswordV4 

func (c *Client) GetComputerRecoveryLockPasswordV4(ctx context.Context, id string) (*ComputerInventoryRecoveryLockPasswordResponse, error)

GetComputerRecoveryLockPasswordV4 return a Computers Recovery Lock Password.

Required privileges: recovery-lock:read. Legacy Jamf Pro privilege name(s): View Recovery Lock.

Parameters:

  • id: instance id of computer record.

func (*Client) GetConditionalAccessComputerComplianceV1 

func (c *Client) GetConditionalAccessComputerComplianceV1(ctx context.Context, deviceID string) ([]DeviceComplianceInformation, error)

GetConditionalAccessComputerComplianceV1 get compliance information for a single computer device.

Required privileges: device-compliance-information:read. Legacy Jamf Pro privilege name(s): Read Device Compliance Information.

Parameters:

  • deviceID: ID of the device the query pertains.

func (*Client) GetConditionalAccessFeatureToggleV1 

func (c *Client) GetConditionalAccessFeatureToggleV1(ctx context.Context) (*SharedDeviceComplianceFeatureToggle, error)

GetConditionalAccessFeatureToggleV1 retrieves Status of the Feature Toggle.

Required privileges: conditional-access:read. Legacy Jamf Pro privilege name(s): Read Conditional Access.

func (*Client) GetConditionalAccessMobileComplianceV1 

func (c *Client) GetConditionalAccessMobileComplianceV1(ctx context.Context, deviceID string) ([]DeviceComplianceInformation, error)

GetConditionalAccessMobileComplianceV1 get compliance information for a single mobile device.

Required privileges: device-compliance-information:read. Legacy Jamf Pro privilege name(s): Read Device Compliance Information.

Parameters:

  • deviceID: ID of the device the query pertains.

func (*Client) GetCsaTenantIdV1 

func (c *Client) GetCsaTenantIdV1(ctx context.Context) (*CsaTenantIDInfo, error)

GetCsaTenantIdV1 returns the CSA tenant ID.

Required privileges: the spec declares none.

func (*Client) GetCsaTokenV1 

func (c *Client) GetCsaTokenV1(ctx context.Context) (*CsaToken, error)

GetCsaTokenV1 get details regarding the CSA token exchange.

Required privileges: cloud-services-settings:read. Legacy Jamf Pro privilege name(s): Read Cloud Services Settings.

func (*Client) GetDashboardV1 

func (c *Client) GetDashboardV1(ctx context.Context) (*DashboardSetup, error)

GetDashboardV1 get all the dashboard setup information.

Required privileges: the spec declares none.

func (*Client) GetDdmStatusItemV1 

func (c *Client) GetDdmStatusItemV1(ctx context.Context, clientManagementID string, key string) (*StatusItem, error)

GetDdmStatusItemV1 retrieve a Status Item from the latest Status Report for a device.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices, Read Computers. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • clientManagementID: client management id of the target device.
  • key: the status item key to retrieve.

func (*Client) GetDepartmentV1 

func (c *Client) GetDepartmentV1(ctx context.Context, id string) (*Department, error)

GetDepartmentV1 get specified Department object.

Required privileges: departments:read. Legacy Jamf Pro privilege name(s): Read Departments.

Parameters:

  • id: instance id of department record.

func (*Client) GetDeviceCommunicationSettingsV1 

func (c *Client) GetDeviceCommunicationSettingsV1(ctx context.Context) (*DeviceCommunicationSettings, error)

GetDeviceCommunicationSettingsV1 retrieves all settings for device communication.

Required privileges: mdm-profile-renewal-settings:read. Legacy Jamf Pro privilege name(s): Read Automatically Renew MDM Profile Settings.

func (*Client) GetDeviceEnrollmentPublicKeyV1 

func (c *Client) GetDeviceEnrollmentPublicKeyV1(ctx context.Context) ([]byte, error)

GetDeviceEnrollmentPublicKeyV1 retrieve the Jamf Pro Device Enrollment public key.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

func (*Client) GetDeviceEnrollmentV1 

func (c *Client) GetDeviceEnrollmentV1(ctx context.Context, id string) (*DeviceEnrollmentInstance, error)

GetDeviceEnrollmentV1 retrieve a Device Enrollment Instance with the supplied id.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) GetDeviceGroupsForDeviceV1 

func (c *Client) GetDeviceGroupsForDeviceV1(ctx context.Context, id string) ([]DeviceGroup, error)

GetDeviceGroupsForDeviceV1 return a list of groups for a device.

Required privileges: device-groups:read, devices:read. Legacy Jamf Pro privilege name(s): Read Computers, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Device Platform ID.

func (*Client) GetDigicertTrustLifecycleManagerConnectionStatusV1 

func (c *Client) GetDigicertTrustLifecycleManagerConnectionStatusV1(ctx context.Context, id string) (*DigicertConnectionStatus, error)

GetDigicertTrustLifecycleManagerConnectionStatusV1 get connection status of DigiCert Trust Lifecycle Manager for a given ID.

Required privileges: digicert-settings:read. Legacy Jamf Pro privilege name(s): Read DigiCert Settings.

Parameters:

  • id: ID of the DigiCert Trust Lifecycle Manager settings.

func (*Client) GetDigicertTrustLifecycleManagerDependenciesV1 

func (c *Client) GetDigicertTrustLifecycleManagerDependenciesV1(ctx context.Context, id string) (*DigicertDependencies, error)

GetDigicertTrustLifecycleManagerDependenciesV1 retrieve list of DigiCert Trust Lifecycle Manager Settings dependencies.

Required privileges: digicert-settings:read. Legacy Jamf Pro privilege name(s): Read DigiCert Settings.

Parameters:

  • id: ID of the DigiCert Trust Lifecycle Manager configuration.

func (*Client) GetDigicertTrustLifecycleManagerV1 

func (c *Client) GetDigicertTrustLifecycleManagerV1(ctx context.Context, id string) (*DigiCertSettingResponse, error)

GetDigicertTrustLifecycleManagerV1 retrieve DigiCert Trust Lifecycle Manager configuration.

Required privileges: digicert-settings:read. Legacy Jamf Pro privilege name(s): Read DigiCert Settings.

Parameters:

  • id: ID of the DigiCert Trust Lifecycle Manager configuration.

func (*Client) GetDistributionPointV1 

func (c *Client) GetDistributionPointV1(ctx context.Context, id string) (*DistributionPoint, error)

GetDistributionPointV1 get specified distribution point.

Required privileges: distribution-points:read. Legacy Jamf Pro privilege name(s): Read Distribution Points.

Parameters:

  • id: instance id of distribution point.

func (*Client) GetDockItemV1 

func (c *Client) GetDockItemV1(ctx context.Context, id string) (*DockItem, error)

GetDockItemV1 retrieve a full dockItem object.

Required privileges: dock-items:read. Legacy Jamf Pro privilege name(s): Read Dock Items.

Parameters:

  • id: DockItem object identifier.

func (*Client) GetDssDeclarationsV1 

func (c *Client) GetDssDeclarationsV1(ctx context.Context, declarationID string) (*DssDeclarations, error)

GetDssDeclarationsV1 retrieve an existing declaration.

Required privileges: declarations:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices, Read Computers. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • declarationID: Declaration UUID.

func (*Client) GetEbookScopeV1 

func (c *Client) GetEbookScopeV1(ctx context.Context, id string) (*EbookScope, error)

GetEbookScopeV1 get specified scope of Ebook object.

Required privileges: ebooks:read. Legacy Jamf Pro privilege name(s): Read eBooks.

Parameters:

  • id: instance id of ebook record.

func (*Client) GetEbookV1 

func (c *Client) GetEbookV1(ctx context.Context, id string) (*Ebook, error)

GetEbookV1 get specified Ebook object.

Required privileges: ebooks:read. Legacy Jamf Pro privilege name(s): Read eBooks.

Parameters:

  • id: instance id of ebook record.

func (*Client) GetEnableAllApnsClientsStatusV1 

func (c *Client) GetEnableAllApnsClientsStatusV1(ctx context.Context) (*ApnsPushEnableRequest, error)

GetEnableAllApnsClientsStatusV1 get status of enable all clients request.

Required privileges: device-actions:read. Legacy Jamf Pro privilege name(s): View MDM command information in Jamf Pro API.

func (*Client) GetEnrollmentAccessGroupV3 

func (c *Client) GetEnrollmentAccessGroupV3(ctx context.Context, id string) (*EnrollmentAccessGroupPreview, error)

GetEnrollmentAccessGroupV3 retrieve the configured LDAP groups configured for User-Initiated Enrollment.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

Parameters:

  • id: Autogenerated Access Group ID.

func (*Client) GetEnrollmentAccessManagementV4 

func (c *Client) GetEnrollmentAccessManagementV4(ctx context.Context) (*AccessManagementSetting, error)

GetEnrollmentAccessManagementV4 get Access Management settings.

Required privileges: access-management:read. Legacy Jamf Pro privilege name(s): Access Management Setting Read.

func (*Client) GetEnrollmentCustomizationLdapPanelV1 

func (c *Client) GetEnrollmentCustomizationLdapPanelV1(ctx context.Context, id string, panelID string) (*GetEnrollmentCustomizationPanelLdapAuth, error)

GetEnrollmentCustomizationLdapPanelV1 get a single LDAP panel for a single Enrollment Customization.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) GetEnrollmentCustomizationPanelV1 

func (c *Client) GetEnrollmentCustomizationPanelV1(ctx context.Context, id string, panelID string) (*GetEnrollmentCustomizationPanel, error)

GetEnrollmentCustomizationPanelV1 get a single Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) GetEnrollmentCustomizationSsoPanelV1 

func (c *Client) GetEnrollmentCustomizationSsoPanelV1(ctx context.Context, id string, panelID string) (*GetEnrollmentCustomizationPanelSsoAuth, error)

GetEnrollmentCustomizationSsoPanelV1 get a single SSO Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) GetEnrollmentCustomizationTextPanelMarkdownV1 

func (c *Client) GetEnrollmentCustomizationTextPanelMarkdownV1(ctx context.Context, id string, panelID string) (*Markdown, error)

GetEnrollmentCustomizationTextPanelMarkdownV1 get the markdown output of a single Text Panel for a single Enrollment.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) GetEnrollmentCustomizationTextPanelV1 

func (c *Client) GetEnrollmentCustomizationTextPanelV1(ctx context.Context, id string, panelID string) (*GetEnrollmentCustomizationPanelText, error)

GetEnrollmentCustomizationTextPanelV1 get a single Text Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) GetEnrollmentCustomizationV2 

func (c *Client) GetEnrollmentCustomizationV2(ctx context.Context, id string) (*EnrollmentCustomizationV2, error)

GetEnrollmentCustomizationV2 retrieve an Enrollment Customization with the supplied id.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) GetEnrollmentLanguageV3 

func (c *Client) GetEnrollmentLanguageV3(ctx context.Context, languageID string) (*EnrollmentProcessTextObject, error)

GetEnrollmentLanguageV3 retrieve the Enrollment messaging for a language.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

Parameters:

  • languageID: Two letter ISO 639-1 Language Code.

func (*Client) GetEnrollmentSettingsV4 

func (c *Client) GetEnrollmentSettingsV4(ctx context.Context) (*EnrollmentSettingsV4, error)

GetEnrollmentSettingsV4 get Enrollment object and Re-enrollment settings.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

func (*Client) GetGSXConnectionV1 

func (c *Client) GetGSXConnectionV1(ctx context.Context) (*GsxConnection, error)

GetGSXConnectionV1 finds the Jamf Pro GSX Connection information.

Required privileges: gsx-connection:read, push-certificates:read. Legacy Jamf Pro privilege name(s): Read GSX Connection, Read Push Certificates. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) GetGroupV2 

func (c *Client) GetGroupV2(ctx context.Context, id string) (*GroupWithCriteriaDtoV1, error)

GetGroupV2 returns group information for the given platform UUID.

Required privileges: device-groups:read.

Parameters:

  • id: The platform UUID of a group.

func (*Client) GetHealthStatusV1 

func (c *Client) GetHealthStatusV1(ctx context.Context) (*HealthStatus, error)

GetHealthStatusV1 retrieve request acceptance ratios for this Jamf Pro node.

Required privileges: the spec declares none.

func (*Client) GetIOSBrandingConfigurationV1 

func (c *Client) GetIOSBrandingConfigurationV1(ctx context.Context, id string) (*IosBrandingConfiguration, error)

GetIOSBrandingConfigurationV1 read a single Self Service iOS branding configuration indicated by the provided id.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service Branding Configuration.

Parameters:

  • id: id of iOS branding configuration.

func (*Client) GetIconV1 

func (c *Client) GetIconV1(ctx context.Context, id string) (*IconResponse, error)

GetIconV1 get an icon.

Required privileges: the spec declares none.

Parameters:

  • id: id of the icon.

func (*Client) GetImpactAlertNotificationSettingsV1 

func (c *Client) GetImpactAlertNotificationSettingsV1(ctx context.Context) (*ImpactAlertNotificationSettingsV1, error)

GetImpactAlertNotificationSettingsV1 get Impact Alert Notification Settings.

Required privileges: impact-alert-notification-settings:read. Legacy Jamf Pro privilege name(s): Read Impact Alert Notification Settings.

func (*Client) GetInventoryInformationV1 

func (c *Client) GetInventoryInformationV1(ctx context.Context) (*InventoryInformation, error)

GetInventoryInformationV1 get statistics about managed/unmanaged devices and computers in the inventory.

Required privileges: the spec declares none.

func (*Client) GetInventoryPreloadRecordV2 

func (c *Client) GetInventoryPreloadRecordV2(ctx context.Context, id string) (*InventoryPreloadRecordV2, error)

GetInventoryPreloadRecordV2 get an Inventory Preload record.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

Parameters:

  • id: Inventory Preload identifier.

func (*Client) GetJCDSFileDownloadURLV1 deprecated 

func (c *Client) GetJCDSFileDownloadURLV1(ctx context.Context, fileName string) (*DownloadURL, error)

GetJCDSFileDownloadURLV1 retrieve a download URL for a specific file from the Jamf Cloud Distribution Service.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-08-28) and may be removed in a future release.

Required privileges: jamf-cloud-distribution-service-files:read. Legacy Jamf Pro privilege name(s): Read Jamf Cloud Distribution Service Files.

Parameters:

  • fileName: Name of the file stored in the Jamf Cloud Distribution Service.

func (*Client) GetJamfConnectSettingsV1 

func (c *Client) GetJamfConnectSettingsV1(ctx context.Context) error

GetJamfConnectSettingsV1 get the Jamf Connect settings that you have access to see.

Required privileges: jamf-connect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Connect Settings, Read Jamf Connect Deployments. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) GetJamfPackageV2 

func (c *Client) GetJamfPackageV2(ctx context.Context, application string) (*JamfApplicationResponse, error)

GetJamfPackageV2 get the packages for a given Jamf application.

Required privileges: jamf-packages-action:read. Legacy Jamf Pro privilege name(s): Jamf Packages Action.

Parameters:

  • application: The Jamf Application key. The only supported values are protect and connect.

func (*Client) GetJamfProInformationV2 

func (c *Client) GetJamfProInformationV2(ctx context.Context) (*JamfProInformationV2, error)

GetJamfProInformationV2 get basic information about the Jamf Pro Server.

Required privileges: the spec declares none.

func (*Client) GetJamfProServerURLV1 

func (c *Client) GetJamfProServerURLV1(ctx context.Context) (*JamfProServerURL, error)

GetJamfProServerURLV1 get Jamf Pro Server URL settings.

Required privileges: jss-url:read. Legacy Jamf Pro privilege name(s): Read JSS URL.

func (*Client) GetJamfProVersionV1 

func (c *Client) GetJamfProVersionV1(ctx context.Context) (*JamfProVersion, error)

GetJamfProVersionV1 return information about the Jamf Pro including the current version.

Required privileges: the spec declares none.

func (*Client) GetJamfProtectSettingsV1 

func (c *Client) GetJamfProtectSettingsV1(ctx context.Context) (*ProtectSettingsResponse, error)

GetJamfProtectSettingsV1 jamf Protect integration settings.

Required privileges: jamf-protect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Protect Settings, Read Jamf Protect Deployments. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) GetJamfRemoteAssistSessionV1 

func (c *Client) GetJamfRemoteAssistSessionV1(ctx context.Context, id string) (*SessionHistoryItemWithDetails, error)

GetJamfRemoteAssistSessionV1 gets single session history item.

Required privileges: remote-assist:read. Legacy Jamf Pro privilege name(s): Read Remote Assist.

Parameters:

  • id: instance id of session.

func (*Client) GetJamfRemoteAssistSessionV2 

func (c *Client) GetJamfRemoteAssistSessionV2(ctx context.Context, id string) (*SessionHistoryItemWithDetails, error)

GetJamfRemoteAssistSessionV2 gets single session history item.

Required privileges: remote-assist:read. Legacy Jamf Pro privilege name(s): Read Remote Assist.

Parameters:

  • id: instance id of session.

func (*Client) GetLastLoginV1 

func (c *Client) GetLastLoginV1(ctx context.Context) (*LastLoginResponse, error)

GetLastLoginV1 get the date of the last login event.

Required privileges: user-sessions:read. Legacy Jamf Pro privilege name(s): Read Last Login.

func (*Client) GetLatestDeviceEnrollmentSyncV1 

func (c *Client) GetLatestDeviceEnrollmentSyncV1(ctx context.Context, id string) (*DeviceEnrollmentInstanceSyncStatus, error)

GetLatestDeviceEnrollmentSyncV1 get the latest sync state for a single Device Enrollment Instance.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) GetLatestMobileDevicePrestageSyncV2 

func (c *Client) GetLatestMobileDevicePrestageSyncV2(ctx context.Context, id string) (*PrestageSyncStatusV2, error)

GetLatestMobileDevicePrestageSyncV2 get the latest Sync State for a single Prestage.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) GetLocalAdminPasswordByGuidV2 

func (c *Client) GetLocalAdminPasswordByGuidV2(ctx context.Context, clientManagementID string, username string, guid string) (*LapsPasswordResponseV2, error)

GetLocalAdminPasswordByGuidV2 get current LAPS password for specified user guid on a client.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password.

Parameters:

  • clientManagementID: client management id of target device.
  • username: user name for the account.
  • guid: user guid for the account.

func (*Client) GetLocalAdminPasswordSettingsV2 

func (c *Client) GetLocalAdminPasswordSettingsV2(ctx context.Context) (*LapsSettingsResponseV2, error)

GetLocalAdminPasswordSettingsV2 get the current LAPS settings.

Required privileges: local-admin-passwords:update. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment, Update Local Admin Password Settings. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) GetLocalAdminPasswordV2 

func (c *Client) GetLocalAdminPasswordV2(ctx context.Context, clientManagementID string, username string) (*LapsPasswordResponseV2, error)

GetLocalAdminPasswordV2 get current LAPS password for specified username on a client.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password.

Parameters:

  • clientManagementID: client management id of target device.
  • username: user name for the account.

func (*Client) GetLogFlushingTaskV1 

func (c *Client) GetLogFlushingTaskV1(ctx context.Context, id string) (*LogFlushingTaskV1, error)

GetLogFlushingTaskV1 get log flushing task.

Required privileges: retention-policy:read. Legacy Jamf Pro privilege name(s): Read Retention Policy.

Parameters:

  • id: The identifier of the log flushing task.

func (*Client) GetLogFlushingV1 

func (c *Client) GetLogFlushingV1(ctx context.Context) (*LogFlushingV1, error)

GetLogFlushingV1 get log flushing settings.

Required privileges: retention-policy:read. Legacy Jamf Pro privilege name(s): Read Retention Policy.

func (*Client) GetLoginCustomizationV1 

func (c *Client) GetLoginCustomizationV1(ctx context.Context) (*LoginContent, error)

GetLoginCustomizationV1 get current login disclaimer settings.

Required privileges: the spec declares none.

func (*Client) GetM2MTenantIDV1 

func (c *Client) GetM2MTenantIDV1(ctx context.Context) (*M2mTenantIDInfo, error)

GetM2MTenantIDV1 returns the M2M-sourced tenant ID.

Required privileges: m2m:read.

func (*Client) GetMacOSBrandingConfigurationV1 

func (c *Client) GetMacOSBrandingConfigurationV1(ctx context.Context, id string) (*MacOsBrandingConfiguration, error)

GetMacOSBrandingConfigurationV1 read a single Self Service macOS branding configuration indicated by the provided id.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service Branding Configuration.

Parameters:

  • id: id of macOS branding configuration.

func (*Client) GetManagedSoftwareUpdateFeatureToggleStatusV1 

func (c *Client) GetManagedSoftwareUpdateFeatureToggleStatusV1(ctx context.Context) (*ManagedSoftwareUpdatePlanToggleStatusWrapper, error)

GetManagedSoftwareUpdateFeatureToggleStatusV1 retrieves background status of the Feature Toggle.

Required privileges: managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates.

func (*Client) GetManagedSoftwareUpdateFeatureToggleV1 

func (c *Client) GetManagedSoftwareUpdateFeatureToggleV1(ctx context.Context) (*ManagedSoftwareUpdatePlanToggle, error)

GetManagedSoftwareUpdateFeatureToggleV1 retrieve current value of the Feature Toggle.

Required privileges: managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates.

func (*Client) GetManagedSoftwareUpdateGroupPlansV1 

func (c *Client) GetManagedSoftwareUpdateGroupPlansV1(ctx context.Context, id string, groupType string) (*ManagedSoftwareUpdatePlans, error)

GetManagedSoftwareUpdateGroupPlansV1 retrieve Managed Software Update Plans for a Group.

Required privileges: device-groups:read, devices:read, managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Read Computers, Read Smart Computer Groups, Read Static Computer Groups, Read Mobile Devices, Read Smart Mobile Device Groups, Read Static Mobile Device Groups. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Managed Software Update Group Id.
  • groupType: Managed Software Update Group Type, Available options are "COMPUTER_GROUP" or "MOBILE_DEVICE_GROUP". Allowed values: "COMPUTER_GROUP", "MOBILE_DEVICE_GROUP".

func (*Client) GetManagedSoftwareUpdatePlanDeclarationsV1 

func (c *Client) GetManagedSoftwareUpdatePlanDeclarationsV1(ctx context.Context, id string) (*DssDeclarations, error)

GetManagedSoftwareUpdatePlanDeclarationsV1 retrieve all Declarations associated with a Managed Software Update Plan.

Required privileges: devices:read, managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Read Computers, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Managed Software Update Plan Uuid.

func (*Client) GetManagedSoftwareUpdatePlanEventsV1 

func (c *Client) GetManagedSoftwareUpdatePlanEventsV1(ctx context.Context, id string) (*ManagedSoftwareUpdatePlanEventStore, error)

GetManagedSoftwareUpdatePlanEventsV1 retrieve a Managed Software Update Plan Event Store.

Required privileges: devices:read, managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Read Computers, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Managed Software Update Plan Uuid.

func (*Client) GetManagedSoftwareUpdatePlanV1 

func (c *Client) GetManagedSoftwareUpdatePlanV1(ctx context.Context, id string) (*ManagedSoftwareUpdatePlan, error)

GetManagedSoftwareUpdatePlanV1 retrieve a Managed Software Update Plan.

Required privileges: devices:read, managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Read Computers, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Managed Software Update Plan Uuid.

func (*Client) GetManagedSoftwareUpdateStatusesForComputerGroupV1 

func (c *Client) GetManagedSoftwareUpdateStatusesForComputerGroupV1(ctx context.Context, id string) (*ManagedSoftwareUpdateStatuses, error)

GetManagedSoftwareUpdateStatusesForComputerGroupV1 retrieve Managed Software Update Statuses for Computer Groups.

Required privileges: device-groups:read, devices:read. Legacy Jamf Pro privilege name(s): Read Computers, Read Smart Computer Groups, Read Static Computer Groups. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Computer Group identifier.

func (*Client) GetManagedSoftwareUpdateStatusesForComputerV1 

func (c *Client) GetManagedSoftwareUpdateStatusesForComputerV1(ctx context.Context, id string) (*ManagedSoftwareUpdateStatuses, error)

GetManagedSoftwareUpdateStatusesForComputerV1 retrieve Managed Software Update Statuses for Computers.

Required privileges: managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • id: Computer identifier.

func (*Client) GetManagedSoftwareUpdateStatusesForMobileDeviceGroupV1 

func (c *Client) GetManagedSoftwareUpdateStatusesForMobileDeviceGroupV1(ctx context.Context, id string) (*ManagedSoftwareUpdateStatuses, error)

GetManagedSoftwareUpdateStatusesForMobileDeviceGroupV1 retrieve Managed Software Update Statuses for Mobile Device Groups.

Required privileges: device-groups:read, devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices, Read Smart Mobile Device Groups, Read Static Mobile Device Groups. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Mobile Device Group identifier.

func (*Client) GetManagedSoftwareUpdateStatusesForMobileDeviceV1 

func (c *Client) GetManagedSoftwareUpdateStatusesForMobileDeviceV1(ctx context.Context, id string) (*ManagedSoftwareUpdateStatuses, error)

GetManagedSoftwareUpdateStatusesForMobileDeviceV1 retrieve Managed Software Update Statuses for Mobile Devices.

Required privileges: managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices.

Parameters:

  • id: Mobile Device identifier.

func (*Client) GetMdmRenewalDeviceCommonDetailsV1 

func (c *Client) GetMdmRenewalDeviceCommonDetailsV1(ctx context.Context, clientManagementID string) (*DeviceCommonDetails, error)

GetMdmRenewalDeviceCommonDetailsV1 get device common details for a client management ID.

Required privileges: device-actions:read. Legacy Jamf Pro privilege name(s): Send Command to Renew MDM Profile.

Parameters:

  • clientManagementID: The client management ID to retrieve device common details for.

func (*Client) GetMdmRenewalStrategiesV1 

func (c *Client) GetMdmRenewalStrategiesV1(ctx context.Context, clientManagementID string) ([]MDMRenewalErrorStrategiesResponse, error)

GetMdmRenewalStrategiesV1 get MDM renewal errors and strategies for a client management ID.

Required privileges: device-actions:read. Legacy Jamf Pro privilege name(s): Send Command to Renew MDM Profile.

Parameters:

  • clientManagementID: The client management ID to retrieve renewal strategies for.

func (*Client) GetMobileDeviceDetailV2 

func (c *Client) GetMobileDeviceDetailV2(ctx context.Context, id string) (*MobileDeviceDetailsGetV2, error)

GetMobileDeviceDetailV2 get Mobile Device.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices.

Parameters:

  • id: instance id of mobile device record.

func (*Client) GetMobileDeviceExtensionAttributeDataDependencyV1 

func (c *Client) GetMobileDeviceExtensionAttributeDataDependencyV1(ctx context.Context, id string) (*DependencyObjectResults, error)

GetMobileDeviceExtensionAttributeDataDependencyV1 get smart group dependent object for a specified mobile device extension attribute.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Mobile Device Extension Attributes.

Parameters:

  • id: Unique ID of mobile device extension attribute.

func (*Client) GetMobileDeviceExtensionAttributeV1 

func (c *Client) GetMobileDeviceExtensionAttributeV1(ctx context.Context, id string) (*MobileDeviceExtensionAttributes, error)

GetMobileDeviceExtensionAttributeV1 get specified Mobile Device Extension Attribute object.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Mobile Device Extension Attributes.

Parameters:

  • id: Unique ID of Mobile Device Extension Attribute.

func (*Client) GetMobileDevicePrestageScopeV2 

func (c *Client) GetMobileDevicePrestageScopeV2(ctx context.Context, id string) (*PrestageScopeResponseV2, error)

GetMobileDevicePrestageScopeV2 get Device Scope for a specific Mobile Device Prestage.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) GetMobileDevicePrestageV3 

func (c *Client) GetMobileDevicePrestageV3(ctx context.Context, id string) (*GetMobileDevicePrestageV3, error)

GetMobileDevicePrestageV3 retrieve a Mobile Device Prestage with the supplied id.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) GetMobileDeviceV2 

func (c *Client) GetMobileDeviceV2(ctx context.Context, id string) (*MobileDeviceV2, error)

GetMobileDeviceV2 get Mobile Device.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices.

Parameters:

  • id: instance id of mobile device record.

func (*Client) GetOidcDirectIdpLoginUrlV1 

func (c *Client) GetOidcDirectIdpLoginUrlV1(ctx context.Context) (*OidcDirectIdpLoginSkipURL, error)

GetOidcDirectIdpLoginUrlV1 retrieve the URL to directly login to the IdP.

Required privileges: the spec declares none.

func (*Client) GetOidcPublicFeaturesV1 

func (c *Client) GetOidcPublicFeaturesV1(ctx context.Context) (*OidcPublicFeaturesResponse, error)

GetOidcPublicFeaturesV1 get the public features of the OIDC configuration.

Required privileges: the spec declares none.

func (*Client) GetOidcPublicKeyV1 

func (c *Client) GetOidcPublicKeyV1(ctx context.Context) (*OidcJwksResponse, error)

GetOidcPublicKeyV1 get the public key of the keystore used for signing OIDC messages as a JWT.

Required privileges: the spec declares none.

func (*Client) GetOnboardingV1 

func (c *Client) GetOnboardingV1(ctx context.Context) (*OnboardingConfiguration, error)

GetOnboardingV1 get the current onboarding settings configuration.

Required privileges: onboarding:read. Legacy Jamf Pro privilege name(s): Read Onboarding Configuration.

func (*Client) GetPackageV1 

func (c *Client) GetPackageV1(ctx context.Context, id string) (*Package, error)

GetPackageV1 get specified Package object.

Required privileges: packages:read. Legacy Jamf Pro privilege name(s): Read Packages.

Parameters:

  • id: instance id of package.

func (*Client) GetParentAppSettingsV1 

func (c *Client) GetParentAppSettingsV1(ctx context.Context) (*ParentApp, error)

GetParentAppSettingsV1 get the current Jamf Parent app settings.

Required privileges: parent-app:read. Legacy Jamf Pro privilege name(s): Read Parent App Settings.

func (*Client) GetPatchPolicyDashboardStatusV2 

func (c *Client) GetPatchPolicyDashboardStatusV2(ctx context.Context, id string) (*PatchPolicyV2OnDashboard, error)

GetPatchPolicyDashboardStatusV2 return whether or not the requested patch policy is on the dashboard.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.

func (*Client) GetPatchPolicyEligibleRetryCountV2 

func (c *Client) GetPatchPolicyEligibleRetryCountV2(ctx context.Context, id string) (*PatchPolicyLogEligibleRetryCount, error)

GetPatchPolicyEligibleRetryCountV2 return the count of the Patch Policy Logs for the patch policy id that are eligible for a retry attempt.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.

func (*Client) GetPatchPolicyLogForDeviceV2 

func (c *Client) GetPatchPolicyLogForDeviceV2(ctx context.Context, id string, deviceID string) (*PatchPolicyLogV2, error)

GetPatchPolicyLogForDeviceV2 retrieves a single Patch Policy Log.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.
  • deviceID: device id.

func (*Client) GetPatchSoftwareTitleConfigurationV3 

func (c *Client) GetPatchSoftwareTitleConfigurationV3(ctx context.Context, id string) (*PatchSoftwareTitleConfiguration, error)

GetPatchSoftwareTitleConfigurationV3 retrieve Patch Software Title Configurations with the supplied id.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configurations identifier.

func (*Client) GetPatchSoftwareTitleDashboardStatusV3 

func (c *Client) GetPatchSoftwareTitleDashboardStatusV3(ctx context.Context, id string) (*SoftwareTitleConfigurationOnDashboard, error)

GetPatchSoftwareTitleDashboardStatusV3 return whether or not the requested software title configuration is on the dashboard.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: software title configuration id.

func (*Client) GetPatchSoftwareTitleDependenciesV3 

func (c *Client) GetPatchSoftwareTitleDependenciesV3(ctx context.Context, id string) (*PatchSoftwareTitleConfigurationDependencies, error)

GetPatchSoftwareTitleDependenciesV3 retrieve list of Patch Software Title Configuration Dependencies.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configuration Id.

func (*Client) GetPatchSoftwareTitlePatchSummaryV3 

func (c *Client) GetPatchSoftwareTitlePatchSummaryV3(ctx context.Context, id string) (*PatchSummary, error)

GetPatchSoftwareTitlePatchSummaryV3 return Active Patch Summary.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch id.

func (*Client) GetPolicyPropertiesV1 

func (c *Client) GetPolicyPropertiesV1(ctx context.Context) (*PolicyPropertiesV1, error)

GetPolicyPropertiesV1 get Policy Properties object.

Required privileges: policies:read. Legacy Jamf Pro privilege name(s): Read Policies.

func (*Client) GetReenrollmentSettingsV1 

func (c *Client) GetReenrollmentSettingsV1(ctx context.Context) (*Reenrollment, error)

GetReenrollmentSettingsV1 get Re-enrollment object.

Required privileges: re-enrollment:read. Legacy Jamf Pro privilege name(s): Read Re-enrollment.

func (*Client) GetReturnToServiceConfigurationV1 

func (c *Client) GetReturnToServiceConfigurationV1(ctx context.Context, id string) (*ReturnToServiceConfiguration, error)

GetReturnToServiceConfigurationV1 retrieve a Return to Service Configuration with the supplied id.

Required privileges: return-to-service:read. Legacy Jamf Pro privilege name(s): View Return To Service Configurations.

Parameters:

  • id: Return to Service Configuration identifier.

func (*Client) GetSchedulerJobTriggersV1 

func (c *Client) GetSchedulerJobTriggersV1(ctx context.Context, jobKey string, sort []string, filter string) (*SchedulerJob, error)

GetSchedulerJobTriggersV1 retrieve all triggers for a Jamf Pro Scheduler job.

Required privileges: the spec declares none.

Parameters:

  • jobKey: Jamf Pro Scheduler Job Key.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is nextFireTime:asc. If using multiple criteria, separate with commas.
  • filter: Query in the RSQL format, allowing to filter the Jamf Pro Scheduler triggers collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: triggerKey, previousFireTime, nextFireTime.

func (*Client) GetSchedulerJobsV1 

func (c *Client) GetSchedulerJobsV1(ctx context.Context) (*SchedulerJobs, error)

GetSchedulerJobsV1 retrieve all Jamf Pro Scheduler jobs.

Required privileges: the spec declares none.

func (*Client) GetSchedulerSummaryV1 

func (c *Client) GetSchedulerSummaryV1(ctx context.Context) (*SchedulerSummary, error)

GetSchedulerSummaryV1 retrieve a summary of the Jamf Pro Scheduler.

Required privileges: the spec declares none.

func (*Client) GetScriptV1 

func (c *Client) GetScriptV1(ctx context.Context, id string) (*Script, error)

GetScriptV1 retrieve a full script object.

Required privileges: scripts:read. Legacy Jamf Pro privilege name(s): Read Scripts.

Parameters:

  • id: Script object identifier.

func (*Client) GetSelfServicePlusFeatureToggleEnabledV1 

func (c *Client) GetSelfServicePlusFeatureToggleEnabledV1(ctx context.Context) error

GetSelfServicePlusFeatureToggleEnabledV1 determines if Self Service Plus feature toggle is enabled.

Required privileges: the spec declares none.

func (*Client) GetSelfServicePlusSettingsV1 

func (c *Client) GetSelfServicePlusSettingsV1(ctx context.Context) (*SelfServicePlusSettings, error)

GetSelfServicePlusSettingsV1 get Self Service Plus settings.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service.

func (*Client) GetSelfServiceSettingsV1 

func (c *Client) GetSelfServiceSettingsV1(ctx context.Context) (*SelfServiceSettings, error)

GetSelfServiceSettingsV1 get an object representation of Self Service settings.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service.

func (*Client) GetServiceDiscoveryEnrollmentWellKnownSettingsV1 

func (c *Client) GetServiceDiscoveryEnrollmentWellKnownSettingsV1(ctx context.Context) (*WellKnownSettingsResponse, error)

GetServiceDiscoveryEnrollmentWellKnownSettingsV1 get service discovery well-known settings for all organizations.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

func (*Client) GetSlasaAcceptanceV1 

func (c *Client) GetSlasaAcceptanceV1(ctx context.Context) (*SlasaAcceptance, error)

GetSlasaAcceptanceV1 get the status of SLASA.

Required privileges: the spec declares none.

func (*Client) GetSmartComputerGroupMembershipV3 

func (c *Client) GetSmartComputerGroupMembershipV3(ctx context.Context, id string) (*SmartGroupMembership, error)

GetSmartComputerGroupMembershipV3 get the membership of a Smart Computer Group.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Computer Groups.

Parameters:

  • id: id of the Smart Computer Group.

func (*Client) GetSmartComputerGroupV3 

func (c *Client) GetSmartComputerGroupV3(ctx context.Context, id string) (*SmartComputerGroupV3, error)

GetSmartComputerGroupV3 get Smart Computer Group by Id.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Computer Groups.

Parameters:

  • id: instance id of smart computer group.

func (*Client) GetSmartMobileDeviceGroupV2 

func (c *Client) GetSmartMobileDeviceGroupV2(ctx context.Context, id string) (*SmartGroupDetailV2, error)

GetSmartMobileDeviceGroupV2 get Smart Group by Id.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Mobile Device Groups.

Parameters:

  • id: instance id of smart-group.

func (*Client) GetSmtpServerV2 

func (c *Client) GetSmtpServerV2(ctx context.Context) (*SmtpServerV2, error)

GetSmtpServerV2 finds the Jamf Pro SMTP Server information.

Required privileges: smtp-server:read. Legacy Jamf Pro privilege name(s): Read SMTP Server.

func (*Client) GetSsoCertificateV2 

func (c *Client) GetSsoCertificateV2(ctx context.Context) (*SsoKeystoreResponseWithDetails, error)

GetSsoCertificateV2 retrieve the certificate currently configured for use with SSO.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

func (*Client) GetSsoDependenciesV3 

func (c *Client) GetSsoDependenciesV3(ctx context.Context) (*EnrollmentCustomizationDependencies, error)

GetSsoDependenciesV3 retrieve the list of Enrollment Customizations using SSO.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

func (*Client) GetSsoFailoverV1 

func (c *Client) GetSsoFailoverV1(ctx context.Context) (*SsoFailoverData, error)

GetSsoFailoverV1 retrieve the current failover settings.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

func (*Client) GetSsoOidcBrokerConfigV3 

func (c *Client) GetSsoOidcBrokerConfigV3(ctx context.Context) (*OidcBrokerConfig, error)

GetSsoOidcBrokerConfigV3 get the OIDC broker configuration.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

Published but not routed at the gateway: every call answers `403 BAD_PERMISSIONS`, whatever privileges the credential holds. `GET /v3/sso/dependencies` requires the same `sso-settings:read` and answers 200, so the gap is the route and not the grant, and no OIDC broker configuration is readable through the gateway until it is fixed. `TestAcceptance_Pro_SsoOidcBrokerConfigUnroutedAtGateway` fails the day the route appears, which is the notification to delete this note.

func (*Client) GetSsoSettingsV3 

func (c *Client) GetSsoSettingsV3(ctx context.Context) (*SsoSettingsV3, error)

GetSsoSettingsV3 retrieve the current Single Sign On configuration settings.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

func (*Client) GetStartupStatus 

func (c *Client) GetStartupStatus(ctx context.Context) (*StartupStatus, error)

GetStartupStatus retrieve information about application startup.

Required privileges: the spec declares none.

func (*Client) GetStaticComputerGroupV3 

func (c *Client) GetStaticComputerGroupV3(ctx context.Context, id string) (*StaticComputerGroup, error)

GetStaticComputerGroupV3 get Static Computer Group by Id.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Static Computer Groups.

Parameters:

  • id: instance id of static computer group.

func (*Client) GetStaticMobileDeviceGroupV2 

func (c *Client) GetStaticMobileDeviceGroupV2(ctx context.Context, id string) (*StaticGroup, error)

GetStaticMobileDeviceGroupV2 get Static Group by Id.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Static Mobile Device Groups.

Parameters:

  • id: instance id of static-group.

func (*Client) GetStaticUserGroupV1 

func (c *Client) GetStaticUserGroupV1(ctx context.Context, id string) (*StaticUserGroup, error)

GetStaticUserGroupV1 return a specific Static User Group by id.

Required privileges: user-groups:read. Legacy Jamf Pro privilege name(s): Read Static User Groups.

Parameters:

  • id: Instance id of static user group record.

func (*Client) GetSupervisionIdentityV1 

func (c *Client) GetSupervisionIdentityV1(ctx context.Context, id string) (*SupervisionIdentity, error)

GetSupervisionIdentityV1 retrieve a Supervision Identity with the supplied id.

Required privileges: apple-configurator-enrollment:read. Legacy Jamf Pro privilege name(s): Read Apple Configurator Enrollment.

Parameters:

  • id: Supervision Identity identifier.

func (*Client) GetTeacherAppSettingsV1 

func (c *Client) GetTeacherAppSettingsV1(ctx context.Context) (*TeacherSettingsResponse, error)

GetTeacherAppSettingsV1 get the Jamf Teacher settings that you have access to see.

Required privileges: teacher-app:read. Legacy Jamf Pro privilege name(s): Read Teacher App Settings.

func (*Client) GetTeamViewerConfigurationPreview 

func (c *Client) GetTeamViewerConfigurationPreview(ctx context.Context, id string) (*ConnectionConfigurationResponse, error)

GetTeamViewerConfigurationPreview get Team Viewer Remote Administration connection configuration.

Required privileges: remote-administration:read. Legacy Jamf Pro privilege name(s): Read Remote Administration.

Parameters:

  • id: ID of the Team Viewer connection configuration.

func (*Client) GetTeamViewerConfigurationStatusPreview 

func (c *Client) GetTeamViewerConfigurationStatusPreview(ctx context.Context, id string) (*ConnectionConfigurationStatusResponse, error)

GetTeamViewerConfigurationStatusPreview get Team Viewer Remote Administration connection status.

Required privileges: remote-administration:read. Legacy Jamf Pro privilege name(s): Read Remote Administration.

Parameters:

  • id: ID of the Team Viewer connection configuration.

func (*Client) GetTeamViewerSessionPreview 

func (c *Client) GetTeamViewerSessionPreview(ctx context.Context, configurationID string, sessionID string) (*SessionDetails, error)

GetTeamViewerSessionPreview get a session by its ID.

Required privileges: remote-administration:read. Legacy Jamf Pro privilege name(s): Read Remote Administration.

Parameters:

  • configurationID: ID of the Team Viewer connection configuration.
  • sessionID: ID of the Team Viewer session.

func (*Client) GetTeamViewerSessionStatusPreview 

func (c *Client) GetTeamViewerSessionStatusPreview(ctx context.Context, configurationID string, sessionID string) (*SessionStatus, error)

GetTeamViewerSessionStatusPreview get a session status by its ID.

Required privileges: remote-administration:read. Legacy Jamf Pro privilege name(s): Read Remote Administration.

Parameters:

  • configurationID: ID of the Team Viewer connection configuration.
  • sessionID: ID of the Team Viewer session.

func (*Client) GetUserPreferenceV1 

func (c *Client) GetUserPreferenceV1(ctx context.Context, keyID string) (*UserPreferencesJson, error)

GetUserPreferenceV1 get the user setting for the authenticated user and key.

Required privileges: the spec declares none.

Parameters:

  • keyID: user setting to be retrieved.

func (*Client) GetUserPreferencesSettingsV1 

func (c *Client) GetUserPreferencesSettingsV1(ctx context.Context, keyID string) (*UserPreferencesSettings, error)

GetUserPreferencesSettingsV1 get the user preferences for the authenticated user and key.

Required privileges: the spec declares none.

Parameters:

  • keyID: user setting to be retrieved.

func (*Client) GetUserSessionV1 

func (c *Client) GetUserSessionV1(ctx context.Context) ([]Account, error)

GetUserSessionV1 return all Jamf Pro user acounts.

Required privileges: accounts:read. Legacy Jamf Pro privilege name(s): Read Accounts.

func (*Client) GetUserV1 

func (c *Client) GetUserV1(ctx context.Context, id string, platform bool) (*User, error)

GetUserV1 retrieve a user by ID.

Required privileges: users:read. Legacy Jamf Pro privilege name(s): Read User.

Parameters:

  • id: ID of the user to retrieve.
  • platform: Optional. Return platform identifiers instead of internal identifiers when set to true.

func (*Client) GetVenafiConnectionStatusV1 

func (c *Client) GetVenafiConnectionStatusV1(ctx context.Context, id string) (*VenafiServiceStatus, error)

GetVenafiConnectionStatusV1 tests the communication between Jamf Pro and a Jamf Pro PKI Proxy Server.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) GetVenafiDependentProfilesV1 

func (c *Client) GetVenafiDependentProfilesV1(ctx context.Context, id string) (*VenafiPkiPayloadRecordSearchResults, error)

GetVenafiDependentProfilesV1 get configuration profile data using specified Venafi CA object.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) GetVenafiJamfPublicKeyV1 

func (c *Client) GetVenafiJamfPublicKeyV1(ctx context.Context, id string) ([]byte, error)

GetVenafiJamfPublicKeyV1 downloads a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) GetVenafiProxyTrustStoreV1 

func (c *Client) GetVenafiProxyTrustStoreV1(ctx context.Context, id string) ([]byte, error)

GetVenafiProxyTrustStoreV1 downloads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) GetVenafiV1 

func (c *Client) GetVenafiV1(ctx context.Context, id string) (*VenafiCaRecord, error)

GetVenafiV1 retrieve a Venafi PKI configuration from Jamf Pro.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) GetVolumePurchasingLocationV1 

func (c *Client) GetVolumePurchasingLocationV1(ctx context.Context, id string) (*VolumePurchasingLocation, error)

GetVolumePurchasingLocationV1 retrieve a Volume Purchasing Location with the supplied id.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Location identifier.

func (*Client) GetVolumePurchasingSubscriptionV1 

func (c *Client) GetVolumePurchasingSubscriptionV1(ctx context.Context, id string) (*VolumePurchasingSubscription, error)

GetVolumePurchasingSubscriptionV1 retrieve a Volume Purchasing Subscription with the supplied id.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Subscription identifier.

func (*Client) HealthCheckV1 

func (c *Client) HealthCheckV1(ctx context.Context) error

HealthCheckV1 get Jamf Pro API status.

Required privileges: the spec declares none.

func (*Client) InitiateJCDSUploadV1 deprecated 

func (c *Client) InitiateJCDSUploadV1(ctx context.Context) (*Credentials, error)

InitiateJCDSUploadV1 initiate an upload to the Jamf Cloud Distribution Service.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-08-28) and may be removed in a future release.

Required privileges: jamf-cloud-distribution-service-files:create. Legacy Jamf Pro privilege name(s): Create Jamf Cloud Distribution Service Files.

func (*Client) IssueTomcatSslCertificate 

func (c *Client) IssueTomcatSslCertificate(ctx context.Context) error

IssueTomcatSslCertificate generate a SSL Certificate using Jamf Certificate Authority.

Required privileges: apache-tomcat-settings:update. Legacy Jamf Pro privilege name(s): Update Apache Tomcat Settings.

func (*Client) ListAccountGroupsV1 

func (c *Client) ListAccountGroupsV1(ctx context.Context, sort []string, filter string) ([]AccountGroupV1, error)

ListAccountGroupsV1 get account groups.

Required privileges: account-groups:read. Legacy Jamf Pro privilege name(s): Read Account Groups.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Accepts fields: id, name, siteId, ldapServerId.
  • filter: Query in the RSQL format to filter account groups collection. An empty query returns all results for the requested page. Supported fields: id, name, siteId, ldapServerId. Multiple conditions can be combined using logical operators. This parameter can be used with paging and sorting parameters. Example: name=="Admins" and siteId==-1.

func (*Client) ListAccountsV1 

func (c *Client) ListAccountsV1(ctx context.Context, sort []string, filter string) ([]UserAccount, error)

ListAccountsV1 get user accounts.

Required privileges: accounts:read. Legacy Jamf Pro privilege name(s): Read Accounts.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is username:desc. Multiple sort criteria are supported and must be separated with a comma. Accepts fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus. If any other field is passed it will be ignored in sorting operation and/or create unpredictable results.
  • filter: Query in the RSQL format to filter user accounts collection. An empty query returns all results for the requested page. Supported fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus. Multiple conditions can be combined using logical operators. This parameter can be used with paging and sorting parameters. Example: username=="admin" and accountStatus==Enabled and failedLoginAttempts==0.

func (*Client) ListActivationCodeHistoryV1 

func (c *Client) ListActivationCodeHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListActivationCodeHistoryV1 get Activation Code history object.

Required privileges: activation-code:read. Legacy Jamf Pro privilege name(s): Read License Information.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Fields allowed in the query: id, username, date, note, details Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,note:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListActiveUserSessionsV1 

func (c *Client) ListActiveUserSessionsV1(ctx context.Context) ([]ActiveUserSession, error)

ListActiveUserSessionsV1 get active user sessions.

Required privileges: user-sessions:read. Legacy Jamf Pro privilege name(s): Read User.

func (*Client) ListAdcsSettingsHistoryV1 

func (c *Client) ListAdcsSettingsHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListAdcsSettingsHistoryV1 get specified AD CS Settings history object.

Required privileges: ad-cs-settings:read. Legacy Jamf Pro privilege name(s): Read AD CS Settings.

Parameters:

  • id: ID of the AD CS Settings configuration.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListAdvancedMobileDeviceSearchChoicesV1 

func (c *Client) ListAdvancedMobileDeviceSearchChoicesV1(ctx context.Context, criteria string, site string, contains string) (*AdvancedSearchCriteriaChoices, error)

ListAdvancedMobileDeviceSearchChoicesV1 get Mobile Device Advanced Search criteria choices.

Required privileges: advanced-device-searches:read. Legacy Jamf Pro privilege name(s): Read Advanced Mobile Device Searches.

func (*Client) ListAdvancedMobileDeviceSearchesV1 

func (c *Client) ListAdvancedMobileDeviceSearchesV1(ctx context.Context) (*AdvancedSearchSearchResults, error)

ListAdvancedMobileDeviceSearchesV1 get Advanced Search objects.

Required privileges: advanced-device-searches:read. Legacy Jamf Pro privilege name(s): Read Advanced Mobile Device Searches.

func (*Client) ListAdvancedUserContentSearchesV1 

func (c *Client) ListAdvancedUserContentSearchesV1(ctx context.Context) (*AdvancedUserContentSearchSearchResults, error)

ListAdvancedUserContentSearchesV1 get All Advanced User Content Search objects.

Required privileges: advanced-user-searches:read. Legacy Jamf Pro privilege name(s): Read Advanced User Content Searches.

func (*Client) ListAllDeviceEnrollmentSyncsV1 

func (c *Client) ListAllDeviceEnrollmentSyncsV1(ctx context.Context) ([]DeviceEnrollmentInstanceSyncStatus, error)

ListAllDeviceEnrollmentSyncsV1 get all instance sync states for all Device Enrollment Instances.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

func (*Client) ListAllMobileDevicePrestageSyncsV2 

func (c *Client) ListAllMobileDevicePrestageSyncsV2(ctx context.Context) ([]PrestageSyncStatusV2, error)

ListAllMobileDevicePrestageSyncsV2 get all Prestage sync States for all prestages.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

func (*Client) ListApnsClientPushStatusesV1 

func (c *Client) ListApnsClientPushStatusesV1(ctx context.Context, sort []string, filter string) ([]ApnsClientPushStatus, error)

ListApnsClientPushStatusesV1 search for clients with push notifications disabled.

Required privileges: device-actions:read. Legacy Jamf Pro privilege name(s): View MDM command information in Jamf Pro API.

Parameters:

  • sort: Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. Sortable fields: pushDisabledTime, deviceType, managementId.
  • filter: Query in the RSQL format, allowing to filter results. Fields allowed in the query: deviceType, disabledAt, managementId. This param can be combined with paging and sorting. Example: filter=deviceType=="MOBILE_DEVICE" Example: filter=disabledAt>2024-11-01T00:00:00Z Example: filter=deviceType=="COMPUTER";disabledAt>2024-01-01T00:00:00Z.

func (*Client) ListAppInstallerDeploymentComputersV1 

func (c *Client) ListAppInstallerDeploymentComputersV1(ctx context.Context, id string, sort []string, filter string) ([]DeploymentComputer, error)

ListAppInstallerDeploymentComputersV1 get app Installers deployment computers.

Required privileges: applications:read, devices:read. Legacy Jamf Pro privilege name(s): Read Mac Applications, Read Computers. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: App Title deployment identifier.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=computerName:desc,status:asc.
  • filter: Query in the RSQL format, allowing to filter deployment computers collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: computerName, status. Example: computerName=="*mac*".

func (*Client) ListAppInstallerDeploymentHistoryV1 

func (c *Client) ListAppInstallerDeploymentHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListAppInstallerDeploymentHistoryV1 get specified App Installer deployment history object.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • id: instance id of App Installer deployment history record.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListAppInstallerDeploymentsV1 

func (c *Client) ListAppInstallerDeploymentsV1(ctx context.Context, sort []string, filter string) ([]AppTitleDeploymentSummary, error)

ListAppInstallerDeploymentsV1 read App Installer deployments summary.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:desc.
  • filter: Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `id`, `name`, `app.deployedVersion`, `app.bundleId`, `deploymentType`, `updateBehavior`, `app.versionAction`. Example: name=="*appInstaller*".

func (*Client) ListAppInstallerGlobalSettingsHistoryV1 

func (c *Client) ListAppInstallerGlobalSettingsHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListAppInstallerGlobalSettingsHistoryV1 get App Installer global settings history object.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListAppInstallerTitleVersionsV1 

func (c *Client) ListAppInstallerTitleVersionsV1(ctx context.Context, id string, startVersion string) (*AppTitleVersionsResult, error)

ListAppInstallerTitleVersionsV1 get ordered list of App Title versions available in the App Installers system.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • id: App Title identifier.
  • startVersion: endpoint will return only versions higher than start-version.

func (*Client) ListAppInstallerTitlesV1 

func (c *Client) ListAppInstallerTitlesV1(ctx context.Context, sort []string, filter string) ([]AppTitle, error)

ListAppInstallerTitlesV1 get a list of all App Titles available in the App Installers system.

Required privileges: applications:read. Legacy Jamf Pro privilege name(s): Read Mac Applications.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=titleName:desc,publisher:asc.
  • filter: Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, titleName, publisher, version. Example: titleName=="*appInstaller*".

func (*Client) ListAppRequestFormInputFieldsV1 

func (c *Client) ListAppRequestFormInputFieldsV1(ctx context.Context) (*AppRequestFormInputFieldSearchResults, error)

ListAppRequestFormInputFieldsV1 search for Form Input Fields.

Required privileges: app-request:read. Legacy Jamf Pro privilege name(s): Read App Request Settings.

func (*Client) ListAppStoreCountryCodesV1 

func (c *Client) ListAppStoreCountryCodesV1(ctx context.Context) (*CountryCodes, error)

ListAppStoreCountryCodesV1 return a list of Countries and the associated Codes.

Required privileges: the spec declares none.

func (*Client) ListAvailableOsUpdatesV1 

func (c *Client) ListAvailableOsUpdatesV1(ctx context.Context) (*AvailableOsUpdates, error)

ListAvailableOsUpdatesV1 retrieve available macOS and iOS Managed Software Updates.

Required privileges: the spec declares none.

func (*Client) ListBuildingHistoryV1 

func (c *Client) ListBuildingHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListBuildingHistoryV1 get specified Building History object.

Required privileges: buildings:read. Legacy Jamf Pro privilege name(s): Read Buildings.

Parameters:

  • id: instance id of building history record.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListBuildingsV1 

func (c *Client) ListBuildingsV1(ctx context.Context, sort []string, filter string) ([]Building, error)

ListBuildingsV1 search for sorted and paged Buildings.

Required privileges: buildings:read. Legacy Jamf Pro privilege name(s): Read Buildings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter buildings collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, streetAddress1, streetAddress2, city, stateProvince, zipPostalCode, country. This param can be combined with paging and sorting. Example: filter=city=="Chicago" and name=="*build*".

func (*Client) ListCategoriesV1 

func (c *Client) ListCategoriesV1(ctx context.Context, sort []string, filter string) ([]Category, error)

ListCategoriesV1 get Category objects.

Required privileges: categories:read, self-service:read. Legacy Jamf Pro privilege name(s): Read Categories, Read Self Service. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter categories collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, priority. This param can be combined with paging and sorting. Example: filter=name=="Apps*" and priority>=5.

func (*Client) ListCategoryHistoryV1 

func (c *Client) ListCategoryHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListCategoryHistoryV1 get specified Category history object.

Required privileges: categories:read. Legacy Jamf Pro privilege name(s): Read Categories.

Parameters:

  • id: instance id of category history record.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListCheckInHistoryV3 

func (c *Client) ListCheckInHistoryV3(ctx context.Context, sort []string, filter string) ([]ObjectHistoryV1, error)

ListCheckInHistoryV3 get Client Check-In history object.

Required privileges: computer-check-in:read. Legacy Jamf Pro privilege name(s): Read Computer Check-In.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListCloudDistributionPointFilesV1 

func (c *Client) ListCloudDistributionPointFilesV1(ctx context.Context, sort []string, filter string) ([]CloudDistributionPointInventoryFileInfo, error)

ListCloudDistributionPointFilesV1 get the cloud distribution point Inventory files details.

Required privileges: cloud-distribution-point:read. Legacy Jamf Pro privilege name(s): Read Cloud Distribution Point.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas. Allows sort for id, fileName, inventoryId and type etc.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including fileName and type Can be combined with paging and sorting. Fields allowed in the query: fileName, inventoryId and type Default filter is an empty query and returns all results from the requested page.

func (*Client) ListCloudDistributionPointHistoryV1 

func (c *Client) ListCloudDistributionPointHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListCloudDistributionPointHistoryV1 get cloud distribution point history details.

Required privileges: cloud-distribution-point:read. Legacy Jamf Pro privilege name(s): Read Cloud Distribution Point.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListCloudIdpHistoryV1 

func (c *Client) ListCloudIdpHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListCloudIdpHistoryV1 get Cloud Identity Provider history.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListCloudIdpV1 

func (c *Client) ListCloudIdpV1(ctx context.Context, sort []string) ([]CloudIDPCommonResponse, error)

ListCloudIdpV1 get information about all Cloud Identity Providers configurations.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListComputerExtensionAttributeHistoryV1 

func (c *Client) ListComputerExtensionAttributeHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListComputerExtensionAttributeHistoryV1 get specified Computer Extension Attribute History object.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • id: Instance ID of Computer Extension Attribute history.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListComputerExtensionAttributeTemplatesV1 

func (c *Client) ListComputerExtensionAttributeTemplatesV1(ctx context.Context, sort []string, filter string) ([]ComputerExtensionAttributeTemplates, error)

ListComputerExtensionAttributeTemplatesV1 retrieve All Computer Extension Attributes Templates.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is templateName:asc. If using multiple criteria, separate with commas. Allows sort for templateName and templateCategory.
  • filter: Filters results. Use RSQL format for queries. which allows filtering by multiple fields such as templateName, templateCategoryName. Can be combined with paging and sorting. Fields allowed in the query: templateName, templateCategoryName Default filter is an empty query and returns all results from the requested page.

func (*Client) ListComputerExtensionAttributesV1 

func (c *Client) ListComputerExtensionAttributesV1(ctx context.Context, sort []string, filter string) ([]ComputerExtensionAttributes, error)

ListComputerExtensionAttributesV1 retrieve Computer Extension Attributes.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Computer Extension Attributes.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is name:asc. If using multiple criteria, separate with commas. Allows sort for id and name.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, name Default filter is an empty query and returns all results from the requested page.

func (*Client) ListComputerGroupsV1 

func (c *Client) ListComputerGroupsV1(ctx context.Context) ([]ComputerGroup, error)

ListComputerGroupsV1 returns the list of all computer groups.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Computer Groups, Read Static Computer Groups. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) ListComputerInventoryFileVaultsV3 deprecated 

func (c *Client) ListComputerInventoryFileVaultsV3(ctx context.Context) ([]ComputerInventoryFileVault, error)

ListComputerInventoryFileVaultsV3 return paginated FileVault information for all computers.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: disk-encryption-recovery-key:read. Legacy Jamf Pro privilege name(s): View Disk Encryption Recovery Key.

func (*Client) ListComputerInventoryFileVaultsV4 

func (c *Client) ListComputerInventoryFileVaultsV4(ctx context.Context) ([]ComputerInventoryFileVault, error)

ListComputerInventoryFileVaultsV4 return paginated FileVault information for all computers.

Required privileges: disk-encryption-recovery-key:read. Legacy Jamf Pro privilege name(s): View Disk Encryption Recovery Key.

func (*Client) ListComputerPrestagesV3 

func (c *Client) ListComputerPrestagesV3(ctx context.Context, sort []string) ([]GetComputerPrestageV3, error)

ListComputerPrestagesV3 get sorted and paged Computer Prestages.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Computer PreStage Enrollments.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListComputersInventoryV3 deprecated 

func (c *Client) ListComputersInventoryV3(ctx context.Context, section []string, sort []string, filter string) ([]ComputerInventoryV3, error)

ListComputersInventoryV3 return paginated Computer Inventory records.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • section: section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE. Allowed values: see the ComputerSectionV3 constants.
  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `general.name:asc`. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`, `general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`, `general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`, `general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`, `hardware.make`, `hardware.model`, `operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `userAndLocation.realname`, `purchasing.lifeExpectancy`, `purchasing.warrantyDate`. Example: `sort=udid:desc,general.name:asc`.
  • filter: Query in the RSQL format, allowing to filter computer inventory collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`, `general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`, `general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`, `general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`, `general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`, `general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`, `hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`, `hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`, `operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`, `security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`, `userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`, `purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,. This param can be combined with paging and sorting. Example: `filter=general.name=="Orchard"`.

func (*Client) ListComputersInventoryV4 

func (c *Client) ListComputersInventoryV4(ctx context.Context, section []string, sort []string, filter string) ([]ComputerInventoryV4, error)

ListComputersInventoryV4 return paginated Computer Inventory records.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • section: section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE. Allowed values: see the ComputerSectionV4 constants.
  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `general.name:asc`. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`, `general.jamfBinaryVersion`, `general.lastCheckIn`, `general.lastContact`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`, `general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`, `general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`, `hardware.make`, `hardware.model`, `operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `userAndLocation.realname`, `purchasing.lifeExpectancy`, `purchasing.warrantyDate`. Example: `sort=udid:desc,general.name:asc`.
  • filter: Query in the RSQL format, allowing to filter computer inventory collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.awaitingConfiguration`, `general.barcode1`, `general.barcode2`, `general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`, `general.jamfBinaryVersion`, `general.lastCheckIn`, `general.lastContact`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`, `general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`, `general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`, `general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`, `hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`, `hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`, `operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`, `security.lockdownModeEnabled`, `security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`, `userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`, `purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,. This param can be combined with paging and sorting. Example: `filter=general.name=="Orchard"`.

func (*Client) ListDdmStatusItemsV1 

func (c *Client) ListDdmStatusItemsV1(ctx context.Context, clientManagementID string) (*StatusItems, error)

ListDdmStatusItemsV1 retrieve the Status Items from the latest Status Report for a device.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices, Read Computers. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • clientManagementID: client management id of the target device.

func (*Client) ListDepartmentHistoryV1 

func (c *Client) ListDepartmentHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListDepartmentHistoryV1 get specified Department history object.

Required privileges: departments:read. Legacy Jamf Pro privilege name(s): Read Departments.

Parameters:

  • id: instance id of department history record.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListDepartmentsV1 

func (c *Client) ListDepartmentsV1(ctx context.Context, sort []string, filter string) ([]Department, error)

ListDepartmentsV1 search for Departments.

Required privileges: departments:read. Legacy Jamf Pro privilege name(s): Read Departments.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter department collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. Example: name=="*department*".

func (*Client) ListDeviceCommunicationSettingsHistoryV1 

func (c *Client) ListDeviceCommunicationSettingsHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListDeviceCommunicationSettingsHistoryV1 get Device Communication settings history.

Required privileges: mdm-profile-renewal-settings:read. Legacy Jamf Pro privilege name(s): Read Automatically Renew MDM Profile Settings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListDeviceEnrollmentDevicesV1 

func (c *Client) ListDeviceEnrollmentDevicesV1(ctx context.Context, id string) (*DeviceEnrollmentDeviceSearchResults, error)

ListDeviceEnrollmentDevicesV1 retrieve a list of Devices assigned to the supplied id.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) ListDeviceEnrollmentHistoryV1 

func (c *Client) ListDeviceEnrollmentHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListDeviceEnrollmentHistoryV1 get sorted and paged Device Enrollment history objects.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.
  • sort: Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default search is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: search=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListDeviceEnrollmentSyncsV1 

func (c *Client) ListDeviceEnrollmentSyncsV1(ctx context.Context, id string) ([]DeviceEnrollmentInstanceSyncStatus, error)

ListDeviceEnrollmentSyncsV1 get all instance sync states for a single Device Enrollment Instance.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) ListDeviceEnrollmentsV1 

func (c *Client) ListDeviceEnrollmentsV1(ctx context.Context, sort []string) ([]DeviceEnrollmentInstance, error)

ListDeviceEnrollmentsV1 read all sorted and paged Device Enrollment instances.

Required privileges: device-enrollment-program-instances:read. Legacy Jamf Pro privilege name(s): Read Device Enrollment Program Instances.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListDeviceExtensionAttributesPreview 

func (c *Client) ListDeviceExtensionAttributesPreview(ctx context.Context, selectAttr string) (*MobileDeviceExtensionAttributeResults, error)

ListDeviceExtensionAttributesPreview get Mobile Device Extension Attribute values placed in select paramter.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Mobile Device Extension Attributes.

Parameters:

  • selectAttr: Acceptable values currently include: * name.

func (*Client) ListDistributionPointHistoryV1 

func (c *Client) ListDistributionPointHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListDistributionPointHistoryV1 get specified distribution point History object.

Required privileges: distribution-points:read. Legacy Jamf Pro privilege name(s): Read Distribution Points.

Parameters:

  • id: Instance id of distribution point history.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including id, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListDistributionPointsV1 

func (c *Client) ListDistributionPointsV1(ctx context.Context, sort []string, filter string) ([]DistributionPoint, error)

ListDistributionPointsV1 finds all Distribution Points.

Required privileges: distribution-points:read. Legacy Jamf Pro privilege name(s): Read Distribution Points.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas. Allows fields such as - name, serverName.
  • filter: Filters results. Use RSQL format for query. Allows fields such as - name, serverName, principal, fileSharingConnectionType, and httpsEnabled Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListEbooksV1 

func (c *Client) ListEbooksV1(ctx context.Context, sort []string) ([]Ebook, error)

ListEbooksV1 get Ebook object.

Required privileges: ebooks:read. Legacy Jamf Pro privilege name(s): Read eBooks.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListEnrollmentAccessGroupsV3 

func (c *Client) ListEnrollmentAccessGroupsV3(ctx context.Context, sort []string, allUsersOptionFirst bool) ([]EnrollmentAccessGroupPreview, error)

ListEnrollmentAccessGroupsV3 retrieve the configured LDAP groups configured for User-Initiated Enrollment.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

Parameters:

  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `name:asc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.
  • allUsersOptionFirst: Return "All LDAP Users" option on the first position if it is present in the current page.

func (*Client) ListEnrollmentCustomizationHistoryV2 

func (c *Client) ListEnrollmentCustomizationHistoryV2(ctx context.Context, id string, sort []string) ([]ObjectHistory, error)

ListEnrollmentCustomizationHistoryV2 get sorted and paged Enrollment Customization history objects.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • sort: Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc.

func (*Client) ListEnrollmentCustomizationPanelsV1 

func (c *Client) ListEnrollmentCustomizationPanelsV1(ctx context.Context, id string) (*EnrollmentCustomizationPanelList, error)

ListEnrollmentCustomizationPanelsV1 get all Panels for single Enrollment Customization.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) ListEnrollmentCustomizationPrestagesV2 

func (c *Client) ListEnrollmentCustomizationPrestagesV2(ctx context.Context, id string) (*PrestageDependencies, error)

ListEnrollmentCustomizationPrestagesV2 retrieve the list of Prestages using this Enrollment Customization.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) ListEnrollmentCustomizationsV2 

func (c *Client) ListEnrollmentCustomizationsV2(ctx context.Context, sort []string) ([]EnrollmentCustomizationV2, error)

ListEnrollmentCustomizationsV2 retrieve sorted and paged Enrollment Customizations.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListEnrollmentHistoryV2 

func (c *Client) ListEnrollmentHistoryV2(ctx context.Context, sort []string) ([]ObjectHistory, error)

ListEnrollmentHistoryV2 get sorted and paged Enrollment history object.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

Parameters:

  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `date:desc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.

func (*Client) ListEnrollmentLanguageCodesV3 

func (c *Client) ListEnrollmentLanguageCodesV3(ctx context.Context) ([]LanguageCode, error)

ListEnrollmentLanguageCodesV3 retrieve the list of languages and corresponding ISO 639-1 Codes.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

func (*Client) ListEnrollmentLanguagesV3 

func (c *Client) ListEnrollmentLanguagesV3(ctx context.Context, sort []string) ([]EnrollmentProcessTextObject, error)

ListEnrollmentLanguagesV3 get an array of the language codes that have Enrollment messaging.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is `languageCode:asc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.

func (*Client) ListFilteredEnrollmentLanguageCodesV3 

func (c *Client) ListFilteredEnrollmentLanguageCodesV3(ctx context.Context) ([]LanguageCode, error)

ListFilteredEnrollmentLanguageCodesV3 retrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment.

Required privileges: user-initiated-enrollment:read. Legacy Jamf Pro privilege name(s): Read User-Initiated Enrollment.

func (*Client) ListGSXConnectionHistoryV1 

func (c *Client) ListGSXConnectionHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistoryV1, error)

ListGSXConnectionHistoryV1 get specified GSX Connection History object.

Required privileges: gsx-connection:read. Legacy Jamf Pro privilege name(s): Read GSX Connection.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListGroupsV2 

func (c *Client) ListGroupsV2(ctx context.Context, sort []string, filter string) ([]GroupDtoV1, error)

ListGroupsV2 returns group information for all Mobile Device and Computer groups.

Required privileges: device-groups:read.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is groupName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in sorting: groupName, groupDescription, groupType, isSmart. Example: sort=groupName:asc,groupType:desc.
  • filter: Query in the RSQL format, allowing to filter group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupName, groupDescription, groupType, isSmart. This param can be combined with paging and sorting. When using groupType in the filter, the value must be either "MOBILE" or "COMPUTER" but not both. When using groupType in the filter, the value is case sensitive. When using groupType in the filter, it will exclude groups of the other type regardless of or/and conditionals. Example: filter=groupName=="*Managed*" and isSmart=="true" Example: filter=groupType=="COMPUTER" and groupDescription=="*Admin*".

func (*Client) ListIOSBrandingConfigurationsV1 

func (c *Client) ListIOSBrandingConfigurationsV1(ctx context.Context, sort []string) ([]IosBrandingConfiguration, error)

ListIOSBrandingConfigurationsV1 search for sorted and paged iOS branding configurations.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service Branding Configuration.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc.

func (*Client) ListInventoryPreloadExtensionAttributeColumnsV2 

func (c *Client) ListInventoryPreloadExtensionAttributeColumnsV2(ctx context.Context) (*InventoryPreloadExtensionAttributeColumnResult, error)

ListInventoryPreloadExtensionAttributeColumnsV2 retrieve a list of extension attribute columns.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

func (*Client) ListInventoryPreloadHistoryV2 

func (c *Client) ListInventoryPreloadHistoryV2(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListInventoryPreloadHistoryV2 get Inventory Preload history entries.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

Parameters:

  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `date:desc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.
  • filter: Allows filtering inventory preload history records. Default search is empty query - returning all results for the requested page. All inventory preload history fields are supported. Query in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`. Example: `filter=username=="admin"`.

func (*Client) ListInventoryPreloadRecordsV2 

func (c *Client) ListInventoryPreloadRecordsV2(ctx context.Context, sort []string, filter string) ([]InventoryPreloadRecordV2, error)

ListInventoryPreloadRecordsV2 return all Inventory Preload records.

Required privileges: inventory-preload-records:read. Legacy Jamf Pro privilege name(s): Read Inventory Preload Records.

Parameters:

  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `id:asc`. Multiple sort criteria are supported and must be separated with a comma. All inventory preload fields are supported, however fields added by extension attributes are not supported. If sorting by deviceType, use `0` for Computer and `1` for Mobile Device. Example: `sort=date:desc,name:asc`.
  • filter: Allowing to filter inventory preload records. Default search is empty query - returning all results for the requested page. All inventory preload fields are supported, however fields added by extension attributes are not supported. If filtering by deviceType, use `0` for Computer and `1` for Mobile Device. Query in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`. Example: `filter=categoryName=="Category"`.

func (*Client) ListJCDSFilesV1 deprecated 

func (c *Client) ListJCDSFilesV1(ctx context.Context) ([]FileData, error)

ListJCDSFilesV1 retrieve a list of files and file metadata from the Jamf Cloud Distribution Service.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-08-28) and may be removed in a future release.

Required privileges: jamf-cloud-distribution-service-files:read. Legacy Jamf Pro privilege name(s): Read Jamf Cloud Distribution Service Files.

func (*Client) ListJamfConnectConfigProfilesV1 

func (c *Client) ListJamfConnectConfigProfilesV1(ctx context.Context, sort []string, filter string) ([]LinkedConnectProfile, error)

ListJamfConnectConfigProfilesV1 search for config profiles linked to Jamf Connect.

Required privileges: jamf-connect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Connect Deployments.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListJamfConnectDeploymentTasksV1 

func (c *Client) ListJamfConnectDeploymentTasksV1(ctx context.Context, id string, sort []string, filter string) ([]DeploymentTask, error)

ListJamfConnectDeploymentTasksV1 search for deployment tasks for a config profile linked to Jamf Connect.

Required privileges: jamf-connect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Connect Deployments.

Parameters:

  • id: the UUID of the Jamf Connect deployment.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListJamfConnectHistoryV1 

func (c *Client) ListJamfConnectHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListJamfConnectHistoryV1 get Jamf Connect history.

Required privileges: jamf-connect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Connect Settings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListJamfPackagesV1 

func (c *Client) ListJamfPackagesV1(ctx context.Context, application string) ([]JamfPackageResponse, error)

ListJamfPackagesV1 get the packages for a given Jamf application.

Required privileges: jamf-packages-action:read. Legacy Jamf Pro privilege name(s): Jamf Packages Action.

Parameters:

  • application: The Jamf Application key. The only supported values are protect and connect.

func (*Client) ListJamfProServerURLHistoryV1 

func (c *Client) ListJamfProServerURLHistoryV1(ctx context.Context, sort []string) ([]ObjectHistory, error)

ListJamfProServerURLHistoryV1 get Jamf Pro Server URL settings history.

Required privileges: jss-url:read. Legacy Jamf Pro privilege name(s): Read JSS URL.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListJamfProtectDeploymentTasksV1 

func (c *Client) ListJamfProtectDeploymentTasksV1(ctx context.Context, id string, sort []string, filter string) ([]DeploymentTask, error)

ListJamfProtectDeploymentTasksV1 search for deployment tasks for a config profile linked to Jamf Protect.

Required privileges: jamf-protect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Protect Deployments.

Parameters:

  • id: the UUID of the Jamf Protect deployment.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListJamfProtectHistoryV1 

func (c *Client) ListJamfProtectHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListJamfProtectHistoryV1 get Jamf Protect history.

Required privileges: jamf-protect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Protect Settings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListJamfProtectPlansV1 

func (c *Client) ListJamfProtectPlansV1(ctx context.Context, sort []string, filter string) ([]JamfProtectPlan, error)

ListJamfProtectPlansV1 get all of the previously synced Jamf Protect Plans with information about their associated configuration profile.

Required privileges: jamf-protect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Protect Deployments.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListJamfRemoteAssistSessionsV1 

func (c *Client) ListJamfRemoteAssistSessionsV1(ctx context.Context) ([]SessionHistoryItem, error)

ListJamfRemoteAssistSessionsV1 gets session history items.

Required privileges: remote-assist:read. Legacy Jamf Pro privilege name(s): Read Remote Assist.

func (*Client) ListJamfRemoteAssistSessionsV2 

func (c *Client) ListJamfRemoteAssistSessionsV2(ctx context.Context, sort []string, filter string) ([]SessionHistoryItem, error)

ListJamfRemoteAssistSessionsV2 gets session history items.

Required privileges: remote-assist:read. Legacy Jamf Pro privilege name(s): Read Remote Assist.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is sessionId:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=sessionId:desc,deviceId:asc.
  • filter: Query in the RSQL format, allowing to filter session history items collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: sessionId, deviceId, sessionAdminId. This param can be combined with paging and sorting. Example: sessionAdminId=="*Andrzej*".

func (*Client) ListLdapLdapServersV1 

func (c *Client) ListLdapLdapServersV1(ctx context.Context) ([]LdapServer, error)

ListLdapLdapServersV1 retrieve all LDAP Servers.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

func (*Client) ListLdapServersPreview 

func (c *Client) ListLdapServersPreview(ctx context.Context) ([]LdapServer, error)

ListLdapServersPreview retrieve all Servers including LDAP and Cloud Identity Providers.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

func (*Client) ListLdapServersV1 

func (c *Client) ListLdapServersV1(ctx context.Context) ([]LdapServer, error)

ListLdapServersV1 retrieve all Servers including LDAP and Cloud Identity Providers.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

func (*Client) ListLocalAdminPasswordAccountHistoryByGuidV2 

func (c *Client) ListLocalAdminPasswordAccountHistoryByGuidV2(ctx context.Context, clientManagementID string, username string, guid string) (*LapsHistoryResponse, error)

ListLocalAdminPasswordAccountHistoryByGuidV2 get LAPS historical records for target device and user guid.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password Audit History.

Parameters:

  • clientManagementID: client management id of target device.
  • username: user name to view history for.
  • guid: user guid to view history for.

func (*Client) ListLocalAdminPasswordAccountHistoryV2 

func (c *Client) ListLocalAdminPasswordAccountHistoryV2(ctx context.Context, clientManagementID string, username string) (*LapsHistoryResponse, error)

ListLocalAdminPasswordAccountHistoryV2 get LAPS historical records for target device and username.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password Audit History.

Parameters:

  • clientManagementID: client management id of target device.
  • username: user name to view history for.

func (*Client) ListLocalAdminPasswordAccountsV2 

func (c *Client) ListLocalAdminPasswordAccountsV2(ctx context.Context, clientManagementID string) (*LapsUserResultsV2, error)

ListLocalAdminPasswordAccountsV2 get the LAPS capable admin accounts for a device.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password.

Parameters:

  • clientManagementID: client management id of target device.

func (*Client) ListLocalAdminPasswordAuditsByGuidV2 

func (c *Client) ListLocalAdminPasswordAuditsByGuidV2(ctx context.Context, clientManagementID string, username string, guid string) (*LapsPasswordAuditsResultsV2, error)

ListLocalAdminPasswordAuditsByGuidV2 get LAPS password viewed history.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password Audit History.

Parameters:

  • clientManagementID: client management id of target device.
  • username: user name to view audit information for.
  • guid: user guid to view audit information for.

func (*Client) ListLocalAdminPasswordAuditsV2 

func (c *Client) ListLocalAdminPasswordAuditsV2(ctx context.Context, clientManagementID string, username string) (*LapsPasswordAuditsResultsV2, error)

ListLocalAdminPasswordAuditsV2 get LAPS password viewed history.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password Audit History.

Parameters:

  • clientManagementID: client management id of target device.
  • username: user name to view audit information for.

func (*Client) ListLocalAdminPasswordHistoryV2 

func (c *Client) ListLocalAdminPasswordHistoryV2(ctx context.Context, clientManagementID string) (*LapsAccountManagementHistoryResponse, error)

ListLocalAdminPasswordHistoryV2 get LAPS password viewed history, and rotation history.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password Audit History.

Parameters:

  • clientManagementID: client management id of target device.

func (*Client) ListLocalAdminPasswordPendingRotationsV2 

func (c *Client) ListLocalAdminPasswordPendingRotationsV2(ctx context.Context) (*LapsPendingRotationResponse, error)

ListLocalAdminPasswordPendingRotationsV2 get a list of the current devices and usernames with pending LAPS rotations.

Required privileges: local-admin-passwords:read. Legacy Jamf Pro privilege name(s): View Local Admin Password.

func (*Client) ListLocalesV1 

func (c *Client) ListLocalesV1(ctx context.Context) ([]Locale, error)

ListLocalesV1 return locales that can be used in other features.

Required privileges: the spec declares none.

func (*Client) ListLogFlushingTasksV1 

func (c *Client) ListLogFlushingTasksV1(ctx context.Context) ([]LogFlushingTaskV1, error)

ListLogFlushingTasksV1 get log flushing tasks.

Required privileges: retention-policy:read. Legacy Jamf Pro privilege name(s): Read Retention Policy.

func (*Client) ListMacOSBrandingConfigurationsV1 

func (c *Client) ListMacOSBrandingConfigurationsV1(ctx context.Context, sort []string) ([]MacOsBrandingConfiguration, error)

ListMacOSBrandingConfigurationsV1 search for sorted and paged macOS branding configurations.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service Branding Configuration, Read Self Service. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc.

func (*Client) ListManagedSoftwareUpdatePlansV1 

func (c *Client) ListManagedSoftwareUpdatePlansV1(ctx context.Context, sort []string, filter string) ([]ManagedSoftwareUpdatePlan, error)

ListManagedSoftwareUpdatePlansV1 retrieve Managed Software Update Plans.

Required privileges: devices:read, managed-software-updates:read. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Read Computers, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is planUuid:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: planUuid, device.deviceId, device.objectType, updateAction, versionType, specificVersion, maxDeferrals, recipeId, forceInstallLocalDateTime, state.

func (*Client) ListManagedSoftwareUpdateStatusesV1 

func (c *Client) ListManagedSoftwareUpdateStatusesV1(ctx context.Context, filter string) (*ManagedSoftwareUpdateStatuses, error)

ListManagedSoftwareUpdateStatusesV1 retrieve Managed Software Update Statuses.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers, Read Mobile Devices. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • filter: Query in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: osUpdatesStatusId, device.deviceId, device.objectType, downloaded, downloadPercentComplete, productKey, status, deferralsRemaining, maxDeferrals, nextScheduledInstall, created and updated.

func (*Client) ListMdmCommandsV1 deprecated 

func (c *Client) ListMdmCommandsV1(ctx context.Context, uuids []string, clientManagementID string) ([]MDMCommand, error)

ListMdmCommandsV1 get information about mdm commands made by Jamf Pro.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2023-10-16) and may be removed in a future release.

Required privileges: device-actions:read. Legacy Jamf Pro privilege name(s): View MDM command information in Jamf Pro API.

Parameters:

  • uuids: A list of the UUIDs of the commands being searched for. Limited to 40 UUIDs in length. Choose one of two parameters, but not both.
  • clientManagementID: The client management id used to search for a list of commands. Choose one of two parameters, but not both.

func (*Client) ListMdmCommandsV2 

func (c *Client) ListMdmCommandsV2(ctx context.Context, sort []string, filter string) ([]MDMCommand, error)

ListMdmCommandsV2 get information about mdm commands made by Jamf Pro.

Required privileges: device-actions:read. Legacy Jamf Pro privilege name(s): View MDM command information in Jamf Pro API.

Parameters:

  • sort: Default sort is dateSent:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter, for a list of commands. All url must contain minimum one filter field. Fields allowed in the query: uuid, clientManagementId, command, status, clientType, dateSent, validAfter, dateCompleted, profileId, profileIdentifier, and active. This param can be combined with paging. Please note that any date filters must be used with gt, lt, ge, le Example: clientManagementId==fb511aae-c557-474f-a9c1-5dc845b90d0f;status==Pending;command==INSTALL_PROFILE;uuid==9e18f849-e689-4f2d-b616-a99d3da7db42;clientType==COMPUTER_USER;profileId==1;profileIdentifier==18cc61c2-01fc-11ed-b939-0242ac120002;dateCompleted=ge=2021-08-04T14:25:18.26Z;dateCompleted=le=2021-08-04T14:25:18.26Z;validAfter=ge=2021-08-05T14:25:18.26Z;active==true.

func (*Client) ListMobileDeviceExtensionAttributeHistoryV1 

func (c *Client) ListMobileDeviceExtensionAttributeHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListMobileDeviceExtensionAttributeHistoryV1 get specified Mobile Device Extension Attribute History object.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Mobile Device Extension Attributes.

Parameters:

  • id: Instance ID of Mobile Device Extension Attribute.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListMobileDeviceExtensionAttributesV1 

func (c *Client) ListMobileDeviceExtensionAttributesV1(ctx context.Context, sort []string, filter string) ([]MobileDeviceExtensionAttributes, error)

ListMobileDeviceExtensionAttributesV1 retrieve Mobile Device Extension Attributes.

Required privileges: extension-attributes:read. Legacy Jamf Pro privilege name(s): Read Mobile Device Extension Attributes.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is name:asc. If using multiple criteria, separate with commas. Allows sort for id and name.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, name Default filter is an empty query and returns all results from the requested page.

func (*Client) ListMobileDeviceGroupsV2 

func (c *Client) ListMobileDeviceGroupsV2(ctx context.Context) ([]MobileDeviceGroup, error)

ListMobileDeviceGroupsV2 return the list of all Mobile Device Groups.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Mobile Device Groups, Read Static Mobile Device Groups. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) ListMobileDevicePairedDevicesV2 

func (c *Client) ListMobileDevicePairedDevicesV2(ctx context.Context, id string, section []string, sort []string, filter string) ([]MobileDeviceResponse, error)

ListMobileDevicePairedDevicesV2 return paginated Mobile Device Inventory records of all paired devices for the device.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices.

Parameters:

  • id: instance id of mobile device record.
  • section: section of mobile device details, if not specified, Paired Devices section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE. Allowed values: see the MobileDeviceSection constants.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is displayName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `languages`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `serialNumber`, `supervised`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`. Example: `sort=displayName:desc,username:asc`.
  • filter: Query in the RSQL format, allowing to filter mobile device collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `serialNumber`, `supervised`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`, `groupId`, `groupName`. This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`.

func (*Client) ListMobileDevicePrestageAttachmentsV3 

func (c *Client) ListMobileDevicePrestageAttachmentsV3(ctx context.Context, id string) ([]FileAttachmentV3, error)

ListMobileDevicePrestageAttachmentsV3 get attachments for a Mobile Device Prestage.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) ListMobileDevicePrestageHistoryV3 

func (c *Client) ListMobileDevicePrestageHistoryV3(ctx context.Context, id string, sort []string) ([]ObjectHistory, error)

ListMobileDevicePrestageHistoryV3 get sorted and paged Mobile Device Prestage history objects.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.
  • sort: Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc.

func (*Client) ListMobileDevicePrestageSyncsV2 

func (c *Client) ListMobileDevicePrestageSyncsV2(ctx context.Context, id string) ([]PrestageSyncStatusV2, error)

ListMobileDevicePrestageSyncsV2 get all prestage sync states for a single prestage.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) ListMobileDevicePrestagesV3 

func (c *Client) ListMobileDevicePrestagesV3(ctx context.Context, sort []string) ([]GetMobileDevicePrestageV3, error)

ListMobileDevicePrestagesV3 get sorted and paged Mobile Device Prestages.

Required privileges: prestage-enrollments:read. Legacy Jamf Pro privilege name(s): Read Mobile Device PreStage Enrollments.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListMobileDevicesDetailV2 

func (c *Client) ListMobileDevicesDetailV2(ctx context.Context, section []string, sort []string, filter string) ([]MobileDeviceResponse, error)

ListMobileDevicesDetailV2 return paginated Mobile Device Inventory records.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices.

Parameters:

  • section: section of mobile device details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE. Allowed values: see the MobileDeviceSection constants.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is displayName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`. Example: `sort=displayName:desc,username:asc`.
  • filter: Query in the RSQL format, allowing to filter mobile device collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `awaitingConfiguration`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `lockdownModeEnabled`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `returnToServiceEnabled`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`, `groupId`, `groupName`. This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`.

func (*Client) ListMobileDevicesV2 

func (c *Client) ListMobileDevicesV2(ctx context.Context, sort []string) ([]MobileDeviceV2, error)

ListMobileDevicesV2 get Mobile Device objects.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Mobile Devices.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListNotificationsV1 

func (c *Client) ListNotificationsV1(ctx context.Context) ([]NotificationV1, error)

ListNotificationsV1 get Notifications for user and site.

Required privileges: the spec declares none.

func (*Client) ListOnboardingEligibleAppsV1 

func (c *Client) ListOnboardingEligibleAppsV1(ctx context.Context, sort []string) ([]OnboardingEligibleItem, error)

ListOnboardingEligibleAppsV1 retrieves a list of applications that are eligible to be used in an onboarding configuration.

Required privileges: onboarding:read. Legacy Jamf Pro privilege name(s): Read Onboarding Configuration.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListOnboardingEligibleConfigurationProfilesV1 

func (c *Client) ListOnboardingEligibleConfigurationProfilesV1(ctx context.Context, sort []string) ([]OnboardingEligibleItem, error)

ListOnboardingEligibleConfigurationProfilesV1 retrieves a list of configuration profiles that are eligible to be used in an onboarding configuration.

Required privileges: onboarding:read. Legacy Jamf Pro privilege name(s): Read Onboarding Configuration.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListOnboardingEligiblePoliciesV1 

func (c *Client) ListOnboardingEligiblePoliciesV1(ctx context.Context, sort []string) ([]OnboardingEligibleItem, error)

ListOnboardingEligiblePoliciesV1 retrieves a list of policies that are eligible to be used in an onboarding configuration.

Required privileges: onboarding:read. Legacy Jamf Pro privilege name(s): Read Onboarding Configuration.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListOnboardingHistoryV1 

func (c *Client) ListOnboardingHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListOnboardingHistoryV1 get Onboarding history object.

Required privileges: onboarding:read. Legacy Jamf Pro privilege name(s): Read Onboarding Configuration.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and date<2019-12-15.

func (*Client) ListPackageHistoryV1 

func (c *Client) ListPackageHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListPackageHistoryV1 get specified Package History object.

Required privileges: packages:read. Legacy Jamf Pro privilege name(s): Read Packages.

Parameters:

  • id: Instance ID of package history.
  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListPackagesV1 

func (c *Client) ListPackagesV1(ctx context.Context, sort []string, filter string) ([]Package, error)

ListPackagesV1 retrieve Packages.

Required privileges: packages:read. Legacy Jamf Pro privilege name(s): Read Packages.

Parameters:

  • sort: Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.
  • filter: Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, fileName, packageName, categoryId, info, notes, manifestFileName, cloudTransferStatus. Default filter is an empty query and returns all results from the requested page.

func (*Client) ListParentAppHistoryV1 

func (c *Client) ListParentAppHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListParentAppHistoryV1 get Jamf Parent app settings history.

Required privileges: parent-app:read. Legacy Jamf Pro privilege name(s): Read Parent App Settings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListPatchPoliciesV2 

func (c *Client) ListPatchPoliciesV2(ctx context.Context, sort []string, filter string) ([]PatchPolicyListView, error)

ListPatchPoliciesV2 retrieve Patch Policies.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Patch Policy collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, policyName, policyEnabled, policyTargetVersion, policyDeploymentMethod, softwareTitle, softwareTitleConfigurationId, pending, completed, deferred, and failed. This param can be combined with paging and sorting.

func (*Client) ListPatchPolicyDetailsV2 

func (c *Client) ListPatchPolicyDetailsV2(ctx context.Context, sort []string, filter string) ([]PatchPolicyDetail, error)

ListPatchPolicyDetailsV2 retrieve Patch Policies.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Patch Policy collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: id, name, enabled, targetPatchVersion, deploymentMethod, softwareTitleId, softwareTitleConfigurationId, killAppsDelayMinutes, killAppsMessage, isDowngrade, isPatchUnknownVersion, notificationHeader, selfServiceEnforceDeadline, selfServiceDeadline, installButtonText, selfServiceDescription, iconId, reminderFrequency, reminderEnabled. This param can be combined with paging and sorting.

func (*Client) ListPatchPolicyLogDetailsForDeviceV2 

func (c *Client) ListPatchPolicyLogDetailsForDeviceV2(ctx context.Context, id string, deviceID string) ([]PatchPolicyLogDetail, error)

ListPatchPolicyLogDetailsForDeviceV2 return attempt details for a specific log.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.
  • deviceID: device id.

func (*Client) ListPatchPolicyLogsV2 

func (c *Client) ListPatchPolicyLogsV2(ctx context.Context, id string, sort []string, filter string) ([]PatchPolicyLogV2, error)

ListPatchPolicyLogsV2 retrieve Patch Policy Logs.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is deviceName:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Patch Policy Logs collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: deviceId, deviceName, statusCode, statusDate, attemptNumber, ignoredForPatchPolicyId. This param can be combined with paging and sorting.

func (*Client) ListPatchSoftwareTitleConfigurationsV3 

func (c *Client) ListPatchSoftwareTitleConfigurationsV3(ctx context.Context) ([]PatchSoftwareTitleConfiguration, error)

ListPatchSoftwareTitleConfigurationsV3 retrieve Patch Software Title Configurations.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

func (*Client) ListPatchSoftwareTitleDefinitionsV3 

func (c *Client) ListPatchSoftwareTitleDefinitionsV3(ctx context.Context, id string, sort []string, filter string) ([]PatchSoftwareTitleDefinition, error)

ListPatchSoftwareTitleDefinitionsV3 retrieve Patch Software Title Definitions with the supplied id.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title identifier.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is absoluteOrderId:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Patch Software Title Definition collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, version, minimumOperatingSystem, releaseDate, reboot, standalone and absoluteOrderId. This param can be combined with paging and sorting.

func (*Client) ListPatchSoftwareTitleExtensionAttributesV3 

func (c *Client) ListPatchSoftwareTitleExtensionAttributesV3(ctx context.Context, id string) ([]PatchSoftwareTitleExtensionAttributes, error)

ListPatchSoftwareTitleExtensionAttributesV3 retrieve Software Title Extension Attributes with the supplied id.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title identifier.

func (*Client) ListPatchSoftwareTitleHistoryV3 

func (c *Client) ListPatchSoftwareTitleHistoryV3(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListPatchSoftwareTitleHistoryV3 get specified Patch Software Title Configuration history object.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configuration Id.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListPatchSoftwareTitlePatchReportV3 

func (c *Client) ListPatchSoftwareTitlePatchReportV3(ctx context.Context, id string, sort []string, filter string) ([]PatchReportV3, error)

ListPatchSoftwareTitlePatchReportV3 retrieve Patch Software Title Configuration Patch Report.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configurations identifier.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is computerName:asc. Multiple sort criteria are supported and must be separated with a comma. Supported fields: computerName, deviceId, username, operatingSystemVersion, lastCheckIn, buildingName, departmentName, siteName, version.
  • filter: Query in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.

func (*Client) ListPatchSoftwareTitlePatchSummaryVersionsV3 

func (c *Client) ListPatchSoftwareTitlePatchSummaryVersionsV3(ctx context.Context, id string) ([]PatchSummaryVersion, error)

ListPatchSoftwareTitlePatchSummaryVersionsV3 returns patch versions.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: Patch id.

func (*Client) ListPreviewComputers 

func (c *Client) ListPreviewComputers(ctx context.Context, sort []string) ([]ComputerOverview, error)

ListPreviewComputers return a list of Computers.

Required privileges: devices:read. Legacy Jamf Pro privilege name(s): Read Computers.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListReenrollmentHistoryV1 

func (c *Client) ListReenrollmentHistoryV1(ctx context.Context, sort string) ([]ObjectHistory, error)

ListReenrollmentHistoryV1 get Re-enrollment history object.

Required privileges: re-enrollment:read. Legacy Jamf Pro privilege name(s): Read Re-enrollment.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListRemoteAdministrationConfigurationsPreview 

func (c *Client) ListRemoteAdministrationConfigurationsPreview(ctx context.Context) ([]RemoteAdministrationResponse, error)

ListRemoteAdministrationConfigurationsPreview get information about all remote administration configurations.

Required privileges: remote-administration:read. Legacy Jamf Pro privilege name(s): Read Remote Administration.

func (*Client) ListReturnToServiceConfigurationsV1 

func (c *Client) ListReturnToServiceConfigurationsV1(ctx context.Context) (*ReturnToServiceConfigurationSearchResults, error)

ListReturnToServiceConfigurationsV1 get all Return to Service Configurations.

Required privileges: return-to-service:read. Legacy Jamf Pro privilege name(s): View Return To Service Configurations.

func (*Client) ListScriptHistoryV1 

func (c *Client) ListScriptHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListScriptHistoryV1 get specified Script history object.

Required privileges: scripts:read. Legacy Jamf Pro privilege name(s): Read Scripts.

Parameters:

  • id: id of script history record.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListScriptsV1 

func (c *Client) ListScriptsV1(ctx context.Context, sort []string, filter string) ([]Script, error)

ListScriptsV1 search for sorted and paged Scripts.

Required privileges: scripts:read. Legacy Jamf Pro privilege name(s): Read Scripts.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter scripts collection. Default search is empty query - returning all results for the requested page. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. This param can be combined with paging and sorting. Example: filter=categoryName=="Category" and name=="*script name*".

func (*Client) ListSelfServiceSettingsHistoryV1 

func (c *Client) ListSelfServiceSettingsHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListSelfServiceSettingsHistoryV1 get a page of Self Service settings history.

Required privileges: self-service:read. Legacy Jamf Pro privilege name(s): Read Self Service.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListSiteObjectsV1 

func (c *Client) ListSiteObjectsV1(ctx context.Context, id string, sort []string, filter string) ([]SiteObject, error)

ListSiteObjectsV1 find and filter site objects for a site ID.

Required privileges: sites:read. Legacy Jamf Pro privilege name(s): Read Sites.

Parameters:

  • id: Site ID to get objects for.
  • sort: Sorting criteria in the format: `property:asc/desc`. Default sort is `objectType:asc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=objectId:asc,objectType:desc`.
  • filter: Query in the RSQL format, allowing filter of site object information. Default filter returns all objects for the site ID. Fields allowed in the query: `objectType`, `objectId`. Example: `filter=objectType=="User"`. List of `objectType` options (case-insensitive) ["Computer", "Peripheral", "Licensed Software", "Licensed Software Template", "Policy", "macOS Configuration Profile", "Restricted Software", "Managed Preference Profile", "Computer Group", "Mobile Device", "Apple TV", "Android Device", "User Group", "iOS Configuration Profile", "Mobile Device App", "E-book", "Mobile Device Group", "Classroom", "Advanced Computer Search", "Advanced Mobile Search", "Advanced User Search", "Advanced User Content Search", "Computer Invitation", "Mobile Device Invitation", "Mobile Device Enrollment Profile", "Device Enrollment Program Instance", "Mobile Device Prestage", "Computer DEP Prestage", "Enrollment Customization", "VPP Location", "VPP Subscription", "VPP Invitation", "VPP Assignment", "User", "Network Integration", "Mac App", "App Installer", "Self Service Plugin", "Software Title", "Patch Software Title Summary", "Patch Policy", "Patch Software Title Configuration", "Change Password", "Mobile Device Inventory", "Computer Inventory", "Change Management", "Licensed Software License"].

func (*Client) ListSitesV1 

func (c *Client) ListSitesV1(ctx context.Context) ([]V1Site, error)

ListSitesV1 find all sites.

Required privileges: sites:read. Legacy Jamf Pro privilege name(s): Read Sites.

func (*Client) ListSmartComputerGroupsV3 

func (c *Client) ListSmartComputerGroupsV3(ctx context.Context, sort []string, filter string) ([]SmartComputerGroupSearch, error)

ListSmartComputerGroupsV3 search for Smart Computer Groups.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Computer Groups.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc.
  • filter: Query in the RSQL format, allowing to filter smart computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name=="*group*".

func (*Client) ListSmartMobileDeviceGroupMembershipV2 

func (c *Client) ListSmartMobileDeviceGroupMembershipV2(ctx context.Context, id string, sort []string, filter string) ([]InventoryListMobileDevice, error)

ListSmartMobileDeviceGroupMembershipV2 get Smart Group Membership by Id.

Required privileges: device-groups:read, devices:read. Legacy Jamf Pro privilege name(s): Read Smart Mobile Device Groups, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: instance id of smart-group.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`. Extension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`. Example: `sort=displayName:desc,username:asc`.
  • filter: Query in the RSQL format, allowing to filter mobile device collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`. Extension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`. This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`.

func (*Client) ListSmartMobileDeviceGroupsV2 

func (c *Client) ListSmartMobileDeviceGroupsV2(ctx context.Context, sort []string, filter string) ([]SmartGroup, error)

ListSmartMobileDeviceGroupsV2 get Smart Groups.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Smart Mobile Device Groups.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.
  • filter: Query in the RSQL format, allowing to filter smart group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName=="smartGroup1".

func (*Client) ListSmtpServerAllowedAuthTypesV2 

func (c *Client) ListSmtpServerAllowedAuthTypesV2(ctx context.Context) (*SmtpAuthenticationTypeList, error)

ListSmtpServerAllowedAuthTypesV2 get allowed SMTP authentication types.

Required privileges: smtp-server:read. Legacy Jamf Pro privilege name(s): Read SMTP Server.

func (*Client) ListSmtpServerHistoryV1 

func (c *Client) ListSmtpServerHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistoryV1, error)

ListSmtpServerHistoryV1 get specified SMTP Server history object.

Required privileges: smtp-server:read. Legacy Jamf Pro privilege name(s): Read SMTP Server.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListSsoHistoryV3 

func (c *Client) ListSsoHistoryV3(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListSsoHistoryV3 get SSO history object.

Required privileges: sso-settings:read. Legacy Jamf Pro privilege name(s): Read SSO Settings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListStaticComputerGroupsV3 

func (c *Client) ListStaticComputerGroupsV3(ctx context.Context, sort []string, filter string) ([]StaticComputerGroupSummary, error)

ListStaticComputerGroupsV3 search for Static Computer Groups.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Static Computer Groups.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc.
  • filter: Query in the RSQL format, allowing to filter static computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name=="*group*".

func (*Client) ListStaticMobileDeviceGroupMembershipV2 

func (c *Client) ListStaticMobileDeviceGroupMembershipV2(ctx context.Context, id string, sort []string, filter string) ([]InventoryListMobileDevice, error)

ListStaticMobileDeviceGroupMembershipV2 get Static Group Membership by Id.

Required privileges: device-groups:read, devices:read. Legacy Jamf Pro privilege name(s): Read Static Mobile Device Groups, Read Mobile Devices. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: instance id of static-group.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`. Extension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`. Example: `sort=displayName:desc,username:asc`.
  • filter: Query in the RSQL format, allowing to filter mobile device collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`. Extension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`. This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`.

func (*Client) ListStaticMobileDeviceGroupsV2 

func (c *Client) ListStaticMobileDeviceGroupsV2(ctx context.Context, sort []string, filter string) ([]StaticGroup, error)

ListStaticMobileDeviceGroupsV2 get Static Groups.

Required privileges: device-groups:read. Legacy Jamf Pro privilege name(s): Read Static Mobile Device Groups.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.
  • filter: Query in the RSQL format, allowing to filter static group collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName=="staticGroup1".

func (*Client) ListStaticUserGroupsV1 

func (c *Client) ListStaticUserGroupsV1(ctx context.Context) ([]StaticUserGroup, error)

ListStaticUserGroupsV1 return a list of all Static User Groups.

Required privileges: user-groups:read. Legacy Jamf Pro privilege name(s): Read Static User Groups.

func (*Client) ListSupervisionIdentitiesV1 

func (c *Client) ListSupervisionIdentitiesV1(ctx context.Context, sort []string) ([]SupervisionIdentity, error)

ListSupervisionIdentitiesV1 search for sorted and paged Supervision Identities.

Required privileges: apple-configurator-enrollment:read. Legacy Jamf Pro privilege name(s): Read Apple Configurator Enrollment.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.

func (*Client) ListTeacherAppHistoryV1 

func (c *Client) ListTeacherAppHistoryV1(ctx context.Context, sort []string, filter string) ([]ObjectHistory, error)

ListTeacherAppHistoryV1 get Jamf Teacher app settings history.

Required privileges: teacher-app:read. Legacy Jamf Pro privilege name(s): Read Teacher App Settings.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated.
  • filter: Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListTeamViewerSessionsPreview 

func (c *Client) ListTeamViewerSessionsPreview(ctx context.Context, configurationID string, filter string) ([]SessionDetails, error)

ListTeamViewerSessionsPreview get a paginated list of sessions.

Required privileges: remote-administration:read. Legacy Jamf Pro privilege name(s): Read Remote Administration.

Parameters:

  • configurationID: ID of the Team Viewer connection configuration.
  • filter: Query in the RSQL format, allowing to filter sessions collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `deviceId`, `deviceType`, `state`. This param can be combined with paging.

func (*Client) ListTimeZonesV1 

func (c *Client) ListTimeZonesV1(ctx context.Context) ([]TimeZone, error)

ListTimeZonesV1 return information about the currently supported Time Zones.

Required privileges: the spec declares none.

func (*Client) ListUsersV1 

func (c *Client) ListUsersV1(ctx context.Context, sort []string, filter string, platform bool) ([]User, error)

ListUsersV1 retrieve users with pagination and filtering.

Required privileges: users:read. Legacy Jamf Pro privilege name(s): Read User.

Parameters:

  • sort: Sorting criteria in the format: property(:asc|desc). Default sort order is ascending. Multiple sort criteria are supported. Examples: - sort=username - sort=username:asc - sort=username:asc,realname:desc.
  • filter: RSQL filter to limit results. Supports all user fields. Examples: - filter=username=="john*" - filter=realname=="John Smith" - filter=email=="*@jamf.com" - filter=position=="Manager";id!="1" - filter=id=in=(123,456,789).
  • platform: Optional. Return platform identifiers instead of internal identifiers when set to true.

func (*Client) ListVenafiHistoryV1 

func (c *Client) ListVenafiHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListVenafiHistoryV1 get specified Venafi CA history object.

Required privileges: pki:read. Legacy Jamf Pro privilege name(s): Read PKI.

Parameters:

  • id: ID of the Venafi configuration.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListVolumePurchasingLocationContentV1 

func (c *Client) ListVolumePurchasingLocationContentV1(ctx context.Context, id string, sort []string, filter string) ([]VolumePurchasingContent, error)

ListVolumePurchasingLocationContentV1 retrieve the Volume Purchasing Content for the Volume Purchasing Location with the supplied id.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Location identifier.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Volume Purchasing Content collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, licenseCountTotal, licenseCountInUse, licenseCountReported, contentType, and pricingParam. This param can be combined with paging and sorting.

func (*Client) ListVolumePurchasingLocationHistoryV1 

func (c *Client) ListVolumePurchasingLocationHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListVolumePurchasingLocationHistoryV1 get specified Volume Purchasing Location history object.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • id: instance id of Volume Purchasing Location history record.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListVolumePurchasingLocationsV1 

func (c *Client) ListVolumePurchasingLocationsV1(ctx context.Context, sort []string, filter string) ([]VolumePurchasingLocationListView, error)

ListVolumePurchasingLocationsV1 retrieve Volume Purchasing Locations.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter Volume Purchasing Location collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, appleId, email, organizationName, tokenExpiration, countryCode, locationName, automaticallyPopulatePurchasedContent, sendNotificationWhenNoLongerAssigned, siteId and siteName. This param can be combined with paging and sorting.

func (*Client) ListVolumePurchasingSubscriptionHistoryV1 

func (c *Client) ListVolumePurchasingSubscriptionHistoryV1(ctx context.Context, id string, sort []string, filter string) ([]ObjectHistory, error)

ListVolumePurchasingSubscriptionHistoryV1 get specified Volume Purchasing Subscription history object.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Subscription Id.
  • sort: Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma.
  • filter: Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query
  • returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15.

func (*Client) ListVolumePurchasingSubscriptionsV1 

func (c *Client) ListVolumePurchasingSubscriptionsV1(ctx context.Context, sort []string) ([]VolumePurchasingSubscription, error)

ListVolumePurchasingSubscriptionsV1 retrieve Volume Purchasing Subscriptions.

Required privileges: volume-purchasing-locations:read. Legacy Jamf Pro privilege name(s): Read Volume Purchasing Locations.

Parameters:

  • sort: Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Allowable properties are id, name, and enabled.

func (*Client) ParseEnrollmentCustomizationMarkdownV1 

func (c *Client) ParseEnrollmentCustomizationMarkdownV1(ctx context.Context, request *Markdown) (*Markdown, error)

ParseEnrollmentCustomizationMarkdownV1 parse the given string as markdown text and return Html output.

Required privileges: enrollment-customization:read. Legacy Jamf Pro privilege name(s): Read Enrollment Customizations.

func (*Client) ParseSsoCertificateV2 

func (c *Client) ParseSsoCertificateV2(ctx context.Context, request *SsoKeystoreParse) (*SsoKeystoreCertParseResponse, error)

ParseSsoCertificateV2 parse the certificate to get details about certificate type and keys needed to upload certificate file.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) PatchDistributionPointV1 

func (c *Client) PatchDistributionPointV1(ctx context.Context, id string, request *DistributionPoint) (*DistributionPoint, error)

PatchDistributionPointV1 update specified distribution point object.

Required privileges: distribution-points:read, distribution-points:update. Legacy Jamf Pro privilege name(s): Read Distribution Points, Update Distribution Points. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Instance id of distribution point.

func (*Client) PatchGSXConnectionV1 

func (c *Client) PatchGSXConnectionV1(ctx context.Context, request *GsxConnectionUpdate) (*GsxConnection, error)

PatchGSXConnectionV1 updates Jamf Pro GSX Connection information.

Required privileges: gsx-connection:update, push-certificates:update. Legacy Jamf Pro privilege name(s): Update GSX Connection, Update Push Certificates. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) PatchGroupV2 

func (c *Client) PatchGroupV2(ctx context.Context, id string, request *GroupUpdateDtoV2) error

PatchGroupV2 update a group by platform UUID.

Required privileges: device-groups:update.

Parameters:

  • id: The platform UUID of a group.

func (*Client) PatchMobileDeviceV2 

func (c *Client) PatchMobileDeviceV2(ctx context.Context, id string, request *UpdateMobileDeviceV2) (*MobileDeviceDetailsV2, error)

PatchMobileDeviceV2 update fields on a mobile device that are allowed to be modified by users.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Mobile Devices.

Parameters:

  • id: instance id of mobile device record.

func (*Client) PatchStaticMobileDeviceGroupV2 

func (c *Client) PatchStaticMobileDeviceGroupV2(ctx context.Context, id string, request *StaticGroupAssignment) (*StaticGroupAssignment, error)

PatchStaticMobileDeviceGroupV2 update a static group.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Static Mobile Device Groups.

Parameters:

  • id: instance id of static-group.

func (*Client) RecalculateComputerSmartGroupsV1 

func (c *Client) RecalculateComputerSmartGroupsV1(ctx context.Context, id string) (*RecalculationResults, error)

RecalculateComputerSmartGroupsV1 recalculate a smart group for the given id.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Smart Computer Groups.

Parameters:

  • id: id of computer.

func (*Client) RecalculateMobileDeviceSmartGroupsV1 

func (c *Client) RecalculateMobileDeviceSmartGroupsV1(ctx context.Context, id string) (*RecalculationResults, error)

RecalculateMobileDeviceSmartGroupsV1 recalculate all smart groups for the given device id and then return count of smart groups that device fall into.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Smart Mobile Device Groups.

Parameters:

  • id: id of mobile device.

func (*Client) RecalculateSmartComputerGroupV1 

func (c *Client) RecalculateSmartComputerGroupV1(ctx context.Context, id string) (*RecalculationResults, error)

RecalculateSmartComputerGroupV1 recalculate the smart group for the given id.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Smart Computer Groups.

Parameters:

  • id: instance id of smart group.

func (*Client) RecalculateSmartMobileDeviceGroupV1 

func (c *Client) RecalculateSmartMobileDeviceGroupV1(ctx context.Context, id string) (*RecalculationResults, error)

RecalculateSmartMobileDeviceGroupV1 recalculate a smart group for the given id then return the ids for the devices in the smart group.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Smart Mobile Device Groups.

Parameters:

  • id: instance id of smart group.

func (*Client) RecalculateSmartUserGroupV1 

func (c *Client) RecalculateSmartUserGroupV1(ctx context.Context, id string) (*RecalculationResults, error)

RecalculateSmartUserGroupV1 recalculate the smart group for the given id and then return the ids for the users in the smart group.

Required privileges: user-groups:update. Legacy Jamf Pro privilege name(s): Update Smart User Groups.

Parameters:

  • id: instance id of smart group.

func (*Client) RecalculateUserSmartGroupsV1 

func (c *Client) RecalculateUserSmartGroupsV1(ctx context.Context, id string) (*RecalculationResults, error)

RecalculateUserSmartGroupsV1 recalculate a smart group for the given user id and then return the count of smart groups the user falls into.

Required privileges: user-groups:update. Legacy Jamf Pro privilege name(s): Update Smart User Groups.

Parameters:

  • id: id of user.

func (*Client) ReclaimVolumePurchasingLocationLicensesV1 

func (c *Client) ReclaimVolumePurchasingLocationLicensesV1(ctx context.Context, id string) error

ReclaimVolumePurchasingLocationLicensesV1 reclaim a Volume Purchasing Location with the supplied id.

Required privileges: volume-purchasing-locations:update. Legacy Jamf Pro privilege name(s): Update Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Location identifier.

func (*Client) RedeployJamfManagementFrameworkV1 

func (c *Client) RedeployJamfManagementFrameworkV1(ctx context.Context, id string) (*RedeployJamfManagementFrameworkResponse, error)

RedeployJamfManagementFrameworkV1 redeploy Jamf Management Framework.

Required privileges: computer-check-in:read, device-actions:execute. Legacy Jamf Pro privilege name(s): Send Computer Remote Command to Install Package, Read Computer Check-In. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: instance id of computer.

func (*Client) RefreshCloudDistributionPointInventoryV1 

func (c *Client) RefreshCloudDistributionPointInventoryV1(ctx context.Context, fileName string) error

RefreshCloudDistributionPointInventoryV1 updates inventory data for the currently configured cloud distribution point.

Required privileges: cloud-distribution-point:read. Legacy Jamf Pro privilege name(s): Read Cloud Distribution Point.

Parameters:

  • fileName: Name of the file to check the availability of. If available, the inventory and status will be updated in Jamf Pro. If no file is specified, it will force an immediate inventory refresh at a rate-limit of once every 15 seconds.

func (*Client) RefreshJCDSInventoryV1 deprecated 

func (c *Client) RefreshJCDSInventoryV1(ctx context.Context, fileName string) error

RefreshJCDSInventoryV1 refreshes the inventory and status of uploads in Jamf Pro. This will update the status of uploads in the Jamf Pro database and allow the uploads to be deployed.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-08-28) and may be removed in a future release.

Required privileges: jamf-cloud-distribution-service-files:read. Legacy Jamf Pro privilege name(s): Read Jamf Cloud Distribution Service Files.

Parameters:

  • fileName: Name of the file to check the availability of in JCDS. If available, the inventory and status will be updated in Jamf Pro. If no file is specified, it will force an immediate inventory refresh at a rate-limit of once every 15 seconds.

func (*Client) RegenerateVenafiJamfPublicKeyV1 

func (c *Client) RegenerateVenafiJamfPublicKeyV1(ctx context.Context, id string) error

RegenerateVenafiJamfPublicKeyV1 regenerates a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) RegisterJamfProtectV1 

func (c *Client) RegisterJamfProtectV1(ctx context.Context, request *ProtectRegistrationRequest) (*ProtectSettingsResponse, error)

RegisterJamfProtectV1 register a Jamf Protect API configuration with Jamf Pro.

Required privileges: jamf-protect-deployments:update. Legacy Jamf Pro privilege name(s): Update Jamf Protect Settings.

func (*Client) ReinstallMobileDeviceAppConfigV1 

func (c *Client) ReinstallMobileDeviceAppConfigV1(ctx context.Context, request *AppConfigReinstallCode) error

ReinstallMobileDeviceAppConfigV1 reinstall App Config for Managed iOS Apps.

Required privileges: the spec declares none.

func (*Client) RemoveFromComputerPrestageScopeV2 

func (c *Client) RemoveFromComputerPrestageScopeV2(ctx context.Context, id string, request *PrestageScopeUpdate) (*PrestageScopeResponseV2, error)

RemoveFromComputerPrestageScopeV2 remove device Scope for a specific Computer Prestage.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) RemoveFromMobileDevicePrestageScopeV2 

func (c *Client) RemoveFromMobileDevicePrestageScopeV2(ctx context.Context, id string, request *PrestageScopeUpdate) (*PrestageScopeResponseV2, error)

RemoveFromMobileDevicePrestageScopeV2 remove Device Scope for a specific Mobile Device Prestage.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) RemoveMdmProfileFromComputerV4 

func (c *Client) RemoveMdmProfileFromComputerV4(ctx context.Context, id string) (*RemoveComputerMDMProfileResponse, error)

RemoveMdmProfileFromComputerV4 remove a computer's MDM profile.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Send Computer Unmanage Command.

Parameters:

  • id: Id of the computer to remove the MDM profile from.

func (*Client) RemovePatchPolicyFromDashboardV2 

func (c *Client) RemovePatchPolicyFromDashboardV2(ctx context.Context, id string) error

RemovePatchPolicyFromDashboardV2 remove a patch policy from the dashboard.

Required privileges: patch-policies:read. Legacy Jamf Pro privilege name(s): Read Patch Policies.

Parameters:

  • id: patch policy id.

func (*Client) RemovePatchSoftwareTitleFromDashboardV3 

func (c *Client) RemovePatchSoftwareTitleFromDashboardV3(ctx context.Context, id string) error

RemovePatchSoftwareTitleFromDashboardV3 remove a software title configuration from the dashboard.

Required privileges: patch-management-software-titles:read. Legacy Jamf Pro privilege name(s): Read Patch Management Software Titles.

Parameters:

  • id: software title configuration id.

func (*Client) RenewJCDSCredentialsV1 deprecated 

func (c *Client) RenewJCDSCredentialsV1(ctx context.Context) (*Credentials, error)

RenewJCDSCredentialsV1 renew credentials for an upload to the Jamf Cloud Distribution Service.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2025-08-28) and may be removed in a future release.

Required privileges: jamf-cloud-distribution-service-files:create. Legacy Jamf Pro privilege name(s): Create Jamf Cloud Distribution Service Files.

func (*Client) RenewMdmProfileV1 

func (c *Client) RenewMdmProfileV1(ctx context.Context, request *Udids) (*RenewMDMProfileResponse, error)

RenewMdmProfileV1 renew MDM Profile.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send Command to Renew MDM Profile.

func (*Client) ReorderAppRequestFormInputFieldsV1 

func (c *Client) ReorderAppRequestFormInputFieldsV1(ctx context.Context, request *[]AppRequestFormInputField) ([]AppRequestFormInputField, error)

ReorderAppRequestFormInputFieldsV1 replace all Form Input Fields.

Required privileges: app-request:update. Legacy Jamf Pro privilege name(s): Update App Request Settings.

func (*Client) ReplaceComputerPrestageScopeV2 

func (c *Client) ReplaceComputerPrestageScopeV2(ctx context.Context, id string, request *PrestageScopeUpdate) (*PrestageScopeResponseV2, error)

ReplaceComputerPrestageScopeV2 replace device Scope for a specific Computer Prestage.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) ReplaceDeviceEnrollmentTokenV1 

func (c *Client) ReplaceDeviceEnrollmentTokenV1(ctx context.Context, id string, request *DeviceEnrollmentToken) (*DeviceEnrollmentInstance, error)

ReplaceDeviceEnrollmentTokenV1 update a Device Enrollment Instance with the supplied Token.

Required privileges: device-enrollment-program-instances:update. Legacy Jamf Pro privilege name(s): Update Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) ReplaceMobileDevicePrestageScopeV2 

func (c *Client) ReplaceMobileDevicePrestageScopeV2(ctx context.Context, id string, request *PrestageScopeUpdate) (*PrestageScopeResponseV2, error)

ReplaceMobileDevicePrestageScopeV2 replace Device Scope for a specific Mobile Device Prestage.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) ResendTeamViewerSessionNotificationPreview 

func (c *Client) ResendTeamViewerSessionNotificationPreview(ctx context.Context, configurationID string, sessionID string) error

ResendTeamViewerSessionNotificationPreview resend nofications for a session.

Required privileges: remote-administration:update. Legacy Jamf Pro privilege name(s): Update Remote Administration.

Parameters:

  • configurationID: ID of the Team Viewer connection configuration.
  • sessionID: ID of the Team Viewer session.

func (*Client) ResolveAccountGroupV1ByName 

func (c *Client) ResolveAccountGroupV1ByName(ctx context.Context, name string) (*AccountGroupV1, error)

ResolveAccountGroupV1ByName looks up a AccountGroupV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveAccountGroupV1IDByName 

func (c *Client) ResolveAccountGroupV1IDByName(ctx context.Context, name string) (string, error)

ResolveAccountGroupV1IDByName looks up a AccountGroupV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveAccountV1ByName 

func (c *Client) ResolveAccountV1ByName(ctx context.Context, name string) (*UserAccount, error)

ResolveAccountV1ByName looks up a AccountV1 by its username field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveAccountV1IDByName 

func (c *Client) ResolveAccountV1IDByName(ctx context.Context, name string) (string, error)

ResolveAccountV1IDByName looks up a AccountV1 by its username field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveAdvancedMobileDeviceSearchV1ByName 

func (c *Client) ResolveAdvancedMobileDeviceSearchV1ByName(ctx context.Context, name string) (*AdvancedSearch, error)

ResolveAdvancedMobileDeviceSearchV1ByName looks up a AdvancedMobileDeviceSearchV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveAdvancedMobileDeviceSearchV1IDByName 

func (c *Client) ResolveAdvancedMobileDeviceSearchV1IDByName(ctx context.Context, name string) (string, error)

ResolveAdvancedMobileDeviceSearchV1IDByName looks up a AdvancedMobileDeviceSearchV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveAdvancedUserContentSearchV1ByName 

func (c *Client) ResolveAdvancedUserContentSearchV1ByName(ctx context.Context, name string) (*AdvancedUserContentSearch, error)

ResolveAdvancedUserContentSearchV1ByName looks up a AdvancedUserContentSearchV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveAdvancedUserContentSearchV1IDByName 

func (c *Client) ResolveAdvancedUserContentSearchV1IDByName(ctx context.Context, name string) (string, error)

ResolveAdvancedUserContentSearchV1IDByName looks up a AdvancedUserContentSearchV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveAppRequestFormInputFieldV1ByName 

func (c *Client) ResolveAppRequestFormInputFieldV1ByName(ctx context.Context, name string) (*AppRequestFormInputField, error)

ResolveAppRequestFormInputFieldV1ByName looks up a AppRequestFormInputFieldV1 by its title field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveAppRequestFormInputFieldV1IDByName 

func (c *Client) ResolveAppRequestFormInputFieldV1IDByName(ctx context.Context, name string) (string, error)

ResolveAppRequestFormInputFieldV1IDByName looks up a AppRequestFormInputFieldV1 by its title field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveBuildingV1ByName 

func (c *Client) ResolveBuildingV1ByName(ctx context.Context, name string) (*Building, error)

ResolveBuildingV1ByName looks up a BuildingV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveBuildingV1IDByName 

func (c *Client) ResolveBuildingV1IDByName(ctx context.Context, name string) (string, error)

ResolveBuildingV1IDByName looks up a BuildingV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveCategoryV1ByName 

func (c *Client) ResolveCategoryV1ByName(ctx context.Context, name string) (*Category, error)

ResolveCategoryV1ByName looks up a CategoryV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveCategoryV1IDByName 

func (c *Client) ResolveCategoryV1IDByName(ctx context.Context, name string) (string, error)

ResolveCategoryV1IDByName looks up a CategoryV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveCloudIdpV1ByName 

func (c *Client) ResolveCloudIdpV1ByName(ctx context.Context, name string) (*CloudIDPCommonResponse, error)

ResolveCloudIdpV1ByName looks up a CloudIdpV1 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveCloudIdpV1IDByName 

func (c *Client) ResolveCloudIdpV1IDByName(ctx context.Context, name string) (string, error)

ResolveCloudIdpV1IDByName looks up a CloudIdpV1 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerExtensionAttributeV1ByName 

func (c *Client) ResolveComputerExtensionAttributeV1ByName(ctx context.Context, name string) (*ComputerExtensionAttributes, error)

ResolveComputerExtensionAttributeV1ByName looks up a ComputerExtensionAttributeV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerExtensionAttributeV1IDByName 

func (c *Client) ResolveComputerExtensionAttributeV1IDByName(ctx context.Context, name string) (string, error)

ResolveComputerExtensionAttributeV1IDByName looks up a ComputerExtensionAttributeV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerGroupV1ByName 

func (c *Client) ResolveComputerGroupV1ByName(ctx context.Context, name string) (*ComputerGroup, error)

ResolveComputerGroupV1ByName looks up a ComputerGroupV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerGroupV1IDByName 

func (c *Client) ResolveComputerGroupV1IDByName(ctx context.Context, name string) (string, error)

ResolveComputerGroupV1IDByName looks up a ComputerGroupV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerInventoryV3ByName 

func (c *Client) ResolveComputerInventoryV3ByName(ctx context.Context, name string) (*ComputerInventoryV3, error)

ResolveComputerInventoryV3ByName looks up a ComputerInventoryV3 by its general.name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerInventoryV3BySerialNumber 

func (c *Client) ResolveComputerInventoryV3BySerialNumber(ctx context.Context, name string) (*ComputerInventoryV3, error)

ResolveComputerInventoryV3BySerialNumber looks up a ComputerInventoryV3 by its hardware.serialNumber field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerInventoryV3ByUDID 

func (c *Client) ResolveComputerInventoryV3ByUDID(ctx context.Context, name string) (*ComputerInventoryV3, error)

ResolveComputerInventoryV3ByUDID looks up a ComputerInventoryV3 by its udid field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerInventoryV3IDByName 

func (c *Client) ResolveComputerInventoryV3IDByName(ctx context.Context, name string) (string, error)

ResolveComputerInventoryV3IDByName looks up a ComputerInventoryV3 by its general.name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerInventoryV3IDBySerialNumber 

func (c *Client) ResolveComputerInventoryV3IDBySerialNumber(ctx context.Context, name string) (string, error)

ResolveComputerInventoryV3IDBySerialNumber looks up a ComputerInventoryV3 by its hardware.serialNumber field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerInventoryV3IDByUDID 

func (c *Client) ResolveComputerInventoryV3IDByUDID(ctx context.Context, name string) (string, error)

ResolveComputerInventoryV3IDByUDID looks up a ComputerInventoryV3 by its udid field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerInventoryV4ByName 

func (c *Client) ResolveComputerInventoryV4ByName(ctx context.Context, name string) (*ComputerInventoryV4, error)

ResolveComputerInventoryV4ByName looks up a ComputerInventoryV4 by its general.name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerInventoryV4BySerialNumber 

func (c *Client) ResolveComputerInventoryV4BySerialNumber(ctx context.Context, name string) (*ComputerInventoryV4, error)

ResolveComputerInventoryV4BySerialNumber looks up a ComputerInventoryV4 by its hardware.serialNumber field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerInventoryV4ByUDID 

func (c *Client) ResolveComputerInventoryV4ByUDID(ctx context.Context, name string) (*ComputerInventoryV4, error)

ResolveComputerInventoryV4ByUDID looks up a ComputerInventoryV4 by its udid field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerInventoryV4IDByName 

func (c *Client) ResolveComputerInventoryV4IDByName(ctx context.Context, name string) (string, error)

ResolveComputerInventoryV4IDByName looks up a ComputerInventoryV4 by its general.name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerInventoryV4IDBySerialNumber 

func (c *Client) ResolveComputerInventoryV4IDBySerialNumber(ctx context.Context, name string) (string, error)

ResolveComputerInventoryV4IDBySerialNumber looks up a ComputerInventoryV4 by its hardware.serialNumber field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerInventoryV4IDByUDID 

func (c *Client) ResolveComputerInventoryV4IDByUDID(ctx context.Context, name string) (string, error)

ResolveComputerInventoryV4IDByUDID looks up a ComputerInventoryV4 by its udid field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveComputerPrestageV3ByName 

func (c *Client) ResolveComputerPrestageV3ByName(ctx context.Context, name string) (*ComputerPrestageV3, error)

ResolveComputerPrestageV3ByName looks up a ComputerPrestageV3 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveComputerPrestageV3IDByName 

func (c *Client) ResolveComputerPrestageV3IDByName(ctx context.Context, name string) (string, error)

ResolveComputerPrestageV3IDByName looks up a ComputerPrestageV3 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveDepartmentV1ByName 

func (c *Client) ResolveDepartmentV1ByName(ctx context.Context, name string) (*Department, error)

ResolveDepartmentV1ByName looks up a DepartmentV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveDepartmentV1IDByName 

func (c *Client) ResolveDepartmentV1IDByName(ctx context.Context, name string) (string, error)

ResolveDepartmentV1IDByName looks up a DepartmentV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveDeviceEnrollmentV1ByName 

func (c *Client) ResolveDeviceEnrollmentV1ByName(ctx context.Context, name string) (*DeviceEnrollmentInstance, error)

ResolveDeviceEnrollmentV1ByName looks up a DeviceEnrollmentV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveDeviceEnrollmentV1IDByName 

func (c *Client) ResolveDeviceEnrollmentV1IDByName(ctx context.Context, name string) (string, error)

ResolveDeviceEnrollmentV1IDByName looks up a DeviceEnrollmentV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveDistributionPointV1ByName 

func (c *Client) ResolveDistributionPointV1ByName(ctx context.Context, name string) (*DistributionPoint, error)

ResolveDistributionPointV1ByName looks up a DistributionPointV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveDistributionPointV1IDByName 

func (c *Client) ResolveDistributionPointV1IDByName(ctx context.Context, name string) (string, error)

ResolveDistributionPointV1IDByName looks up a DistributionPointV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveEbookV1ByName 

func (c *Client) ResolveEbookV1ByName(ctx context.Context, name string) (*Ebook, error)

ResolveEbookV1ByName looks up a EbookV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveEbookV1IDByName 

func (c *Client) ResolveEbookV1IDByName(ctx context.Context, name string) (string, error)

ResolveEbookV1IDByName looks up a EbookV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveEnrollmentAccessGroupV3ByName 

func (c *Client) ResolveEnrollmentAccessGroupV3ByName(ctx context.Context, name string) (*EnrollmentAccessGroupPreview, error)

ResolveEnrollmentAccessGroupV3ByName looks up a EnrollmentAccessGroupV3 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveEnrollmentAccessGroupV3IDByName 

func (c *Client) ResolveEnrollmentAccessGroupV3IDByName(ctx context.Context, name string) (string, error)

ResolveEnrollmentAccessGroupV3IDByName looks up a EnrollmentAccessGroupV3 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveEnrollmentCustomizationV2ByName 

func (c *Client) ResolveEnrollmentCustomizationV2ByName(ctx context.Context, name string) (*EnrollmentCustomizationV2, error)

ResolveEnrollmentCustomizationV2ByName looks up a EnrollmentCustomizationV2 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveEnrollmentCustomizationV2IDByName 

func (c *Client) ResolveEnrollmentCustomizationV2IDByName(ctx context.Context, name string) (string, error)

ResolveEnrollmentCustomizationV2IDByName looks up a EnrollmentCustomizationV2 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveEnrollmentLanguageV3ByName 

func (c *Client) ResolveEnrollmentLanguageV3ByName(ctx context.Context, name string) (*EnrollmentProcessTextObject, error)

ResolveEnrollmentLanguageV3ByName looks up a EnrollmentLanguageV3 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveEnrollmentLanguageV3IDByName 

func (c *Client) ResolveEnrollmentLanguageV3IDByName(ctx context.Context, name string) (string, error)

ResolveEnrollmentLanguageV3IDByName looks up a EnrollmentLanguageV3 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveGroupV2ByName 

func (c *Client) ResolveGroupV2ByName(ctx context.Context, name string) (*GroupDtoV1, error)

ResolveGroupV2ByName looks up a GroupV2 by its groupName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveGroupV2IDByName 

func (c *Client) ResolveGroupV2IDByName(ctx context.Context, name string) (string, error)

ResolveGroupV2IDByName looks up a GroupV2 by its groupName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveIOSBrandingConfigurationV1ByName 

func (c *Client) ResolveIOSBrandingConfigurationV1ByName(ctx context.Context, name string) (*IosBrandingConfiguration, error)

ResolveIOSBrandingConfigurationV1ByName looks up a IOSBrandingConfigurationV1 by its brandingName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveIOSBrandingConfigurationV1IDByName 

func (c *Client) ResolveIOSBrandingConfigurationV1IDByName(ctx context.Context, name string) (string, error)

ResolveIOSBrandingConfigurationV1IDByName looks up a IOSBrandingConfigurationV1 by its brandingName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveInventoryPreloadRecordV2BySerialNumber 

func (c *Client) ResolveInventoryPreloadRecordV2BySerialNumber(ctx context.Context, name string) (*InventoryPreloadRecordV2, error)

ResolveInventoryPreloadRecordV2BySerialNumber looks up a InventoryPreloadRecordV2 by its serialNumber field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveInventoryPreloadRecordV2IDBySerialNumber 

func (c *Client) ResolveInventoryPreloadRecordV2IDBySerialNumber(ctx context.Context, name string) (string, error)

ResolveInventoryPreloadRecordV2IDBySerialNumber looks up a InventoryPreloadRecordV2 by its serialNumber field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveJamfConnectConfigProfileV1ByName 

func (c *Client) ResolveJamfConnectConfigProfileV1ByName(ctx context.Context, name string) (*LinkedConnectProfile, error)

ResolveJamfConnectConfigProfileV1ByName looks up a JamfConnectConfigProfileV1 by its profileName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveJamfConnectConfigProfileV1IDByName 

func (c *Client) ResolveJamfConnectConfigProfileV1IDByName(ctx context.Context, name string) (string, error)

ResolveJamfConnectConfigProfileV1IDByName looks up a JamfConnectConfigProfileV1 by its profileName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMacOSBrandingConfigurationV1ByName 

func (c *Client) ResolveMacOSBrandingConfigurationV1ByName(ctx context.Context, name string) (*MacOsBrandingConfiguration, error)

ResolveMacOSBrandingConfigurationV1ByName looks up a MacOSBrandingConfigurationV1 by its brandingName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMacOSBrandingConfigurationV1IDByName 

func (c *Client) ResolveMacOSBrandingConfigurationV1IDByName(ctx context.Context, name string) (string, error)

ResolveMacOSBrandingConfigurationV1IDByName looks up a MacOSBrandingConfigurationV1 by its brandingName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMobileDeviceDetailV2ByName 

func (c *Client) ResolveMobileDeviceDetailV2ByName(ctx context.Context, name string) (*MobileDeviceResponse, error)

ResolveMobileDeviceDetailV2ByName looks up a MobileDeviceDetailV2 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMobileDeviceDetailV2BySerialNumber 

func (c *Client) ResolveMobileDeviceDetailV2BySerialNumber(ctx context.Context, name string) (*MobileDeviceResponse, error)

ResolveMobileDeviceDetailV2BySerialNumber looks up a MobileDeviceDetailV2 by its serialNumber field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMobileDeviceDetailV2ByUDID 

func (c *Client) ResolveMobileDeviceDetailV2ByUDID(ctx context.Context, name string) (*MobileDeviceResponse, error)

ResolveMobileDeviceDetailV2ByUDID looks up a MobileDeviceDetailV2 by its udid field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMobileDeviceDetailV2IDByName 

func (c *Client) ResolveMobileDeviceDetailV2IDByName(ctx context.Context, name string) (string, error)

ResolveMobileDeviceDetailV2IDByName looks up a MobileDeviceDetailV2 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMobileDeviceDetailV2IDBySerialNumber 

func (c *Client) ResolveMobileDeviceDetailV2IDBySerialNumber(ctx context.Context, name string) (string, error)

ResolveMobileDeviceDetailV2IDBySerialNumber looks up a MobileDeviceDetailV2 by its serialNumber field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMobileDeviceDetailV2IDByUDID 

func (c *Client) ResolveMobileDeviceDetailV2IDByUDID(ctx context.Context, name string) (string, error)

ResolveMobileDeviceDetailV2IDByUDID looks up a MobileDeviceDetailV2 by its udid field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMobileDeviceExtensionAttributeV1ByName 

func (c *Client) ResolveMobileDeviceExtensionAttributeV1ByName(ctx context.Context, name string) (*MobileDeviceExtensionAttributes, error)

ResolveMobileDeviceExtensionAttributeV1ByName looks up a MobileDeviceExtensionAttributeV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMobileDeviceExtensionAttributeV1IDByName 

func (c *Client) ResolveMobileDeviceExtensionAttributeV1IDByName(ctx context.Context, name string) (string, error)

ResolveMobileDeviceExtensionAttributeV1IDByName looks up a MobileDeviceExtensionAttributeV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMobileDeviceGroupV2ByName 

func (c *Client) ResolveMobileDeviceGroupV2ByName(ctx context.Context, name string) (*MobileDeviceGroup, error)

ResolveMobileDeviceGroupV2ByName looks up a MobileDeviceGroupV2 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMobileDeviceGroupV2IDByName 

func (c *Client) ResolveMobileDeviceGroupV2IDByName(ctx context.Context, name string) (string, error)

ResolveMobileDeviceGroupV2IDByName looks up a MobileDeviceGroupV2 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveMobileDevicePrestageV3ByName 

func (c *Client) ResolveMobileDevicePrestageV3ByName(ctx context.Context, name string) (*MobileDevicePrestageV3, error)

ResolveMobileDevicePrestageV3ByName looks up a MobileDevicePrestageV3 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveMobileDevicePrestageV3IDByName 

func (c *Client) ResolveMobileDevicePrestageV3IDByName(ctx context.Context, name string) (string, error)

ResolveMobileDevicePrestageV3IDByName looks up a MobileDevicePrestageV3 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolvePackageV1ByName 

func (c *Client) ResolvePackageV1ByName(ctx context.Context, name string) (*Package, error)

ResolvePackageV1ByName looks up a PackageV1 by its packageName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolvePackageV1IDByName 

func (c *Client) ResolvePackageV1IDByName(ctx context.Context, name string) (string, error)

ResolvePackageV1IDByName looks up a PackageV1 by its packageName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolvePatchPolicyV2ByName 

func (c *Client) ResolvePatchPolicyV2ByName(ctx context.Context, name string) (*PatchPolicyListView, error)

ResolvePatchPolicyV2ByName looks up a PatchPolicyV2 by its policyName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolvePatchPolicyV2IDByName 

func (c *Client) ResolvePatchPolicyV2IDByName(ctx context.Context, name string) (string, error)

ResolvePatchPolicyV2IDByName looks up a PatchPolicyV2 by its policyName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolvePatchSoftwareTitleConfigurationV3ByName 

func (c *Client) ResolvePatchSoftwareTitleConfigurationV3ByName(ctx context.Context, name string) (*PatchSoftwareTitleConfiguration, error)

ResolvePatchSoftwareTitleConfigurationV3ByName looks up a PatchSoftwareTitleConfigurationV3 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolvePatchSoftwareTitleConfigurationV3IDByName 

func (c *Client) ResolvePatchSoftwareTitleConfigurationV3IDByName(ctx context.Context, name string) (string, error)

ResolvePatchSoftwareTitleConfigurationV3IDByName looks up a PatchSoftwareTitleConfigurationV3 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveReturnToServiceConfigurationV1ByName 

func (c *Client) ResolveReturnToServiceConfigurationV1ByName(ctx context.Context, name string) (*ReturnToServiceConfiguration, error)

ResolveReturnToServiceConfigurationV1ByName looks up a ReturnToServiceConfigurationV1 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveReturnToServiceConfigurationV1IDByName 

func (c *Client) ResolveReturnToServiceConfigurationV1IDByName(ctx context.Context, name string) (string, error)

ResolveReturnToServiceConfigurationV1IDByName looks up a ReturnToServiceConfigurationV1 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveScriptV1ByName 

func (c *Client) ResolveScriptV1ByName(ctx context.Context, name string) (*Script, error)

ResolveScriptV1ByName looks up a ScriptV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveScriptV1IDByName 

func (c *Client) ResolveScriptV1IDByName(ctx context.Context, name string) (string, error)

ResolveScriptV1IDByName looks up a ScriptV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveSiteV1ByName 

func (c *Client) ResolveSiteV1ByName(ctx context.Context, name string) (*V1Site, error)

ResolveSiteV1ByName looks up a SiteV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveSiteV1IDByName 

func (c *Client) ResolveSiteV1IDByName(ctx context.Context, name string) (string, error)

ResolveSiteV1IDByName looks up a SiteV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveSmartComputerGroupV3ByName 

func (c *Client) ResolveSmartComputerGroupV3ByName(ctx context.Context, name string) (*SmartComputerGroupSearch, error)

ResolveSmartComputerGroupV3ByName looks up a SmartComputerGroupV3 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveSmartComputerGroupV3IDByName 

func (c *Client) ResolveSmartComputerGroupV3IDByName(ctx context.Context, name string) (string, error)

ResolveSmartComputerGroupV3IDByName looks up a SmartComputerGroupV3 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveSmartMobileDeviceGroupV2ByName 

func (c *Client) ResolveSmartMobileDeviceGroupV2ByName(ctx context.Context, name string) (*SmartGroup, error)

ResolveSmartMobileDeviceGroupV2ByName looks up a SmartMobileDeviceGroupV2 by its groupName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveSmartMobileDeviceGroupV2IDByName 

func (c *Client) ResolveSmartMobileDeviceGroupV2IDByName(ctx context.Context, name string) (string, error)

ResolveSmartMobileDeviceGroupV2IDByName looks up a SmartMobileDeviceGroupV2 by its groupName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveStaticComputerGroupV3ByName 

func (c *Client) ResolveStaticComputerGroupV3ByName(ctx context.Context, name string) (*StaticComputerGroupSummary, error)

ResolveStaticComputerGroupV3ByName looks up a StaticComputerGroupV3 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveStaticComputerGroupV3IDByName 

func (c *Client) ResolveStaticComputerGroupV3IDByName(ctx context.Context, name string) (string, error)

ResolveStaticComputerGroupV3IDByName looks up a StaticComputerGroupV3 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveStaticMobileDeviceGroupV2ByName 

func (c *Client) ResolveStaticMobileDeviceGroupV2ByName(ctx context.Context, name string) (*StaticGroup, error)

ResolveStaticMobileDeviceGroupV2ByName looks up a StaticMobileDeviceGroupV2 by its groupName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveStaticMobileDeviceGroupV2IDByName 

func (c *Client) ResolveStaticMobileDeviceGroupV2IDByName(ctx context.Context, name string) (string, error)

ResolveStaticMobileDeviceGroupV2IDByName looks up a StaticMobileDeviceGroupV2 by its groupName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveStaticUserGroupV1ByName 

func (c *Client) ResolveStaticUserGroupV1ByName(ctx context.Context, name string) (*StaticUserGroup, error)

ResolveStaticUserGroupV1ByName looks up a StaticUserGroupV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveStaticUserGroupV1IDByName 

func (c *Client) ResolveStaticUserGroupV1IDByName(ctx context.Context, name string) (string, error)

ResolveStaticUserGroupV1IDByName looks up a StaticUserGroupV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveSupervisionIdentityV1ByName 

func (c *Client) ResolveSupervisionIdentityV1ByName(ctx context.Context, name string) (*SupervisionIdentity, error)

ResolveSupervisionIdentityV1ByName looks up a SupervisionIdentityV1 by its displayName field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveSupervisionIdentityV1IDByName 

func (c *Client) ResolveSupervisionIdentityV1IDByName(ctx context.Context, name string) (string, error)

ResolveSupervisionIdentityV1IDByName looks up a SupervisionIdentityV1 by its displayName field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveUserV1ByName 

func (c *Client) ResolveUserV1ByName(ctx context.Context, name string) (*User, error)

ResolveUserV1ByName looks up a UserV1 by its username field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveUserV1IDByName 

func (c *Client) ResolveUserV1IDByName(ctx context.Context, name string) (string, error)

ResolveUserV1IDByName looks up a UserV1 by its username field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveVolumePurchasingLocationV1ByName 

func (c *Client) ResolveVolumePurchasingLocationV1ByName(ctx context.Context, name string) (*VolumePurchasingLocation, error)

ResolveVolumePurchasingLocationV1ByName looks up a VolumePurchasingLocationV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveVolumePurchasingLocationV1IDByName 

func (c *Client) ResolveVolumePurchasingLocationV1IDByName(ctx context.Context, name string) (string, error)

ResolveVolumePurchasingLocationV1IDByName looks up a VolumePurchasingLocationV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) ResolveVolumePurchasingSubscriptionV1ByName 

func (c *Client) ResolveVolumePurchasingSubscriptionV1ByName(ctx context.Context, name string) (*VolumePurchasingSubscription, error)

ResolveVolumePurchasingSubscriptionV1ByName looks up a VolumePurchasingSubscriptionV1 by its name field and returns the decoded resource. Shares the same HTTP call as the ID-only variant; error semantics are identical.

func (*Client) ResolveVolumePurchasingSubscriptionV1IDByName 

func (c *Client) ResolveVolumePurchasingSubscriptionV1IDByName(ctx context.Context, name string) (string, error)

ResolveVolumePurchasingSubscriptionV1IDByName looks up a VolumePurchasingSubscriptionV1 by its name field and returns the ID. Returns *APIResponseError with HasStatus(404) when no match exists, or *AmbiguousMatchError when multiple resources share the name.

func (*Client) RetryAllPatchPolicyLogsV2 

func (c *Client) RetryAllPatchPolicyLogsV2(ctx context.Context, id string) error

RetryAllPatchPolicyLogsV2 send retry attempts for all devices.

Required privileges: patch-policies:update. Legacy Jamf Pro privilege name(s): Update Patch Policies.

Parameters:

  • id: patch policy id.

func (*Client) RetryAppInstallerDeploymentComputerInstallationV1 

func (c *Client) RetryAppInstallerDeploymentComputerInstallationV1(ctx context.Context, id string, computerID string) error

RetryAppInstallerDeploymentComputerInstallationV1 retry installation for specified failed computer in App Installer deployment.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

Parameters:

  • id: App Title deployment identifier.
  • computerID: instance id of computer in App Installer deployment.

func (*Client) RetryAppInstallerDeploymentInstallationsV1 

func (c *Client) RetryAppInstallerDeploymentInstallationsV1(ctx context.Context, id string) error

RetryAppInstallerDeploymentInstallationsV1 retry installation for all failed computers in App Installer deployment.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

Parameters:

  • id: App Title deployment identifier.

func (*Client) RetryAppInstallerInstallationsV1 

func (c *Client) RetryAppInstallerInstallationsV1(ctx context.Context) error

RetryAppInstallerInstallationsV1 retry installation for all computers whose installation failed in any App Installer deployment.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

func (*Client) RetryJamfConnectDeploymentTasksV1 

func (c *Client) RetryJamfConnectDeploymentTasksV1(ctx context.Context, id string, request *Ids) error

RetryJamfConnectDeploymentTasksV1 request a retry of Connect install tasks.

Required privileges: jamf-connect-deployments:deploy. Legacy Jamf Pro privilege name(s): Jamf Connect Deployment Retry.

Parameters:

  • id: the UUID of the deployment associated with the retry.

func (*Client) RetryJamfProtectDeploymentTasksV1 

func (c *Client) RetryJamfProtectDeploymentTasksV1(ctx context.Context, id string, request *Ids) error

RetryJamfProtectDeploymentTasksV1 request a retry of Protect install tasks.

Required privileges: jamf-protect-deployments:deploy. Legacy Jamf Pro privilege name(s): Jamf Protect Deployment Retry.

Parameters:

  • id: the UUID of the deployment associated with the retry.

func (*Client) RetryPatchPolicyLogsV2 

func (c *Client) RetryPatchPolicyLogsV2(ctx context.Context, id string, request *PatchPolicyLogRetry) error

RetryPatchPolicyLogsV2 send retry attempts for specific devices.

Required privileges: patch-policies:update. Legacy Jamf Pro privilege name(s): Update Patch Policies.

Parameters:

  • id: patch policy id.

func (*Client) RevokeVolumePurchasingLocationLicensesV1 

func (c *Client) RevokeVolumePurchasingLocationLicensesV1(ctx context.Context, id string) error

RevokeVolumePurchasingLocationLicensesV1 revoke licenses for a Volume Purchasing Location with the supplied id.

Required privileges: volume-purchasing-locations:update. Legacy Jamf Pro privilege name(s): Update Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Location identifier.

func (*Client) SearchLdapGroupsPreview 

func (c *Client) SearchLdapGroupsPreview(ctx context.Context, q string) (*LdapGroupSearchResults, error)

SearchLdapGroupsPreview retrieve the configured access groups that contain the text in the search param.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • q: Will perform a "contains" search on the names of access groups.

func (*Client) SearchLdapGroupsV1 

func (c *Client) SearchLdapGroupsV1(ctx context.Context, q string) (*LdapGroupSearchResults, error)

SearchLdapGroupsV1 retrieve the configured access groups that contain the text in the search param.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • q: Will perform a "contains" search on the names of access groups.

func (*Client) SendMacOsManagedSoftwareUpdatesV1 deprecated 

func (c *Client) SendMacOsManagedSoftwareUpdatesV1(ctx context.Context, request *MacOsManagedSoftwareUpdate) (*MacOsManagedSoftwareUpdateResponse, error)

SendMacOsManagedSoftwareUpdatesV1 send MacOs Managed Software Updates.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2022-10-17) and may be removed in a future release.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send Computer Remote Command to Download and Install OS X Update.

func (*Client) SendMdmBlankPushV2 

func (c *Client) SendMdmBlankPushV2(ctx context.Context, request *BlankPushRequest) (*BlankPushResponse, error)

SendMdmBlankPushV2 send blank push notifications to a list of client management IDs.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): View MDM command information in Jamf Pro API.

func (*Client) SetLocalAdminPasswordV2 

func (c *Client) SetLocalAdminPasswordV2(ctx context.Context, clientManagementID string, request *LapsUserPasswordRequestV2) (*LapsUserPasswordResponseV2, error)

SetLocalAdminPasswordV2 set the LAPS password for a device.

Required privileges: local-admin-passwords:execute. Legacy Jamf Pro privilege name(s): Send Local Admin Password Command.

Parameters:

  • clientManagementID: client management id of target device.

func (*Client) SyncDdmV1 

func (c *Client) SyncDdmV1(ctx context.Context, clientManagementID string) error

SyncDdmV1 force a device DDM sync.

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send Declarative Management Command.

Parameters:

  • clientManagementID: The client management id of the target device.

func (*Client) SyncJamfProtectPlansV1 

func (c *Client) SyncJamfProtectPlansV1(ctx context.Context) error

SyncJamfProtectPlansV1 sync Plans with Jamf Protect.

Required privileges: jamf-protect-deployments:read. Legacy Jamf Pro privilege name(s): Read Jamf Protect Settings.

func (*Client) TestCloudDistributionPointConnectionV1 

func (c *Client) TestCloudDistributionPointConnectionV1(ctx context.Context) (*CloudDistributionPointTestConnection, error)

TestCloudDistributionPointConnectionV1 get the cloud distribution point test connection details.

Required privileges: cloud-distribution-point:read. Legacy Jamf Pro privilege name(s): Read Cloud Distribution Point.

func (*Client) TestCloudIdpGroupV1 

func (c *Client) TestCloudIdpGroupV1(ctx context.Context, id string, request *GroupTestSearchRequest) (*GroupTestSearchResponse, error)

TestCloudIdpGroupV1 get group test search.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) TestCloudIdpUserMembershipV1 

func (c *Client) TestCloudIdpUserMembershipV1(ctx context.Context, id string, request *MembershipTestSearchRequest) (*MembershipTestSearchResponse, error)

TestCloudIdpUserMembershipV1 get membership test search.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) TestCloudIdpUserV1 

func (c *Client) TestCloudIdpUserV1(ctx context.Context, id string, request *UserTestSearchRequest) (*UserTestSearchResponse, error)

TestCloudIdpUserV1 get user test search.

Required privileges: ldap-servers:read. Legacy Jamf Pro privilege name(s): Read LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) TestGSXConnectionV1 

func (c *Client) TestGSXConnectionV1(ctx context.Context) error

TestGSXConnectionV1 test functionality of an GSX Connection.

Required privileges: gsx-connection:read. Legacy Jamf Pro privilege name(s): Read GSX Connection.

func (*Client) TestSmtpServerV1 

func (c *Client) TestSmtpServerV1(ctx context.Context, request *SmtpServerTest) error

TestSmtpServerV1 test functionality of an SMTP Server.

Required privileges: smtp-server:read. Legacy Jamf Pro privilege name(s): Read SMTP Server.

func (*Client) ToggleDashboardObjectV1 

func (c *Client) ToggleDashboardObjectV1(ctx context.Context, request *DashboardObject) (*HrefResponse, error)

ToggleDashboardObjectV1 add or remove an object to the Jamf Pro dashboard.

Required privileges: the spec declares none.

func (*Client) UnmanageMobileDeviceV2 

func (c *Client) UnmanageMobileDeviceV2(ctx context.Context, id string) (*UnmanageMobileDeviceResponse, error)

UnmanageMobileDeviceV2 unmanage a Mobile Device.

Required privileges: destructive-device-actions:execute. Legacy Jamf Pro privilege name(s): Unmanage Mobile Devices.

Parameters:

  • id: Id of the mobile device to remove the MDM profile from.

func (*Client) UnregisterJamfProtectV1 

func (c *Client) UnregisterJamfProtectV1(ctx context.Context) error

UnregisterJamfProtectV1 delete Jamf Protect API registration.

Required privileges: jamf-protect-deployments:update. Legacy Jamf Pro privilege name(s): Update Jamf Protect Settings.

func (*Client) UpdateADUESessionTokenSettingsV1 

func (c *Client) UpdateADUESessionTokenSettingsV1(ctx context.Context, request *AccountDrivenUserEnrollmentSessionTokenSettings) (*AccountDrivenUserEnrollmentSessionTokenSettings, error)

UpdateADUESessionTokenSettingsV1 update Account Driven User Enrollment Session Token Settings.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

func (*Client) UpdateAccountPreferencesV3 

func (c *Client) UpdateAccountPreferencesV3(ctx context.Context, request *AccountPreferencesV6, acceptLanguage string) error

UpdateAccountPreferencesV3 update Jamf Pro account preferences.

Required privileges: the spec declares none.

Parameters:

  • acceptLanguage: Locale to be used, when user has not defined preferred language.

Requires Jamf Pro 11.32 or later. `AccountPreferencesV6.showDirectoryGroupUuidColumn` is declared required as of spec 11.32.0, so the SDK sends it on every call and cannot omit it; an 11.31 or earlier tenant rejects the whole request with `400 [INVALID_CONTENT] Unrecognized field showDirectoryGroupUuidColumn … not marked as ignorable`. Check the server with `GetJamfProVersionV1` first if the tenant version is not known. The read half, `GetAccountPreferencesV3`, is unaffected.

func (*Client) UpdateAccountV1 

func (c *Client) UpdateAccountV1(ctx context.Context, id string, request *UserAccount) (*UserAccount, error)

UpdateAccountV1 updates the user account.

Required privileges: accounts:update. Legacy Jamf Pro privilege name(s): Update Accounts.

Parameters:

  • id: id of target account.

func (*Client) UpdateActivationCodeOrganizationNameV1 

func (c *Client) UpdateActivationCodeOrganizationNameV1(ctx context.Context, request *OrganizationName) error

UpdateActivationCodeOrganizationNameV1 updates Organization Name.

Required privileges: activation-code:update. Legacy Jamf Pro privilege name(s): Update License Information.

func (*Client) UpdateActivationCodeV1 

func (c *Client) UpdateActivationCodeV1(ctx context.Context, request *ActivationCode) error

UpdateActivationCodeV1 updates Activation Code.

Required privileges: activation-code:update. Legacy Jamf Pro privilege name(s): Update License Information.

func (*Client) UpdateAdcsSettingsV1 

func (c *Client) UpdateAdcsSettingsV1(ctx context.Context, id string, request *AdcsSettings) error

UpdateAdcsSettingsV1 update AD CS Settings configuration.

Required privileges: ad-cs-settings:update. Legacy Jamf Pro privilege name(s): Update AD CS Settings.

Parameters:

  • id: ID of the AD CS Settings configuration.

func (*Client) UpdateAdvancedMobileDeviceSearchV1 

func (c *Client) UpdateAdvancedMobileDeviceSearchV1(ctx context.Context, id string, request *AdvancedSearch) (*AdvancedSearch, error)

UpdateAdvancedMobileDeviceSearchV1 get specified Advanced Search object.

Required privileges: advanced-device-searches:update. Legacy Jamf Pro privilege name(s): Update Advanced Mobile Device Searches.

Parameters:

  • id: id of target Advanced Search.

func (*Client) UpdateAdvancedUserContentSearchV1 

func (c *Client) UpdateAdvancedUserContentSearchV1(ctx context.Context, id string, request *AdvancedUserContentSearch) (*AdvancedUserContentSearch, error)

UpdateAdvancedUserContentSearchV1 get Specified Advanced User Content Search object.

Required privileges: advanced-user-searches:update. Legacy Jamf Pro privilege name(s): Update Advanced User Content Searches.

Parameters:

  • id: id of target Advanced User Content Search.

func (*Client) UpdateAppInstallerDeploymentV1 

func (c *Client) UpdateAppInstallerDeploymentV1(ctx context.Context, id string, request *AppTitleDeployment) (*AppTitleDeploymentRead, error)

UpdateAppInstallerDeploymentV1 updates App Installer deployment.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

Parameters:

  • id: App Title deployment identifier.

func (*Client) UpdateAppInstallerDeploymentVersionV1 

func (c *Client) UpdateAppInstallerDeploymentVersionV1(ctx context.Context, id string, request *AppTitleVersion) error

UpdateAppInstallerDeploymentVersionV1 update app title version for deployment.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

Parameters:

  • id: App Title deployment identifier.

func (*Client) UpdateAppInstallerGlobalSettingsV1 

func (c *Client) UpdateAppInstallerGlobalSettingsV1(ctx context.Context, request *AppInstallersGlobalSettings) (*AppInstallersGlobalSettings, error)

UpdateAppInstallerGlobalSettingsV1 update global settings for app installers.

Required privileges: applications:update. Legacy Jamf Pro privilege name(s): Update Mac Applications.

func (*Client) UpdateAppRequestFormInputFieldV1 

func (c *Client) UpdateAppRequestFormInputFieldV1(ctx context.Context, id string, request *AppRequestFormInputField) (*AppRequestFormInputField, error)

UpdateAppRequestFormInputFieldV1 update specified Form Input Field object.

Required privileges: app-request:update. Legacy Jamf Pro privilege name(s): Update App Request Settings.

Parameters:

  • id: Instance id of form input field record.

func (*Client) UpdateAppRequestSettingsV1 

func (c *Client) UpdateAppRequestSettingsV1(ctx context.Context, request *AppRequestSettings) (*AppRequestSettings, error)

UpdateAppRequestSettingsV1 update Application Request Settings.

Required privileges: app-request:update. Legacy Jamf Pro privilege name(s): Update App Request Settings.

func (*Client) UpdateBuildingV1 

func (c *Client) UpdateBuildingV1(ctx context.Context, id string, request *Building) (*Building, error)

UpdateBuildingV1 update specified Building object.

Required privileges: buildings:update. Legacy Jamf Pro privilege name(s): Update Buildings.

Parameters:

  • id: instance id of building record.

func (*Client) UpdateCacheSettingsV1 

func (c *Client) UpdateCacheSettingsV1(ctx context.Context, request *CacheSettings) (*CacheSettings, error)

UpdateCacheSettingsV1 update Cache Settings.

Required privileges: cache:update. Legacy Jamf Pro privilege name(s): Update Cache.

func (*Client) UpdateCategoryV1 

func (c *Client) UpdateCategoryV1(ctx context.Context, id string, request *Category) (*Category, error)

UpdateCategoryV1 update specified Category object.

Required privileges: categories:update. Legacy Jamf Pro privilege name(s): Update Categories.

Parameters:

  • id: instance id of category record.

func (*Client) UpdateCheckInSettingsV3 

func (c *Client) UpdateCheckInSettingsV3(ctx context.Context, request *ClientCheckInV3) (*ClientCheckInV3, error)

UpdateCheckInSettingsV3 update Client Check-In object.

Required privileges: computer-check-in:update. Legacy Jamf Pro privilege name(s): Update Computer Check-In.

func (*Client) UpdateCloudAzureV1 

func (c *Client) UpdateCloudAzureV1(ctx context.Context, id string, request *AzureConfigurationUpdate) (*AzureConfiguration, error)

UpdateCloudAzureV1 update Azure Cloud Identity Provider configuration.

Required privileges: ldap-servers:update. Legacy Jamf Pro privilege name(s): Update LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) UpdateCloudDistributionPointV1 

func (c *Client) UpdateCloudDistributionPointV1(ctx context.Context, request *CloudDistributionPoint) (*CloudDistributionPoint, error)

UpdateCloudDistributionPointV1 update specific fields on a cloud distribution point.

Required privileges: cloud-distribution-point:update. Legacy Jamf Pro privilege name(s): Update Cloud Distribution Point.

func (*Client) UpdateCloudLdapMappingsV2 

func (c *Client) UpdateCloudLdapMappingsV2(ctx context.Context, id string, request *CloudLdapMappingsRequest) (*CloudLdapMappingsResponse, error)

UpdateCloudLdapMappingsV2 update Cloud Identity Provider mappings configuration.

Required privileges: ldap-servers:update. Legacy Jamf Pro privilege name(s): Update LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) UpdateCloudLdapV2 

func (c *Client) UpdateCloudLdapV2(ctx context.Context, id string, request *LdapConfigurationUpdate) (*LdapConfigurationResponse, error)

UpdateCloudLdapV2 update Cloud Identity Provider configuration.

Required privileges: ldap-servers:update. Legacy Jamf Pro privilege name(s): Update LDAP Servers.

Parameters:

  • id: Cloud Identity Provider identifier.

func (*Client) UpdateComputerExtensionAttributeV1 

func (c *Client) UpdateComputerExtensionAttributeV1(ctx context.Context, id string, request *ComputerExtensionAttributes) (*ComputerExtensionAttributes, error)

UpdateComputerExtensionAttributeV1 update specified Computer Extension Attribute object.

Required privileges: extension-attributes:update. Legacy Jamf Pro privilege name(s): Update Computer Extension Attributes.

Parameters:

  • id: Unique ID of Computer Extension Attribute.

func (*Client) UpdateComputerInventoryCollectionSettingsV2 

func (c *Client) UpdateComputerInventoryCollectionSettingsV2(ctx context.Context, request *ComputerInventoryCollectionSettingsV2) error

UpdateComputerInventoryCollectionSettingsV2 update computer inventory settings.

Required privileges: computer-inventory-collection-settings:update. Legacy Jamf Pro privilege name(s): Update Computer Inventory Collection Settings.

func (*Client) UpdateComputerInventoryDetailV3 deprecated 

func (c *Client) UpdateComputerInventoryDetailV3(ctx context.Context, id string, request *ComputerInventoryUpdateRequest) error

UpdateComputerInventoryDetailV3 update specific fields on a computer.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Computers.

Parameters:

  • id: instance id of computer record.

func (*Client) UpdateComputerInventoryDetailV4 

func (c *Client) UpdateComputerInventoryDetailV4(ctx context.Context, id string, request *ComputerInventoryUpdateRequest) error

UpdateComputerInventoryDetailV4 update specific fields on a computer.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Computers.

Parameters:

  • id: instance id of computer record.

func (*Client) UpdateComputerPrestageV3 

func (c *Client) UpdateComputerPrestageV3(ctx context.Context, id string, request *PutComputerPrestageV3) (*GetComputerPrestageV3, error)

UpdateComputerPrestageV3 update a Computer Prestage.

This endpoint requires an optimistic-lock precondition in its request body, sourced from a prior GET. The transport does NOT auto-retry a 5xx here — unlike other PUT/DELETE/GET/HEAD calls — because a blind retry would replay the now-stale precondition and could turn a successful-but-500ing write into a masked conflict on the retried attempt. See client.DoWithContentTypeNoRetry.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Computer PreStage Enrollments.

Parameters:

  • id: Computer Prestage identifier.

func (*Client) UpdateDepartmentV1 

func (c *Client) UpdateDepartmentV1(ctx context.Context, id string, request *Department) (*Department, error)

UpdateDepartmentV1 update specified department object.

Required privileges: departments:update. Legacy Jamf Pro privilege name(s): Update Departments.

Parameters:

  • id: instance id of department record.

func (*Client) UpdateDeviceCommunicationSettingsV1 

func (c *Client) UpdateDeviceCommunicationSettingsV1(ctx context.Context, request *DeviceCommunicationSettings) (*DeviceCommunicationSettings, error)

UpdateDeviceCommunicationSettingsV1 update device communication settings.

Required privileges: mdm-profile-renewal-settings:update. Legacy Jamf Pro privilege name(s): Update Automatically Renew MDM Profile Settings.

func (*Client) UpdateDeviceEnrollmentV1 

func (c *Client) UpdateDeviceEnrollmentV1(ctx context.Context, id string, request *DeviceEnrollmentInstance) (*DeviceEnrollmentInstance, error)

UpdateDeviceEnrollmentV1 update a Device Enrollment Instance with the supplied id.

Required privileges: device-enrollment-program-instances:update. Legacy Jamf Pro privilege name(s): Update Device Enrollment Program Instances.

Parameters:

  • id: Device Enrollment Instance identifier.

func (*Client) UpdateDigicertTrustLifecycleManagerV1 

func (c *Client) UpdateDigicertTrustLifecycleManagerV1(ctx context.Context, id string, request *DigiCertSetting) error

UpdateDigicertTrustLifecycleManagerV1 update DigiCert Trust Lifecycle Manager configuration.

Required privileges: digicert-settings:update. Legacy Jamf Pro privilege name(s): Update DigiCert Settings.

Parameters:

  • id: ID of the DigiCert Trust Lifecycle Manager configuration.

func (*Client) UpdateDistributionPointV1 

func (c *Client) UpdateDistributionPointV1(ctx context.Context, id string, request *DistributionPoint) (*DistributionPoint, error)

UpdateDistributionPointV1 update specified distribution point object.

Required privileges: distribution-points:read, distribution-points:update. Legacy Jamf Pro privilege name(s): Read Distribution Points, Update Distribution Points. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Instance id of distribution point.

func (*Client) UpdateDockItemV1 

func (c *Client) UpdateDockItemV1(ctx context.Context, id string, request *DockItem) ([]byte, error)

UpdateDockItemV1 replace the dockItem at the id with the supplied information.

Required privileges: dock-items:update. Legacy Jamf Pro privilege name(s): Update Dock Items.

Parameters:

  • id: DockItem object identifier.

func (*Client) UpdateEnrollmentAccessGroupV3 

func (c *Client) UpdateEnrollmentAccessGroupV3(ctx context.Context, id string, request *EnrollmentAccessGroupPreview) (*EnrollmentAccessGroupPreview, error)

UpdateEnrollmentAccessGroupV3 modify the configured LDAP groups configured for User-Initiated Enrollment. Only exiting Access Groups can be updated.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

Parameters:

  • id: Autogenerated Access Group ID.

func (*Client) UpdateEnrollmentAccessManagementV4 

func (c *Client) UpdateEnrollmentAccessManagementV4(ctx context.Context, request *AccessManagementSetting) (*AccessManagementSetting, error)

UpdateEnrollmentAccessManagementV4 configure Access Management settings.

Required privileges: access-management:update. Legacy Jamf Pro privilege name(s): Access Management Setting Update.

func (*Client) UpdateEnrollmentCustomizationLdapPanelV1 

func (c *Client) UpdateEnrollmentCustomizationLdapPanelV1(ctx context.Context, id string, panelID string, request *EnrollmentCustomizationPanelLdapAuth) (*GetEnrollmentCustomizationPanelLdapAuth, error)

UpdateEnrollmentCustomizationLdapPanelV1 update a single LDAP Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) UpdateEnrollmentCustomizationSsoPanelV1 

func (c *Client) UpdateEnrollmentCustomizationSsoPanelV1(ctx context.Context, id string, panelID string, request *EnrollmentCustomizationPanelSsoAuth) (*GetEnrollmentCustomizationPanelSsoAuth, error)

UpdateEnrollmentCustomizationSsoPanelV1 update a single SSO Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) UpdateEnrollmentCustomizationTextPanelV1 

func (c *Client) UpdateEnrollmentCustomizationTextPanelV1(ctx context.Context, id string, panelID string, request *EnrollmentCustomizationPanelText) (*GetEnrollmentCustomizationPanelText, error)

UpdateEnrollmentCustomizationTextPanelV1 update a single Text Panel for a single Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.
  • panelID: Panel object identifier.

func (*Client) UpdateEnrollmentCustomizationV2 

func (c *Client) UpdateEnrollmentCustomizationV2(ctx context.Context, id string, request *EnrollmentCustomizationV2) (*EnrollmentCustomizationV2, error)

UpdateEnrollmentCustomizationV2 update an Enrollment Customization.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

Parameters:

  • id: Enrollment Customization identifier.

func (*Client) UpdateEnrollmentLanguageV3 

func (c *Client) UpdateEnrollmentLanguageV3(ctx context.Context, languageID string, request *EnrollmentProcessTextObject) (*EnrollmentProcessTextObject, error)

UpdateEnrollmentLanguageV3 edit Enrollment messaging for a language.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

Parameters:

  • languageID: Two letter ISO 639-1 Language Code.

func (*Client) UpdateEnrollmentSettingsV4 

func (c *Client) UpdateEnrollmentSettingsV4(ctx context.Context, request *EnrollmentSettingsV4) (*EnrollmentSettingsV4, error)

UpdateEnrollmentSettingsV4 update Enrollment object.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

func (*Client) UpdateGSXConnectionV1 

func (c *Client) UpdateGSXConnectionV1(ctx context.Context, request *GsxConnection) (*GsxConnection, error)

UpdateGSXConnectionV1 updates Jamf Pro GSX Connection information.

Required privileges: gsx-connection:update, push-certificates:update. Legacy Jamf Pro privilege name(s): Update GSX Connection, Update Push Certificates. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) UpdateIOSBrandingConfigurationV1 

func (c *Client) UpdateIOSBrandingConfigurationV1(ctx context.Context, id string, request *IosBrandingConfiguration) (*IosBrandingConfiguration, error)

UpdateIOSBrandingConfigurationV1 update a Self Service iOS branding configuration with the supplied details.

Required privileges: self-service:update. Legacy Jamf Pro privilege name(s): Update Self Service Branding Configuration.

Parameters:

  • id: id of iOS branding configuration.

func (*Client) UpdateImpactAlertNotificationSettingsV1 

func (c *Client) UpdateImpactAlertNotificationSettingsV1(ctx context.Context, request *ImpactAlertNotificationSettingsV1) error

UpdateImpactAlertNotificationSettingsV1 update Impact Alert Notification Settings.

Required privileges: impact-alert-notification-settings:update. Legacy Jamf Pro privilege name(s): Update Impact Alert Notification Settings.

func (*Client) UpdateInventoryPreloadRecordV2 

func (c *Client) UpdateInventoryPreloadRecordV2(ctx context.Context, id string, request *InventoryPreloadRecordV2) (*InventoryPreloadRecordV2, error)

UpdateInventoryPreloadRecordV2 update an Inventory Preload record.

Required privileges: inventory-preload-records:update. Legacy Jamf Pro privilege name(s): Update Inventory Preload Records.

Parameters:

  • id: Inventory Preload identifier.

func (*Client) UpdateJamfConnectConfigProfileV1 

func (c *Client) UpdateJamfConnectConfigProfileV1(ctx context.Context, id string, request *LinkedConnectProfile) (*LinkedConnectProfile, error)

UpdateJamfConnectConfigProfileV1 update the way the Jamf Connect app gets updated on computers within scope of the associated configuration profile.

Required privileges: jamf-connect-deployments:update. Legacy Jamf Pro privilege name(s): Update Jamf Connect Deployments.

Parameters:

  • id: the UUID of the profile to update.

func (*Client) UpdateJamfProServerURLV1 

func (c *Client) UpdateJamfProServerURLV1(ctx context.Context, request *JamfProServerURL) (*JamfProServerURL, error)

UpdateJamfProServerURLV1 update Jamf Pro Server URL settings.

Required privileges: jss-url:update. Legacy Jamf Pro privilege name(s): Update JSS URL.

func (*Client) UpdateJamfProtectSettingsV1 

func (c *Client) UpdateJamfProtectSettingsV1(ctx context.Context, request *ProtectUpdatableSettingsRequest) (*ProtectSettingsResponse, error)

UpdateJamfProtectSettingsV1 jamf Protect integration settings.

Required privileges: jamf-protect-deployments:update. Legacy Jamf Pro privilege name(s): Update Jamf Protect Settings.

func (*Client) UpdateLocalAdminPasswordSettingsV2 

func (c *Client) UpdateLocalAdminPasswordSettingsV2(ctx context.Context, request *LapsSettingsRequestV2) (*LapsSettingsResponseV2, error)

UpdateLocalAdminPasswordSettingsV2 update settings for LAPS.

Required privileges: local-admin-passwords:update. Legacy Jamf Pro privilege name(s): Update Local Admin Password Settings.

func (*Client) UpdateLoginCustomizationV1 

func (c *Client) UpdateLoginCustomizationV1(ctx context.Context, request *LoginContentPut) (*LoginContentPut, error)

UpdateLoginCustomizationV1 update current login disclaimer settings.

Required privileges: login-disclaimer:update. Legacy Jamf Pro privilege name(s): Update Login Disclaimer.

func (*Client) UpdateMacOSBrandingConfigurationV1 

func (c *Client) UpdateMacOSBrandingConfigurationV1(ctx context.Context, id string, request *MacOsBrandingConfiguration) (*MacOsBrandingConfiguration, error)

UpdateMacOSBrandingConfigurationV1 update a Self Service macOS branding configuration with the supplied details.

Required privileges: self-service:update. Legacy Jamf Pro privilege name(s): Update Self Service Branding Configuration.

Parameters:

  • id: id of macOS branding configuration.

func (*Client) UpdateManagedSoftwareUpdateFeatureToggleV1 

func (c *Client) UpdateManagedSoftwareUpdateFeatureToggleV1(ctx context.Context, request *ManagedSoftwareUpdatePlanToggle) (*ManagedSoftwareUpdatePlanToggle, error)

UpdateManagedSoftwareUpdateFeatureToggleV1 updates Feature Toggle Value.

Required privileges: managed-software-updates:create, managed-software-updates:read, managed-software-updates:update. Legacy Jamf Pro privilege name(s): Read Managed Software Updates, Create Managed Software Updates, Update Managed Software Updates. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) UpdateMdmRenewalDeviceCommonDetailsV1 

func (c *Client) UpdateMdmRenewalDeviceCommonDetailsV1(ctx context.Context, request *DeviceCommonDetailsRequest) error

UpdateMdmRenewalDeviceCommonDetailsV1 update device common details (partial update).

Required privileges: device-actions:execute. Legacy Jamf Pro privilege name(s): Send Command to Renew MDM Profile.

func (*Client) UpdateMobileDeviceExtensionAttributeV1 

func (c *Client) UpdateMobileDeviceExtensionAttributeV1(ctx context.Context, id string, request *MobileDeviceExtensionAttributes) (*MobileDeviceExtensionAttributes, error)

UpdateMobileDeviceExtensionAttributeV1 update specified Mobile Device Extension Attribute object.

Required privileges: extension-attributes:update. Legacy Jamf Pro privilege name(s): Update Mobile Device Extension Attributes.

Parameters:

  • id: Unique ID of Mobile Device Extension Attribute.

func (*Client) UpdateMobileDevicePrestageV3 

func (c *Client) UpdateMobileDevicePrestageV3(ctx context.Context, id string, request *PutMobileDevicePrestageV3) (*GetMobileDevicePrestageV3, error)

UpdateMobileDevicePrestageV3 update a Mobile Device Prestage.

This endpoint requires an optimistic-lock precondition in its request body, sourced from a prior GET. The transport does NOT auto-retry a 5xx here — unlike other PUT/DELETE/GET/HEAD calls — because a blind retry would replay the now-stale precondition and could turn a successful-but-500ing write into a masked conflict on the retried attempt. See client.DoWithContentTypeNoRetry.

Required privileges: prestage-enrollments:update. Legacy Jamf Pro privilege name(s): Update Mobile Device PreStage Enrollments.

Parameters:

  • id: Mobile Device Prestage identifier.

func (*Client) UpdateOnboardingV1 

func (c *Client) UpdateOnboardingV1(ctx context.Context, request *OnboardingConfiguration) (*OnboardingConfiguration, error)

UpdateOnboardingV1 update the onboarding configuration.

Required privileges: onboarding:update. Legacy Jamf Pro privilege name(s): Update Onboarding Configuration.

func (*Client) UpdatePackageV1 

func (c *Client) UpdatePackageV1(ctx context.Context, id string, request *Package) (*Package, error)

UpdatePackageV1 update specified package object.

Required privileges: packages:update. Legacy Jamf Pro privilege name(s): Update Packages.

Parameters:

  • id: Instance ID of package.

func (*Client) UpdateParentAppSettingsV1 

func (c *Client) UpdateParentAppSettingsV1(ctx context.Context, request *ParentApp) (*ParentApp, error)

UpdateParentAppSettingsV1 update Jamf Parent app settings.

Required privileges: parent-app:update. Legacy Jamf Pro privilege name(s): Update Parent App Settings.

func (*Client) UpdatePatchSoftwareTitleConfigurationV3 

func (c *Client) UpdatePatchSoftwareTitleConfigurationV3(ctx context.Context, id string, request *PatchSoftwareTitleConfigurationPatch) (*PatchSoftwareTitleConfiguration, error)

UpdatePatchSoftwareTitleConfigurationV3 update Patch Software Title Configurations.

Required privileges: patch-management-software-titles:update. Legacy Jamf Pro privilege name(s): Update Patch Management Software Titles.

Parameters:

  • id: Patch Software Title Configurations identifier.

func (*Client) UpdatePolicyPropertiesV1 

func (c *Client) UpdatePolicyPropertiesV1(ctx context.Context, request *PolicyPropertiesV1) (*PolicyPropertiesV1, error)

UpdatePolicyPropertiesV1 update Policy Properties object.

Required privileges: policies:update. Legacy Jamf Pro privilege name(s): Update Policies.

func (*Client) UpdateReenrollmentSettingsV1 

func (c *Client) UpdateReenrollmentSettingsV1(ctx context.Context, request *Reenrollment) (*Reenrollment, error)

UpdateReenrollmentSettingsV1 update the Re-enrollment object.

Required privileges: re-enrollment:update. Legacy Jamf Pro privilege name(s): Update Re-enrollment.

func (*Client) UpdateReturnToServiceConfigurationV1 

func (c *Client) UpdateReturnToServiceConfigurationV1(ctx context.Context, id string, request *ReturnToServiceConfigurationRequest) (*ReturnToServiceConfiguration, error)

UpdateReturnToServiceConfigurationV1 update a Return to Service Configuration.

Required privileges: return-to-service:update. Legacy Jamf Pro privilege name(s): Edit Return To Service Configurations.

Parameters:

  • id: Return to Service Configuration identifier.

func (*Client) UpdateScriptV1 

func (c *Client) UpdateScriptV1(ctx context.Context, id string, request *Script) (*Script, error)

UpdateScriptV1 replace the script at the id with the supplied information.

Required privileges: scripts:update. Legacy Jamf Pro privilege name(s): Update Scripts.

Parameters:

  • id: Script object identifier.

func (*Client) UpdateSelfServicePlusSettingsV1 

func (c *Client) UpdateSelfServicePlusSettingsV1(ctx context.Context, request *SelfServicePlusSettings) error

UpdateSelfServicePlusSettingsV1 save Self Service Plus settings.

Required privileges: self-service:update. Legacy Jamf Pro privilege name(s): Update Self Service.

func (*Client) UpdateSelfServiceSettingsV1 

func (c *Client) UpdateSelfServiceSettingsV1(ctx context.Context, request *SelfServiceSettings) (*SelfServiceSettings, error)

UpdateSelfServiceSettingsV1 put an object representation of Self Service settings.

Required privileges: self-service:update. Legacy Jamf Pro privilege name(s): Update Self Service.

func (*Client) UpdateServiceDiscoveryEnrollmentWellKnownSettingsV1 

func (c *Client) UpdateServiceDiscoveryEnrollmentWellKnownSettingsV1(ctx context.Context, request *WellKnownSettingsRequest) error

UpdateServiceDiscoveryEnrollmentWellKnownSettingsV1 update service discovery well-known settings.

Required privileges: user-initiated-enrollment:update. Legacy Jamf Pro privilege name(s): Update User-Initiated Enrollment.

func (*Client) UpdateSmartComputerGroupV3 

func (c *Client) UpdateSmartComputerGroupV3(ctx context.Context, id string, request *SmartComputerGroupV3) (*SmartComputerGroupV3, error)

UpdateSmartComputerGroupV3 update a Smart Computer Group.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Smart Computer Groups.

Parameters:

  • id: id of target Smart Computer Group.

func (*Client) UpdateSmartMobileDeviceGroupV2 

func (c *Client) UpdateSmartMobileDeviceGroupV2(ctx context.Context, id string, request *SmartGroupAssignmentV2) (*SmartGroupAssignmentV2, error)

UpdateSmartMobileDeviceGroupV2 update a smart group.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Smart Mobile Device Groups.

Parameters:

  • id: instance id of a smart group.

func (*Client) UpdateSmtpServerV2 

func (c *Client) UpdateSmtpServerV2(ctx context.Context, request *SmtpServerV2) (*SmtpServerV2, error)

UpdateSmtpServerV2 updates Jamf Pro SMTP Server information.

Required privileges: smtp-server:update. Legacy Jamf Pro privilege name(s): Update SMTP Server.

func (*Client) UpdateSsoCertificateV2 

func (c *Client) UpdateSsoCertificateV2(ctx context.Context, request *SsoKeystore) (*SsoKeystoreResponseWithDetails, error)

UpdateSsoCertificateV2 update the certificate used by Jamf Pro to sign SSO requests to the identify provider.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) UpdateSsoOidcBrokerConfigV3 

func (c *Client) UpdateSsoOidcBrokerConfigV3(ctx context.Context, request *OidcBrokerConfigUpdate) error

UpdateSsoOidcBrokerConfigV3 update the OIDC broker configuration.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

Published but not routed at the gateway: every call answers `403 BAD_PERMISSIONS`, whatever privileges the credential holds, and no write reaches the server. `GET /v3/sso/dependencies` requires the sibling `sso-settings:read` and answers 200, so the gap is the route and not the grant. `TestAcceptance_Pro_SsoOidcBrokerConfigUpdateUnroutedAtGateway` fails the day the route appears, which is the notification to delete this note.

func (*Client) UpdateSsoSettingsV3 

func (c *Client) UpdateSsoSettingsV3(ctx context.Context, request *SsoSettingsV3) (*SsoSettingsV3, error)

UpdateSsoSettingsV3 updates the current Single Sign On configuration settings.

Required privileges: sso-settings:update. Legacy Jamf Pro privilege name(s): Update SSO Settings.

func (*Client) UpdateStaticComputerGroupV3 

func (c *Client) UpdateStaticComputerGroupV3(ctx context.Context, id string, request *StaticComputerGroupAssignment) (*StaticComputerGroupAssignment, error)

UpdateStaticComputerGroupV3 update membership of a static computer group.

Required privileges: device-groups:update. Legacy Jamf Pro privilege name(s): Update Static Computer Groups.

Parameters:

  • id: instance id of a static computer group.

func (*Client) UpdateSupervisionIdentityV1 

func (c *Client) UpdateSupervisionIdentityV1(ctx context.Context, id string, request *SupervisionIdentityUpdate) (*SupervisionIdentity, error)

UpdateSupervisionIdentityV1 update a Supervision Identity with the supplied information.

Required privileges: apple-configurator-enrollment:update. Legacy Jamf Pro privilege name(s): Update Apple Configurator Enrollment.

Parameters:

  • id: Supervision Identity identifier.

func (*Client) UpdateTeacherAppSettingsV1 

func (c *Client) UpdateTeacherAppSettingsV1(ctx context.Context, request *TeacherSettingsRequest) (*TeacherSettingsResponse, error)

UpdateTeacherAppSettingsV1 update a Jamf Teacher settings object.

Required privileges: teacher-app:update. Legacy Jamf Pro privilege name(s): Update Teacher App Settings.

func (*Client) UpdateTeamViewerConfigurationPreview 

func (c *Client) UpdateTeamViewerConfigurationPreview(ctx context.Context, id string, request *ConnectionConfigurationUpdateRequest) (*ConnectionConfigurationResponse, error)

UpdateTeamViewerConfigurationPreview update Team Viewer Remote Administration connection configuration.

Required privileges: remote-administration:update. Legacy Jamf Pro privilege name(s): Update Remote Administration.

Parameters:

  • id: ID of the Team Viewer connection configuration.

func (*Client) UpdateUserPreferenceV1 

func (c *Client) UpdateUserPreferenceV1(ctx context.Context, keyID string, request *map[string]any) (*UserPreferencesJson, error)

UpdateUserPreferenceV1 persist the user setting.

Required privileges: the spec declares none.

Parameters:

  • keyID: unique key of user setting to be persisted.

func (*Client) UpdateUserSessionV1 

func (c *Client) UpdateUserSessionV1(ctx context.Context, request *Session) (*Session, error)

UpdateUserSessionV1 update values in the User's current session.

Required privileges: the spec declares none.

func (*Client) UpdateUserV1 

func (c *Client) UpdateUserV1(ctx context.Context, id string, request *UserInventory) error

UpdateUserV1 update a user in inventory.

Required privileges: users:update. Legacy Jamf Pro privilege name(s): Update User.

Parameters:

  • id: ID of the user to update.

func (*Client) UpdateVenafiV1 

func (c *Client) UpdateVenafiV1(ctx context.Context, id string, request *VenafiCaRecord) (*VenafiCaRecord, error)

UpdateVenafiV1 update a Venafi PKI configuration in Jamf Pro.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) UpdateVolumePurchasingLocationV1 

func (c *Client) UpdateVolumePurchasingLocationV1(ctx context.Context, id string, request *VolumePurchasingLocationPatch) (*VolumePurchasingLocation, error)

UpdateVolumePurchasingLocationV1 update a Volume Purchasing Location.

Required privileges: volume-purchasing-locations:update. Legacy Jamf Pro privilege name(s): Update Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Location identifier.

func (*Client) UpdateVolumePurchasingSubscriptionV1 

func (c *Client) UpdateVolumePurchasingSubscriptionV1(ctx context.Context, id string, request *VolumePurchasingSubscriptionBase) (*VolumePurchasingSubscription, error)

UpdateVolumePurchasingSubscriptionV1 update a Volume Purchasing Subscription.

Required privileges: volume-purchasing-locations:update. Legacy Jamf Pro privilege name(s): Update Volume Purchasing Locations.

Parameters:

  • id: Volume Purchasing Subscription identifier.

func (*Client) UploadBrandingImageV1 

func (c *Client) UploadBrandingImageV1(ctx context.Context, fileFilename string, file io.Reader) (*BrandingImageURL, error)

UploadBrandingImageV1 upload an image.

Required privileges: self-service:update. Legacy Jamf Pro privilege name(s): Update Self Service Branding Configuration.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadComputerExtensionAttributeV1 

func (c *Client) UploadComputerExtensionAttributeV1(ctx context.Context, fileFilename string, file io.Reader) (*ComputerExtensionAttributes, error)

UploadComputerExtensionAttributeV1 upload Computer Extension Attribute.

Required privileges: extension-attributes:create, extension-attributes:read. Legacy Jamf Pro privilege name(s): Create Computer Extension Attributes, Read Computer Extension Attributes. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadComputerInventoryAttachmentV3 deprecated 

func (c *Client) UploadComputerInventoryAttachmentV3(ctx context.Context, id string, fileFilename string, file io.Reader) (*HrefResponse, error)

UploadComputerInventoryAttachmentV3 upload attachment and assign to computer.

Deprecated: this endpoint is marked deprecated in the Jamf API spec (deprecation-date: 2026-07-14) and may be removed in a future release.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Computers.

Parameters:

  • id: instance id of computer record.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadComputerInventoryAttachmentV4 

func (c *Client) UploadComputerInventoryAttachmentV4(ctx context.Context, id string, fileFilename string, file io.Reader) (*HrefResponse, error)

UploadComputerInventoryAttachmentV4 upload attachment and assign to computer.

Required privileges: devices:update. Legacy Jamf Pro privilege name(s): Update Computers.

Parameters:

  • id: instance id of computer record.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadDeviceEnrollmentTokenV1 

func (c *Client) UploadDeviceEnrollmentTokenV1(ctx context.Context, request *DeviceEnrollmentToken) (*HrefResponse, error)

UploadDeviceEnrollmentTokenV1 create a Device Enrollment Instance with the supplied Token.

Required privileges: device-enrollment-program-instances:create. Legacy Jamf Pro privilege name(s): Create Device Enrollment Program Instances.

func (*Client) UploadEnrollmentCustomizationImageV2 

func (c *Client) UploadEnrollmentCustomizationImageV2(ctx context.Context, fileFilename string, file io.Reader) (*BrandingImageURL, error)

UploadEnrollmentCustomizationImageV2 upload an image.

Required privileges: enrollment-customization:update. Legacy Jamf Pro privilege name(s): Update Enrollment Customizations.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadIconV1 

func (c *Client) UploadIconV1(ctx context.Context, fileFilename string, file io.Reader) (*IconResponse, error)

UploadIconV1 upload an icon.

Required privileges: the spec declares none.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadInventoryPreloadCsvV2 

func (c *Client) UploadInventoryPreloadCsvV2(ctx context.Context, fileFilename string, file io.Reader) (*[]HrefResponse, error)

UploadInventoryPreloadCsvV2 create one or more new Inventory Preload records using CSV.

Required privileges: inventory-preload-records:create, inventory-preload-records:update, users:create, users:update. Legacy Jamf Pro privilege name(s): Create Inventory Preload Records, Update Inventory Preload Records, Create User, Update User. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadMobileDevicePrestageAttachmentV3 

func (c *Client) UploadMobileDevicePrestageAttachmentV3(ctx context.Context, id string, fileFilename string, file io.Reader) (*PrestageFileAttachmentV3, error)

UploadMobileDevicePrestageAttachmentV3 add an attachment to a Mobile Device Prestage.

Required privileges: prestage-enrollments:create. Legacy Jamf Pro privilege name(s): Create Mobile Device PreStage Enrollments.

Parameters:

  • id: Identifier of the Mobile Device Prestage the attachment should be assigned to.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadPackageManifestV1 

func (c *Client) UploadPackageManifestV1(ctx context.Context, id string, fileFilename string, file io.Reader) (*Package, error)

UploadPackageManifestV1 add a manifest to a package.

Required privileges: packages:read, packages:update. Legacy Jamf Pro privilege name(s): Update Packages, Read Packages. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: Id of the package the manifest should be assigned to.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadPackageV1 

func (c *Client) UploadPackageV1(ctx context.Context, id string, fileFilename string, file io.Reader) (*HrefResponse, error)

UploadPackageV1 upload package.

Required privileges: packages:read, packages:update. Legacy Jamf Pro privilege name(s): Update Packages, Read Packages. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

Parameters:

  • id: instance id of package.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) UploadSupervisionIdentityV1 

func (c *Client) UploadSupervisionIdentityV1(ctx context.Context, request *SupervisionIdentityCertificateUpload) (*SupervisionIdentity, error)

UploadSupervisionIdentityV1 upload the Supervision Identity .p12 file.

Required privileges: apple-configurator-enrollment:update. Legacy Jamf Pro privilege name(s): Update Apple Configurator Enrollment.

func (*Client) UploadVenafiProxyTrustStoreV1 

func (c *Client) UploadVenafiProxyTrustStoreV1(ctx context.Context, id string, body []byte) error

UploadVenafiProxyTrustStoreV1 uploads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server.

Required privileges: pki:update. Legacy Jamf Pro privilege name(s): Update PKI.

Parameters:

  • id: ID of the Venafi configuration.

func (*Client) ValidateAdcsCertificateV1 

func (c *Client) ValidateAdcsCertificateV1(ctx context.Context, request *AdcsCertificate) error

ValidateAdcsCertificateV1 validate AD CS Settings server certificate.

Required privileges: ad-cs-settings:create, ad-cs-settings:update. Legacy Jamf Pro privilege name(s): Update AD CS Settings, Create AD CS Settings. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) ValidateAdcsClientCertificateV1 

func (c *Client) ValidateAdcsClientCertificateV1(ctx context.Context, request *AdcsCertificate) error

ValidateAdcsClientCertificateV1 validate AD CS Settings client certificate.

Required privileges: ad-cs-settings:create, ad-cs-settings:update. Legacy Jamf Pro privilege name(s): Update AD CS Settings, Create AD CS Settings. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) ValidateDigicertClientCertificateV1 

func (c *Client) ValidateDigicertClientCertificateV1(ctx context.Context, request *Certificate) error

ValidateDigicertClientCertificateV1 validate DigiCert Trust Lifecycle Manager client certificate.

Required privileges: digicert-settings:create, digicert-settings:update. Legacy Jamf Pro privilege name(s): Create DigiCert Settings, Update DigiCert Settings. All of them are required, not alternatives. The scoped and legacy lists are independent sets, not pairs: do not match them by position.

func (*Client) ValidateInventoryPreloadCsvV2 

func (c *Client) ValidateInventoryPreloadCsvV2(ctx context.Context, fileFilename string, file io.Reader) (*InventoryPreloadCsvValidationSuccess, error)

ValidateInventoryPreloadCsvV2 validate a given CSV file.

Required privileges: inventory-preload-records:create. Legacy Jamf Pro privilege name(s): Create Inventory Preload Records.

For file parts, pass an *os.File or *bytes.Reader (anything that implements io.Seeker) so the SDK can precompute an exact Content-Length and retry once on a 429/Retry-After. A plain io.Reader is accepted too but the upload falls back to chunked transfer encoding and is not retried on 429.

func (*Client) VerifyLdapKeystoreV1 

func (c *Client) VerifyLdapKeystoreV1(ctx context.Context, request *CloudLdapKeystoreFile) (*CloudLdapKeystore, error)

VerifyLdapKeystoreV1 validate keystore for Cloud Identity Provider secure connection.

Required privileges: ldap-servers:create. Legacy Jamf Pro privilege name(s): Create LDAP Servers.

type ClientCheckInV3 

type ClientCheckInV3 struct {
	// Suggested values are 5, 15, 30, or 60. Web interface will not display correctly if not one of those.
	// Minimum is 5, maximum is 60.
	CheckInFrequency                 *int  `json:"checkInFrequency,omitempty"`
	CreateHooks                      *bool `json:"createHooks,omitempty"`
	CreateStartupScript              *bool `json:"createStartupScript,omitempty"`
	EnableLocalConfigurationProfiles *bool `json:"enableLocalConfigurationProfiles,omitempty"`
	HookLog                          *bool `json:"hookLog,omitempty"`
	HookPolicies                     *bool `json:"hookPolicies,omitempty"`
	StartupLog                       *bool `json:"startupLog,omitempty"`
	StartupPolicies                  *bool `json:"startupPolicies,omitempty"`
	StartupSsh                       *bool `json:"startupSsh,omitempty"`
}

ClientCheckInV3 represents a client check in v3.

type CloudDistributionPoint 

type CloudDistributionPoint struct {
	// Specifies the content delivery network (CDN) used to distribute content for the cloud distribution
	// point.
	// Allowed values: see the CloudDistributionPointCdnType constants.
	CdnType string `json:"cdnType"`
	// The CDN URL for the cloud distribution point. The URL format varies depending on the selected CDN
	// provider: - **Rackspace Cloud Files(RACKSPACE_CLOUD_FILES)** - **Amazon Web Services(AMAZON_S3)** -
	// **Akamai(AKAMAI)**.
	// The **cdnUrl** should point to the content distribution location where software or other content is
	// stored and made available for distribution.
	CdnURL *string `json:"cdnUrl,omitempty"`
	// The directory or path for content delivery in Akamai. This field is required when the **cdnType** is
	// set to **Akamai(AKAMAI)** and specifies where content is stored within Akamai's system.
	Directory *string `json:"directory,omitempty"`
	// The URL used to access and download content from Akamai's EdgeSuite. This field is required when the
	// **cdnType** is set to **Akamai(AKAMAI)**. It specifies the endpoint from which files are retrieved
	// by devices or users.
	DownloadURL *string `json:"downloadUrl,omitempty"`
	// Signed URL Expiration. Number of seconds before the signed URL expires, This field is required when
	// the **cdnType** is set to **Amazon Web Services(AMAZON_S3)** and **requireSignedUrls** is true.
	ExpirationSeconds *int `json:"expirationSeconds,omitempty"`
	// Indicates whether the connection to the cloud distribution point was successful. If `true`, the
	// connection was successful. If `false`, the connection failed. Possible values are: false true.
	HasConnectionSucceeded bool `json:"hasConnectionSucceeded"`
	// The unique identifier (inventoryId) that links the cloud distribution point to its inventory data.
	// By default, its value is 0, and it increments by +1 based on the existing inventory ID present in
	// the table for each new cloud distribution point configuration. If the cdnType is set to NONE in the
	// next configuration, the ID resets and starts from 1.
	InventoryID *string `json:"inventoryId,omitempty"`
	// The CloudFront Access Key ID (keyPairId) is part of the credentials used to generate signed URLs for
	// secure access to content in a CloudFront distribution. When using AWS, this key is paired with the
	// CloudFront Secret Access Key to create the signed URL, ensuring that only authorized users can
	// access specific content within a specified timeframe. This field is required when the **cdnType** is
	// set to **Amazon Web Services(AMAZON_S3)** and **requireSignedUrls** is true.
	KeyPairID *string `json:"keyPairId,omitempty"`
	// Use as principal distribution point. Use as the authoritative source for all files. Possible values
	// are: false true.
	Master *bool `json:"master,omitempty"`
	// A message detailing the result of the connection test. This could be a success message or an error
	// message if the connection failed.
	Message string `json:"message"`
	// The password or authentication key used for connecting to the selected content delivery network
	// (CDN). This field is required when the **cdnType** is set to **Rackspace Cloud
	// Files(RACKSPACE_CLOUD_FILES)**, **Amazon Web Services(AMAZON_S3)**, or **Akamai(AKAMAI)**, and is
	// used to authenticate and authorize access to the respective cloud services. - For **Rackspace Cloud
	// Files(RACKSPACE_CLOUD_FILES)**, this refers to the **API Key** that is used in conjunction with the
	// username for authenticating API requests. - For **Amazon Web Services(AMAZON_S3)**, this corresponds
	// to the **Secret Access Key** associated with your AWS account, used to securely sign requests to AWS
	// services. - For **Akamai(AKAMAI)**, this is the **password** used for API authentication to access
	// Akamai's content delivery services. If the **cdnType** is **None**, this field is not applicable.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
	// The CloudFront Private Key file is required when the **cdnType** is set to **Amazon Web
	// Services(AMAZON_S3)** and **requireSignedUrls** parameter is enabled. This private key is used for
	// signing URLs for restricted access to CloudFront-distributed content. The private key allows secure
	// URL generation for signed URLs, ensuring that only authorized users can access certain content. The
	// key must be uploaded in one of the following formats: - **.pem**: A Privacy-Enhanced Mail (PEM) file
	// containing the private key in base64 encoded format. - **.der**: A Distinguished Encoding Rules
	// (DER) encoded file, which is a binary format for the private key. The uploaded file should be kept
	// secure, as it provides the ability to generate signed URLs with access to protected content.
	PrivateKey *[]byte `json:"privateKey,omitempty"`
	// Amazon Sign Url. It restrict access to requests that use a signed URL. This field is required when
	// the **cdnType** is set to **Amazon Web Services(AMAZON_S3)**. Possible values are: false true.
	RequireSignedUrls *bool `json:"requireSignedUrls,omitempty"`
	// Enable Remote Authentication.Authorize requests for files stored on the distribution point. This
	// field is required when the **cdnType** is set to **Akamai(AKAMAI)**. Possible values are: false
	// true.
	SecondaryAuthRequired *bool `json:"secondaryAuthRequired,omitempty"`
	// Secondary Auth Status Code. Configure the HTTP response code that will be returned by Jamf Pro
	// during remote authentication. This field is required when the **cdnType** is set to
	// **Akamai(AKAMAI)** and **secondaryAuthRequired** is true.
	SecondaryAuthStatusCode *int `json:"secondaryAuthStatusCode,omitempty"`
	// Secondary Auth Time To Live. Number of seconds before the authorization token expires. This field is
	// required when the **cdnType** is set to **Akamai(AKAMAI)** and **secondaryAuthRequired** is true.
	SecondaryAuthTimeToLive *int `json:"secondaryAuthTimeToLive,omitempty"`
	// The URL used to upload files to Akamai's NetStorage. This field is required when the **cdnType** is
	// set to **Akamai(AKAMAI)**. It specifies where content should be uploaded to Akamai’s cloud storage
	// before being distributed via their CDN. The upload typically uses FTP or SFTP.
	UploadURL *string `json:"uploadUrl,omitempty"`
	// The username or access key used for authenticating with the selected content delivery network (CDN).
	// This field is required when the **cdnType** is set to **Rackspace Cloud
	// Files(RACKSPACE_CLOUD_FILES)**, **Amazon Web Services(AMAZON_S3)**, or **Akamai(AKAMAI)**, as it is
	// used to authenticate and authorize access to the respective cloud services. - For **Rackspace Cloud
	// Files(RACKSPACE_CLOUD_FILES)**, this is typically the username associated with your Rackspace cloud
	// account. - For **Amazon Web Services(AMAZON_S3)**, this corresponds to the **Access Key ID** used to
	// interact with Amazon Web Services(AMAZON_S3) resources. - For **Akamai(AKAMAI)**, this is the
	// username used for API authentication to access Akamai's content delivery services. If the
	// **cdnType** is **None**, this field is not applicable.
	Username string `json:"username"`
}

CloudDistributionPoint represents a cloud distribution point.

type CloudDistributionPointCdnType 

type CloudDistributionPointCdnType = string

CloudDistributionPointCdnType is the set of values accepted by CloudDistributionPoint.CdnType. 

const (
	CloudDistributionPointCdnTypeNone                CloudDistributionPointCdnType = "NONE"
	CloudDistributionPointCdnTypeJamfCloud           CloudDistributionPointCdnType = "JAMF_CLOUD"
	CloudDistributionPointCdnTypeRackspaceCloudFiles CloudDistributionPointCdnType = "RACKSPACE_CLOUD_FILES"
	CloudDistributionPointCdnTypeAmazonS3            CloudDistributionPointCdnType = "AMAZON_S3"
	CloudDistributionPointCdnTypeAkamai              CloudDistributionPointCdnType = "AKAMAI"
)

CloudDistributionPointCdnType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudDistributionPointCdnTypeValues 

func CloudDistributionPointCdnTypeValues() []CloudDistributionPointCdnType

CloudDistributionPointCdnTypeValues returns every value the Jamf API accepts for CloudDistributionPointCdnType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudDistributionPointInventoryFileInfo 

type CloudDistributionPointInventoryFileInfo struct {
	// The category assigned to the inventory file (package, ebook, or mobile device app) during creation.
	// This helps group and organize files based on their type or purpose, such as security software or
	// productivity tools.
	Category string `json:"category"`
	// The name of the inventory file. This could be the name of a package, a mobile device app, or an
	// ebook file, depending on the file type. The name should match the actual file or package name as
	// stored in the cloud distribution system.
	FileName string `json:"fileName"`
	// A unique identifier for each file type (package, ebook, or mobile device app). This ID is used to
	// construct the URL for accessing or navigating to the specific resource related to the file type.
	FileObjectID string `json:"fileObjectId"`
	// A unique identifier for the cloud distribution point inventory file table.
	ID string `json:"id"`
	// A unique identifier for the cloud distribution point inventory file and cloud distribution point
	// tables.This ID is used to reference a specific inventory resource within the system.
	InventoryID string `json:"inventoryId"`
	// The current status of the inventory file, indicating the progress or outcome of the file's upload
	// process.It reflects whether the file is ready for use, still being processed, or has encountered an
	// error.
	// Allowed values: see the CloudDistributionPointInventoryFileInfoStatus constants.
	Status string `json:"status"`
	// The type of the inventory file. This field indicates whether the file is related to a package,
	// mobile device app, or an ebook.
	// Allowed values: see the CloudDistributionPointInventoryFileInfoType constants.
	Type string `json:"type"`
}

CloudDistributionPointInventoryFileInfo represents a cloud distribution point inventory file info.

type CloudDistributionPointInventoryFileInfoStatus 

type CloudDistributionPointInventoryFileInfoStatus = string

CloudDistributionPointInventoryFileInfoStatus is the set of values accepted by CloudDistributionPointInventoryFileInfo.Status. 

const (
	CloudDistributionPointInventoryFileInfoStatusReady   CloudDistributionPointInventoryFileInfoStatus = "READY"
	CloudDistributionPointInventoryFileInfoStatusPending CloudDistributionPointInventoryFileInfoStatus = "PENDING"
	CloudDistributionPointInventoryFileInfoStatusError   CloudDistributionPointInventoryFileInfoStatus = "ERROR"
)

CloudDistributionPointInventoryFileInfoStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudDistributionPointInventoryFileInfoStatusValues 

func CloudDistributionPointInventoryFileInfoStatusValues() []CloudDistributionPointInventoryFileInfoStatus

CloudDistributionPointInventoryFileInfoStatusValues returns every value the Jamf API accepts for CloudDistributionPointInventoryFileInfoStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudDistributionPointInventoryFileInfoType 

type CloudDistributionPointInventoryFileInfoType = string

CloudDistributionPointInventoryFileInfoType is the set of values accepted by CloudDistributionPointInventoryFileInfo.Type. 

const (
	CloudDistributionPointInventoryFileInfoTypeNone            CloudDistributionPointInventoryFileInfoType = "NONE"
	CloudDistributionPointInventoryFileInfoTypePackage         CloudDistributionPointInventoryFileInfoType = "PACKAGE"
	CloudDistributionPointInventoryFileInfoTypeEbook           CloudDistributionPointInventoryFileInfoType = "EBOOK"
	CloudDistributionPointInventoryFileInfoTypeMobileDeviceApp CloudDistributionPointInventoryFileInfoType = "MOBILE_DEVICE_APP"
	CloudDistributionPointInventoryFileInfoTypeScript          CloudDistributionPointInventoryFileInfoType = "SCRIPT"
)

CloudDistributionPointInventoryFileInfoType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudDistributionPointInventoryFileInfoTypeValues 

func CloudDistributionPointInventoryFileInfoTypeValues() []CloudDistributionPointInventoryFileInfoType

CloudDistributionPointInventoryFileInfoTypeValues returns every value the Jamf API accepts for CloudDistributionPointInventoryFileInfoType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudDistributionPointInventoryFilesResults 

type CloudDistributionPointInventoryFilesResults struct {
	Results    []CloudDistributionPointInventoryFileInfo `json:"results"`
	TotalCount int                                       `json:"totalCount"`
}

CloudDistributionPointInventoryFilesResults represents a cloud distribution point inventory files results.

type CloudDistributionPointTestConnection 

type CloudDistributionPointTestConnection struct {
	// Indicates whether the connection to the cloud distribution point was successful. If `true`, the
	// connection was successful. If `false`, the connection failed. Possible values are: false true.
	HasConnectionSucceeded bool `json:"hasConnectionSucceeded"`
	// A message detailing the result of the connection test. This could be a success message or an error
	// message if the connection failed.
	Message string `json:"message"`
}

CloudDistributionPointTestConnection represents a cloud distribution point test connection.

type CloudDistributionPointUploadCapability 

type CloudDistributionPointUploadCapability struct {
	DirectUploadCapable             bool `json:"directUploadCapable"`
	PrincipalDistributionTechnology bool `json:"principalDistributionTechnology"`
}

CloudDistributionPointUploadCapability represents a cloud distribution point upload capability.

type CloudIDPCommon 

type CloudIDPCommon struct {
	DisplayName string `json:"displayName"`
	ID          string `json:"id"`
	// Allowed values: see the CloudIDPCommonProviderName constants.
	ProviderName string `json:"providerName"`
}

CloudIDPCommon A Cloud Identity Provider information.

type CloudIDPCommonProviderName 

type CloudIDPCommonProviderName = string

CloudIDPCommonProviderName is the set of values accepted by CloudIDPCommon.ProviderName. 

const (
	CloudIDPCommonProviderNameGoogle CloudIDPCommonProviderName = "GOOGLE"
	CloudIDPCommonProviderNameAzure  CloudIDPCommonProviderName = "AZURE"
)

CloudIDPCommonProviderName values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudIDPCommonProviderNameValues 

func CloudIDPCommonProviderNameValues() []CloudIDPCommonProviderName

CloudIDPCommonProviderNameValues returns every value the Jamf API accepts for CloudIDPCommonProviderName, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudIDPCommonRequest 

type CloudIDPCommonRequest struct {
	DisplayName string `json:"displayName"`
	// Allowed values: see the CloudIDPCommonRequestProviderName constants.
	ProviderName string `json:"providerName"`
}

CloudIDPCommonRequest A Cloud Identity Provider information for request.

type CloudIDPCommonRequestProviderName 

type CloudIDPCommonRequestProviderName = string

CloudIDPCommonRequestProviderName is the set of values accepted by CloudIDPCommonRequest.ProviderName. 

const (
	CloudIDPCommonRequestProviderNameGoogle CloudIDPCommonRequestProviderName = "GOOGLE"
	CloudIDPCommonRequestProviderNameAzure  CloudIDPCommonRequestProviderName = "AZURE"
)

CloudIDPCommonRequestProviderName values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudIDPCommonRequestProviderNameValues 

func CloudIDPCommonRequestProviderNameValues() []CloudIDPCommonRequestProviderName

CloudIDPCommonRequestProviderNameValues returns every value the Jamf API accepts for CloudIDPCommonRequestProviderName, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudIDPCommonResponse 

type CloudIDPCommonResponse struct {
	DisplayName         string `json:"displayName"`
	Enabled             bool   `json:"enabled"`
	ID                  string `json:"id"`
	ProviderDescription string `json:"providerDescription"`
	// Allowed values: see the CloudIDPCommonResponseProviderName constants.
	ProviderName string `json:"providerName"`
}

CloudIDPCommonResponse A Cloud Identity Provider information for responses.

type CloudIDPCommonResponseProviderName 

type CloudIDPCommonResponseProviderName = string

CloudIDPCommonResponseProviderName is the set of values accepted by CloudIDPCommonResponse.ProviderName. 

const (
	CloudIDPCommonResponseProviderNameGoogle CloudIDPCommonResponseProviderName = "GOOGLE"
	CloudIDPCommonResponseProviderNameAzure  CloudIDPCommonResponseProviderName = "AZURE"
)

CloudIDPCommonResponseProviderName values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudIDPCommonResponseProviderNameValues 

func CloudIDPCommonResponseProviderNameValues() []CloudIDPCommonResponseProviderName

CloudIDPCommonResponseProviderNameValues returns every value the Jamf API accepts for CloudIDPCommonResponseProviderName, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudLdapConnectionPoolStatistics 

type CloudLdapConnectionPoolStatistics struct {
	MaximumAvailableConnections          int64 `json:"maximumAvailableConnections"`
	NumAvailableConnections              int64 `json:"numAvailableConnections"`
	NumConnectionsClosedDefunct          int64 `json:"numConnectionsClosedDefunct"`
	NumConnectionsClosedExpired          int64 `json:"numConnectionsClosedExpired"`
	NumConnectionsClosedUnneeded         int64 `json:"numConnectionsClosedUnneeded"`
	NumFailedCheckouts                   int64 `json:"numFailedCheckouts"`
	NumFailedConnectionAttempts          int64 `json:"numFailedConnectionAttempts"`
	NumReleasedValid                     int64 `json:"numReleasedValid"`
	NumSuccessfulCheckouts               int64 `json:"numSuccessfulCheckouts"`
	NumSuccessfulCheckoutsAfterWaiting   int64 `json:"numSuccessfulCheckoutsAfterWaiting"`
	NumSuccessfulCheckoutsNewConnection  int64 `json:"numSuccessfulCheckoutsNewConnection"`
	NumSuccessfulCheckoutsWithoutWaiting int64 `json:"numSuccessfulCheckoutsWithoutWaiting"`
	NumSuccessfulConnectionAttempts      int64 `json:"numSuccessfulConnectionAttempts"`
}

CloudLdapConnectionPoolStatistics Ldap Cloud Identity Provider conection pool statistics.

type CloudLdapConnectionStatus 

type CloudLdapConnectionStatus struct {
	Status string `json:"status"`
}

CloudLdapConnectionStatus Status of tested Cloud Ldap connection.

type CloudLdapKeystore 

type CloudLdapKeystore struct {
	ExpirationDate *string `json:"expirationDate"`
	FileName       string  `json:"fileName"`
	Subject        string  `json:"subject"`
	Type           string  `json:"type"`
}

CloudLdapKeystore Response with keystore information.

type CloudLdapKeystoreFile 

type CloudLdapKeystoreFile struct {
	FileBytes []byte `json:"fileBytes"`
	FileName  string `json:"fileName"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
}

CloudLdapKeystoreFile Request with the Base64-encoded keystore file.

type CloudLdapMappingsRequest 

type CloudLdapMappingsRequest struct {
	// Cloud Identity Provider user group mappings configuration.
	GroupMappings GroupMappings `json:"groupMappings"`
	// Cloud Identity Provider user group membership mappings configuration.
	MembershipMappings MembershipMappings `json:"membershipMappings"`
	// Cloud Identity Provider user mappings configuration.
	UserMappings UserMappings `json:"userMappings"`
}

CloudLdapMappingsRequest Mappings configurations request for Ldap Cloud Identity Provider configuration.

type CloudLdapMappingsResponse 

type CloudLdapMappingsResponse struct {
	// Cloud Identity Provider user group mappings configuration.
	GroupMappings *GroupMappings `json:"groupMappings,omitempty"`
	// Cloud Identity Provider user group membership mappings configuration.
	MembershipMappings *MembershipMappings `json:"membershipMappings,omitempty"`
	// Cloud Identity Provider user mappings configuration.
	UserMappings *UserMappings `json:"userMappings,omitempty"`
}

CloudLdapMappingsResponse Mappings configuration response for Ldap Cloud Identity Provider configuration.

type CloudLdapServerRequest 

type CloudLdapServerRequest struct {
	ConnectionTimeout int `json:"connectionTimeout"`
	// Allowed values: see the CloudLdapServerRequestConnectionType constants.
	ConnectionType string `json:"connectionType"`
	DomainName     string `json:"domainName"`
	Enabled        bool   `json:"enabled"`
	// Request with the Base64-encoded keystore file.
	Keystore                                 CloudLdapKeystoreFile `json:"keystore"`
	MembershipCalculationOptimizationEnabled *bool                 `json:"membershipCalculationOptimizationEnabled,omitempty"`
	Port                                     int                   `json:"port"`
	SearchTimeout                            int                   `json:"searchTimeout"`
	ServerURL                                string                `json:"serverUrl"`
	UseWildcards                             bool                  `json:"useWildcards"`
}

CloudLdapServerRequest A Cloud Identity Provider LDAP server configuration for requests.

type CloudLdapServerRequestConnectionType 

type CloudLdapServerRequestConnectionType = string

CloudLdapServerRequestConnectionType is the set of values accepted by CloudLdapServerRequest.ConnectionType. 

const (
	CloudLdapServerRequestConnectionTypeLdaps    CloudLdapServerRequestConnectionType = "LDAPS"
	CloudLdapServerRequestConnectionTypeStartTls CloudLdapServerRequestConnectionType = "START_TLS"
)

CloudLdapServerRequestConnectionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudLdapServerRequestConnectionTypeValues 

func CloudLdapServerRequestConnectionTypeValues() []CloudLdapServerRequestConnectionType

CloudLdapServerRequestConnectionTypeValues returns every value the Jamf API accepts for CloudLdapServerRequestConnectionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudLdapServerResponse 

type CloudLdapServerResponse struct {
	ConnectionTimeout int `json:"connectionTimeout"`
	// Allowed values: see the CloudLdapServerResponseConnectionType constants.
	ConnectionType string `json:"connectionType"`
	DomainName     string `json:"domainName"`
	Enabled        bool   `json:"enabled"`
	ID             string `json:"id"`
	// Response with keystore information.
	Keystore                                 *CloudLdapKeystore `json:"keystore,omitempty"`
	MembershipCalculationOptimizationEnabled bool               `json:"membershipCalculationOptimizationEnabled"`
	Port                                     int                `json:"port"`
	SearchTimeout                            int                `json:"searchTimeout"`
	ServerURL                                string             `json:"serverUrl"`
	UseWildcards                             bool               `json:"useWildcards"`
}

CloudLdapServerResponse A Cloud Identity Provider LDAP server configuration for responses.

type CloudLdapServerResponseConnectionType 

type CloudLdapServerResponseConnectionType = string

CloudLdapServerResponseConnectionType is the set of values accepted by CloudLdapServerResponse.ConnectionType. 

const (
	CloudLdapServerResponseConnectionTypeLdaps    CloudLdapServerResponseConnectionType = "LDAPS"
	CloudLdapServerResponseConnectionTypeStartTls CloudLdapServerResponseConnectionType = "START_TLS"
)

CloudLdapServerResponseConnectionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudLdapServerResponseConnectionTypeValues 

func CloudLdapServerResponseConnectionTypeValues() []CloudLdapServerResponseConnectionType

CloudLdapServerResponseConnectionTypeValues returns every value the Jamf API accepts for CloudLdapServerResponseConnectionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudLdapServerUpdate 

type CloudLdapServerUpdate struct {
	ConnectionTimeout int `json:"connectionTimeout"`
	// Allowed values: see the CloudLdapServerUpdateConnectionType constants.
	ConnectionType string `json:"connectionType"`
	DomainName     string `json:"domainName"`
	Enabled        bool   `json:"enabled"`
	// Request with the Base64-encoded keystore file.
	Keystore                                 *CloudLdapKeystoreFile `json:"keystore,omitempty"`
	MembershipCalculationOptimizationEnabled *bool                  `json:"membershipCalculationOptimizationEnabled,omitempty"`
	Port                                     int                    `json:"port"`
	SearchTimeout                            int                    `json:"searchTimeout"`
	ServerURL                                string                 `json:"serverUrl"`
	UseWildcards                             bool                   `json:"useWildcards"`
}

CloudLdapServerUpdate A Cloud Identity Provider LDAP server configuration for updates.

type CloudLdapServerUpdateConnectionType 

type CloudLdapServerUpdateConnectionType = string

CloudLdapServerUpdateConnectionType is the set of values accepted by CloudLdapServerUpdate.ConnectionType. 

const (
	CloudLdapServerUpdateConnectionTypeLdaps    CloudLdapServerUpdateConnectionType = "LDAPS"
	CloudLdapServerUpdateConnectionTypeStartTls CloudLdapServerUpdateConnectionType = "START_TLS"
)

CloudLdapServerUpdateConnectionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CloudLdapServerUpdateConnectionTypeValues 

func CloudLdapServerUpdateConnectionTypeValues() []CloudLdapServerUpdateConnectionType

CloudLdapServerUpdateConnectionTypeValues returns every value the Jamf API accepts for CloudLdapServerUpdateConnectionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type CloudResponse 

type CloudResponse struct {
	CloudInstance bool `json:"cloudInstance"`
	// Information whether this instance is a FedRAMP instance.
	FedRampInstance bool `json:"fedRampInstance"`
	// Information whether this instance has FIPS enabled.
	FipsEnabled      bool `json:"fipsEnabled"`
	GovCloudInstance bool `json:"govCloudInstance"`
	// Information whether this instance is a High Compliance instance.
	HighComplianceInstance bool `json:"highComplianceInstance"`
	// Information whether this instance is managed by managed service provider.
	ManagedServiceProviderInstance bool `json:"managedServiceProviderInstance"`
	RampInstance                   bool `json:"rampInstance"`
}

CloudResponse represents a cloud response.

type ComplianceVendorDeviceInformation 

type ComplianceVendorDeviceInformation struct {
	// Vendor's device IDs. Currently provided only for Intune.
	DeviceIds []string `json:"deviceIds"`
}

ComplianceVendorDeviceInformation Additional, compliance vendor specific device details.

type ComputerApplicationCreate 

type ComputerApplicationCreate struct {
	Name    *string `json:"name,omitempty"`
	Path    *string `json:"path,omitempty"`
	Version *string `json:"version,omitempty"`
}

ComputerApplicationCreate represents a computer application create.

type ComputerApplicationV3 

type ComputerApplicationV3 struct {
	BundleID                   string `json:"bundleId"`
	CfBundleShortVersionString string `json:"cfBundleShortVersionString"`
	CfBundleVersion            string `json:"cfBundleVersion"`
	// The app's external version ID. It can be used in the iTunes Search API to decide if the app needs to
	// be updated.
	ExternalVersionID string `json:"externalVersionId"`
	MacAppStore       bool   `json:"macAppStore"`
	Name              string `json:"name"`
	Path              string `json:"path"`
	SizeMegabytes     int    `json:"sizeMegabytes"`
	UpdateAvailable   bool   `json:"updateAvailable"`
	Version           string `json:"version"`
}

ComputerApplicationV3 represents a computer application v3.

type ComputerAttachment 

type ComputerAttachment struct {
	FileType string `json:"fileType"`
	ID       string `json:"id"`
	Name     string `json:"name"`
	// File size in bytes.
	SizeBytes int64 `json:"sizeBytes"`
}

ComputerAttachment represents a computer attachment.

type ComputerCertificate 

type ComputerCertificate struct {
	// Allowed values: see the ComputerCertificateCertificateStatus constants.
	CertificateStatus string     `json:"certificateStatus"`
	CommonName        string     `json:"commonName"`
	ExpirationDate    *time.Time `json:"expirationDate,omitempty"`
	Identity          bool       `json:"identity"`
	IssuedDate        string     `json:"issuedDate"`
	// Allowed values: see the ComputerCertificateLifecycleStatus constants.
	LifecycleStatus string `json:"lifecycleStatus"`
	SerialNumber    string `json:"serialNumber"`
	Sha1Fingerprint string `json:"sha1Fingerprint"`
	SubjectName     string `json:"subjectName"`
	Username        string `json:"username"`
}

ComputerCertificate represents a computer certificate.

type ComputerCertificateCertificateStatus 

type ComputerCertificateCertificateStatus = string

ComputerCertificateCertificateStatus is the set of values accepted by ComputerCertificate.CertificateStatus. 

const (
	ComputerCertificateCertificateStatusExpiring      ComputerCertificateCertificateStatus = "EXPIRING"
	ComputerCertificateCertificateStatusExpired       ComputerCertificateCertificateStatus = "EXPIRED"
	ComputerCertificateCertificateStatusRevoked       ComputerCertificateCertificateStatus = "REVOKED"
	ComputerCertificateCertificateStatusPendingRevoke ComputerCertificateCertificateStatus = "PENDING_REVOKE"
	ComputerCertificateCertificateStatusIssued        ComputerCertificateCertificateStatus = "ISSUED"
)

ComputerCertificateCertificateStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerCertificateCertificateStatusValues 

func ComputerCertificateCertificateStatusValues() []ComputerCertificateCertificateStatus

ComputerCertificateCertificateStatusValues returns every value the Jamf API accepts for ComputerCertificateCertificateStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerCertificateCreate 

type ComputerCertificateCreate struct {
	CommonName *string `json:"commonName,omitempty"`
	Identity   *bool   `json:"identity,omitempty"`
	Username   *string `json:"username,omitempty"`
}

ComputerCertificateCreate represents a computer certificate create.

type ComputerCertificateLifecycleStatus 

type ComputerCertificateLifecycleStatus = string

ComputerCertificateLifecycleStatus is the set of values accepted by ComputerCertificate.LifecycleStatus. 

const (
	ComputerCertificateLifecycleStatusActive   ComputerCertificateLifecycleStatus = "ACTIVE"
	ComputerCertificateLifecycleStatusInactive ComputerCertificateLifecycleStatus = "INACTIVE"
)

ComputerCertificateLifecycleStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerCertificateLifecycleStatusValues 

func ComputerCertificateLifecycleStatusValues() []ComputerCertificateLifecycleStatus

ComputerCertificateLifecycleStatusValues returns every value the Jamf API accepts for ComputerCertificateLifecycleStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerConfigurationProfile 

type ComputerConfigurationProfile struct {
	DisplayName       string     `json:"displayName"`
	ID                string     `json:"id"`
	LastInstalled     *time.Time `json:"lastInstalled,omitempty"`
	ProfileIdentifier string     `json:"profileIdentifier"`
	Removable         bool       `json:"removable"`
	Username          string     `json:"username"`
	UUID              *string    `json:"uuid,omitempty"`
}

ComputerConfigurationProfile represents a computer configuration profile.

type ComputerConfigurationProfileCreate 

type ComputerConfigurationProfileCreate struct {
	DisplayName       *string    `json:"displayName,omitempty"`
	ID                *string    `json:"id,omitempty"`
	LastInstalled     *time.Time `json:"lastInstalled,omitempty"`
	ProfileIdentifier *string    `json:"profileIdentifier,omitempty"`
	Removable         *bool      `json:"removable,omitempty"`
	Username          *string    `json:"username,omitempty"`
}

ComputerConfigurationProfileCreate represents a computer configuration profile create.

type ComputerContentCaching 

type ComputerContentCaching struct {
	Activated                           bool                                      `json:"activated"`
	Active                              bool                                      `json:"active"`
	ActualCacheBytesUsed                int64                                     `json:"actualCacheBytesUsed"`
	Alerts                              []ComputerContentCachingAlert             `json:"alerts"`
	CacheBytesFree                      int64                                     `json:"cacheBytesFree"`
	CacheBytesLimit                     int64                                     `json:"cacheBytesLimit"`
	CacheBytesUsed                      int64                                     `json:"cacheBytesUsed"`
	CacheDetails                        []ComputerContentCachingCacheDetail       `json:"cacheDetails"`
	CacheStatus                         string                                    `json:"cacheStatus"`
	ComputerContentCachingInformationID string                                    `json:"computerContentCachingInformationId"`
	DataMigrationCompleted              bool                                      `json:"dataMigrationCompleted"`
	DataMigrationError                  *ComputerContentCachingDataMigrationError `json:"dataMigrationError,omitempty"`
	DataMigrationProgressPercentage     int                                       `json:"dataMigrationProgressPercentage"`
	MaxCachePressureLast1HourPercentage int                                       `json:"maxCachePressureLast1HourPercentage"`
	Parents                             []ComputerContentCachingParent            `json:"parents"`
	PersonalCacheBytesFree              int64                                     `json:"personalCacheBytesFree"`
	PersonalCacheBytesLimit             int64                                     `json:"personalCacheBytesLimit"`
	PersonalCacheBytesUsed              int64                                     `json:"personalCacheBytesUsed"`
	Port                                int64                                     `json:"port"`
	PublicAddress                       string                                    `json:"publicAddress"`
	RegistrationError                   string                                    `json:"registrationError"`
	RegistrationResponseCode            int64                                     `json:"registrationResponseCode"`
	RegistrationStarted                 *time.Time                                `json:"registrationStarted,omitempty"`
	// Allowed values: see the ComputerContentCachingRegistrationStatus constants.
	RegistrationStatus string `json:"registrationStatus"`
	RestrictedMedia    bool   `json:"restrictedMedia"`
	ServerGuid         string `json:"serverGuid"`
	StartupStatus      string `json:"startupStatus"`
	// Allowed values: see the ComputerContentCachingTetheratorStatus constants.
	TetheratorStatus             string     `json:"tetheratorStatus"`
	TotalBytesAreSince           *time.Time `json:"totalBytesAreSince,omitempty"`
	TotalBytesDropped            int64      `json:"totalBytesDropped"`
	TotalBytesImported           int64      `json:"totalBytesImported"`
	TotalBytesReturnedToChildren int64      `json:"totalBytesReturnedToChildren"`
	TotalBytesReturnedToClients  int64      `json:"totalBytesReturnedToClients"`
	TotalBytesReturnedToPeers    int64      `json:"totalBytesReturnedToPeers"`
	TotalBytesStoredFromOrigin   int64      `json:"totalBytesStoredFromOrigin"`
	TotalBytesStoredFromParents  int64      `json:"totalBytesStoredFromParents"`
	TotalBytesStoredFromPeers    int64      `json:"totalBytesStoredFromPeers"`
}

ComputerContentCaching represents a computer content caching.

type ComputerContentCachingAlert 

type ComputerContentCachingAlert struct {
	CacheBytesLimit      int64      `json:"cacheBytesLimit"`
	ClassName            string     `json:"className"`
	PathPreventingAccess string     `json:"pathPreventingAccess"`
	PostDate             *time.Time `json:"postDate,omitempty"`
	ReservedVolumeBytes  int64      `json:"reservedVolumeBytes"`
	Resource             string     `json:"resource"`
}

ComputerContentCachingAlert represents a computer content caching alert.

type ComputerContentCachingCacheDetail 

type ComputerContentCachingCacheDetail struct {
	CategoryName                         string `json:"categoryName"`
	ComputerContentCachingCacheDetailsID string `json:"computerContentCachingCacheDetailsId"`
	DiskSpaceBytesUsed                   int64  `json:"diskSpaceBytesUsed"`
}

ComputerContentCachingCacheDetail represents a computer content caching cache detail.

type ComputerContentCachingDataMigrationError 

type ComputerContentCachingDataMigrationError struct {
	Code     int64                                              `json:"code"`
	Domain   string                                             `json:"domain"`
	UserInfo []ComputerContentCachingDataMigrationErrorUserInfo `json:"userInfo"`
}

ComputerContentCachingDataMigrationError represents a computer content caching data migration error.

type ComputerContentCachingDataMigrationErrorUserInfo 

type ComputerContentCachingDataMigrationErrorUserInfo struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

ComputerContentCachingDataMigrationErrorUserInfo represents a computer content caching data migration error user info.

type ComputerContentCachingParent 

type ComputerContentCachingParent struct {
	Address                string                               `json:"address"`
	Alerts                 *ComputerContentCachingParentAlert   `json:"alerts,omitempty"`
	ContentCachingParentID string                               `json:"contentCachingParentId"`
	Details                *ComputerContentCachingParentDetails `json:"details,omitempty"`
	Guid                   string                               `json:"guid"`
	Healthy                bool                                 `json:"healthy"`
	Port                   int64                                `json:"port"`
	Version                string                               `json:"version"`
}

ComputerContentCachingParent represents a computer content caching parent.

type ComputerContentCachingParentAlert 

type ComputerContentCachingParentAlert struct {
	Addresses                   []string   `json:"addresses"`
	ClassName                   string     `json:"className"`
	ContentCachingParentAlertID string     `json:"contentCachingParentAlertId"`
	PostDate                    *time.Time `json:"postDate,omitempty"`
}

ComputerContentCachingParentAlert represents a computer content caching parent alert.

type ComputerContentCachingParentCapabilities 

type ComputerContentCachingParentCapabilities struct {
	ContentCachingParentCapabilitiesID string `json:"contentCachingParentCapabilitiesId"`
	Imports                            bool   `json:"imports"`
	Namespaces                         bool   `json:"namespaces"`
	PersonalContent                    bool   `json:"personalContent"`
	Prioritization                     bool   `json:"prioritization"`
	QueryParameters                    bool   `json:"queryParameters"`
	SharedContent                      bool   `json:"sharedContent"`
}

ComputerContentCachingParentCapabilities represents a computer content caching parent capabilities.

type ComputerContentCachingParentDetails 

type ComputerContentCachingParentDetails struct {
	AcPower                       bool                                       `json:"acPower"`
	CacheSizeBytes                int64                                      `json:"cacheSizeBytes"`
	Capabilities                  *ComputerContentCachingParentCapabilities  `json:"capabilities,omitempty"`
	ContentCachingParentDetailsID string                                     `json:"contentCachingParentDetailsId"`
	LocalNetwork                  []ComputerContentCachingParentLocalNetwork `json:"localNetwork"`
	Portable                      bool                                       `json:"portable"`
}

ComputerContentCachingParentDetails represents a computer content caching parent details.

type ComputerContentCachingParentLocalNetwork 

type ComputerContentCachingParentLocalNetwork struct {
	ContentCachingParentLocalNetworkID string `json:"contentCachingParentLocalNetworkId"`
	Speed                              int64  `json:"speed"`
	Wired                              bool   `json:"wired"`
}

ComputerContentCachingParentLocalNetwork represents a computer content caching parent local network.

type ComputerContentCachingRegistrationStatus 

type ComputerContentCachingRegistrationStatus = string

ComputerContentCachingRegistrationStatus is the set of values accepted by ComputerContentCaching.RegistrationStatus. 

const (
	ComputerContentCachingRegistrationStatusContentCachingFailed    ComputerContentCachingRegistrationStatus = "CONTENT_CACHING_FAILED"
	ComputerContentCachingRegistrationStatusContentCachingPending   ComputerContentCachingRegistrationStatus = "CONTENT_CACHING_PENDING"
	ComputerContentCachingRegistrationStatusContentCachingSucceeded ComputerContentCachingRegistrationStatus = "CONTENT_CACHING_SUCCEEDED"
)

ComputerContentCachingRegistrationStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerContentCachingRegistrationStatusValues 

func ComputerContentCachingRegistrationStatusValues() []ComputerContentCachingRegistrationStatus

ComputerContentCachingRegistrationStatusValues returns every value the Jamf API accepts for ComputerContentCachingRegistrationStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerContentCachingTetheratorStatus 

type ComputerContentCachingTetheratorStatus = string

ComputerContentCachingTetheratorStatus is the set of values accepted by ComputerContentCaching.TetheratorStatus. 

const (
	ComputerContentCachingTetheratorStatusContentCachingUnknown  ComputerContentCachingTetheratorStatus = "CONTENT_CACHING_UNKNOWN"
	ComputerContentCachingTetheratorStatusContentCachingDisabled ComputerContentCachingTetheratorStatus = "CONTENT_CACHING_DISABLED"
	ComputerContentCachingTetheratorStatusContentCachingEnabled  ComputerContentCachingTetheratorStatus = "CONTENT_CACHING_ENABLED"
)

ComputerContentCachingTetheratorStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerContentCachingTetheratorStatusValues 

func ComputerContentCachingTetheratorStatusValues() []ComputerContentCachingTetheratorStatus

ComputerContentCachingTetheratorStatusValues returns every value the Jamf API accepts for ComputerContentCachingTetheratorStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerDisk 

type ComputerDisk struct {
	Device       string              `json:"device"`
	ID           string              `json:"id"`
	Model        string              `json:"model"`
	Partitions   []ComputerPartition `json:"partitions"`
	Revision     string              `json:"revision"`
	SerialNumber string              `json:"serialNumber"`
	// Disk Size in MB.
	SizeMegabytes int64 `json:"sizeMegabytes"`
	// S.M.A.R.T Status.
	SmartStatus string `json:"smartStatus"`
	// Connection type attribute.
	Type string `json:"type"`
}

ComputerDisk represents a computer disk.

type ComputerDiskCreate 

type ComputerDiskCreate struct {
	Device       *string                    `json:"device,omitempty"`
	Model        *string                    `json:"model,omitempty"`
	Partitions   *[]ComputerPartitionCreate `json:"partitions,omitempty"`
	Revision     *string                    `json:"revision,omitempty"`
	SerialNumber *string                    `json:"serialNumber,omitempty"`
	// Disk Size in MB.
	SizeMegabytes *int64 `json:"sizeMegabytes,omitempty"`
	// S.M.A.R.T Status.
	SmartStatus *string `json:"smartStatus,omitempty"`
	// Connection type attribute.
	Type *string `json:"type,omitempty"`
}

ComputerDiskCreate represents a computer disk create.

type ComputerDiskEncryption 

type ComputerDiskEncryption struct {
	BootPartitionEncryptionDetails  *ComputerPartitionEncryption `json:"bootPartitionEncryptionDetails,omitempty"`
	DiskEncryptionConfigurationName string                       `json:"diskEncryptionConfigurationName"`
	FileVault2EligibilityMessage    string                       `json:"fileVault2EligibilityMessage"`
	FileVault2Enabled               bool                         `json:"fileVault2Enabled"`
	FileVault2EnabledUserNames      []string                     `json:"fileVault2EnabledUserNames"`
	// Allowed values: see the ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus constants.
	IndividualRecoveryKeyValidityStatus string `json:"individualRecoveryKeyValidityStatus"`
	InstitutionalRecoveryKeyPresent     bool   `json:"institutionalRecoveryKeyPresent"`
}

ComputerDiskEncryption represents a computer disk encryption.

type ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus 

type ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus = string

ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus is the set of values accepted by ComputerDiskEncryption.IndividualRecoveryKeyValidityStatus. 

const (
	ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusValid         ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus = "VALID"
	ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusInvalid       ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus = "INVALID"
	ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusUnknown       ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus = "UNKNOWN"
	ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusNotApplicable ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus = "NOT_APPLICABLE"
)

ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusValues 

func ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusValues() []ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus

ComputerDiskEncryptionIndividualRecoveryKeyValidityStatusValues returns every value the Jamf API accepts for ComputerDiskEncryptionIndividualRecoveryKeyValidityStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerExtensionAttribute 

type ComputerExtensionAttribute struct {
	// A data type of extension attribute.
	// Allowed values: see the ComputerExtensionAttributeDataType constants.
	DataType *string `json:"dataType,omitempty"`
	// An identifier of extension attribute definition.
	DefinitionID *string `json:"definitionId,omitempty"`
	// An additional explanation of exact attribute meaning, possible values, etc.
	Description *string `json:"description,omitempty"`
	Enabled     *bool   `json:"enabled,omitempty"`
	// The input method. `text` is most common and means simply free text, `popup` i a closed list of
	// values from which one or many can be selected and `script` value is calculated and can never be set
	// directly.
	// Allowed values: see the ComputerExtensionAttributeInputType constants.
	InputType  *string `json:"inputType,omitempty"`
	MultiValue *bool   `json:"multiValue,omitempty"`
	// A human-readable name by which attribute can be referred to.
	Name *string `json:"name,omitempty"`
	// A closed list of possible values (applies to `popup` input type).
	Options *[]string `json:"options,omitempty"`
	// A value of extension attribute, in some rare cases there may be multiple values present, hence the
	// array.
	Values *[]string `json:"values,omitempty"`
}

ComputerExtensionAttribute represents a computer extension attribute.

type ComputerExtensionAttributeDataType 

type ComputerExtensionAttributeDataType = string

ComputerExtensionAttributeDataType is the set of values accepted by ComputerExtensionAttribute.DataType. 

const (
	ComputerExtensionAttributeDataTypeString   ComputerExtensionAttributeDataType = "STRING"
	ComputerExtensionAttributeDataTypeInteger  ComputerExtensionAttributeDataType = "INTEGER"
	ComputerExtensionAttributeDataTypeDateTime ComputerExtensionAttributeDataType = "DATE_TIME"
)

ComputerExtensionAttributeDataType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerExtensionAttributeDataTypeValues 

func ComputerExtensionAttributeDataTypeValues() []ComputerExtensionAttributeDataType

ComputerExtensionAttributeDataTypeValues returns every value the Jamf API accepts for ComputerExtensionAttributeDataType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerExtensionAttributeInputType 

type ComputerExtensionAttributeInputType = string

ComputerExtensionAttributeInputType is the set of values accepted by ComputerExtensionAttribute.InputType. 

const (
	ComputerExtensionAttributeInputTypeText   ComputerExtensionAttributeInputType = "TEXT"
	ComputerExtensionAttributeInputTypePopup  ComputerExtensionAttributeInputType = "POPUP"
	ComputerExtensionAttributeInputTypeScript ComputerExtensionAttributeInputType = "SCRIPT"
	ComputerExtensionAttributeInputTypeLdap   ComputerExtensionAttributeInputType = "LDAP"
)

ComputerExtensionAttributeInputType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerExtensionAttributeInputTypeValues 

func ComputerExtensionAttributeInputTypeValues() []ComputerExtensionAttributeInputType

ComputerExtensionAttributeInputTypeValues returns every value the Jamf API accepts for ComputerExtensionAttributeInputType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerExtensionAttributeSearchResults 

type ComputerExtensionAttributeSearchResults struct {
	Results    []ComputerExtensionAttributes `json:"results"`
	TotalCount int                           `json:"totalCount"`
}

ComputerExtensionAttributeSearchResults represents a computer extension attribute search results.

type ComputerExtensionAttributeTemplates 

type ComputerExtensionAttributeTemplates struct {
	// Template category name of the extension attribute.
	TemplateCategoryName string `json:"templateCategoryName"`
	// Unique Id for Computer Extension Attribute Template.
	TemplateID string `json:"templateId"`
	// Template display name of the extension attribute.
	TemplateName string `json:"templateName"`
}

ComputerExtensionAttributeTemplates represents a computer extension attribute templates.

type ComputerExtensionAttributes 

type ComputerExtensionAttributes struct {
	// Type of data being collected.
	// Allowed values: see the ComputerExtensionAttributesDataType constants.
	DataType string `json:"dataType"`
	// Description for the extension attribute.
	Description *string `json:"description,omitempty"`
	// Enabled by default, but for inputType Script we can disable it as well. Possible values are: false
	// true.
	Enabled *bool `json:"enabled,omitempty"`
	// Unique Id for Mobile Device Extension Attribute.
	ID *string `json:"id,omitempty"`
	// Extension attributes collect inventory data by using an input type.The type of the Input used to
	// populate the extension attribute.
	// Allowed values: see the ComputerExtensionAttributesInputType constants.
	InputType string `json:"inputType"`
	// Category in which to display the extension attribute in Jamf Pro.
	// Allowed values: see the ComputerExtensionAttributesInventoryDisplayType constants.
	InventoryDisplayType string `json:"inventoryDisplayType"`
	// Directory Service attribute use to populate the extension attribute. Required when inputType is
	// "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING".
	LdapAttributeMapping *string `json:"ldapAttributeMapping,omitempty"`
	// Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by
	// default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value
	// cannot be modified during edit operation. Possible values are: false true.
	LdapExtensionAttributeAllowed *bool `json:"ldapExtensionAttributeAllowed,omitempty"`
	// It is used to specify to either delete or retain the extension attributes values when inputType is
	// Script and enabled is false.
	// Allowed values: see the ComputerExtensionAttributesManageExistingData constants.
	ManageExistingData *string `json:"manageExistingData,omitempty"`
	// Display name for the extension attribute.
	Name string `json:"name"`
	// When added with list of choices while creating computer extension attributes these Pop-up menu can
	// be displayed in inventory information. User can choose a value from the pop-up menu list when
	// enrolling a computer any time using Jamf Pro. Provide popupMenuChoices only when inputType is
	// 'POPUP'.
	PopupMenuChoices *[]string `json:"popupMenuChoices,omitempty"`
	// When we run this script it returns a data value each time a computer submits inventory to Jamf Pro.
	// Provide scriptContents only when inputType is 'SCRIPT'.
	ScriptContents *string `json:"scriptContents,omitempty"`
}

ComputerExtensionAttributes represents a computer extension attributes.

type ComputerExtensionAttributesDataType 

type ComputerExtensionAttributesDataType = string

ComputerExtensionAttributesDataType is the set of values accepted by ComputerExtensionAttributes.DataType. 

const (
	ComputerExtensionAttributesDataTypeInteger ComputerExtensionAttributesDataType = "INTEGER"
	ComputerExtensionAttributesDataTypeString  ComputerExtensionAttributesDataType = "STRING"
	ComputerExtensionAttributesDataTypeDate    ComputerExtensionAttributesDataType = "DATE"
)

ComputerExtensionAttributesDataType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerExtensionAttributesDataTypeValues 

func ComputerExtensionAttributesDataTypeValues() []ComputerExtensionAttributesDataType

ComputerExtensionAttributesDataTypeValues returns every value the Jamf API accepts for ComputerExtensionAttributesDataType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerExtensionAttributesInputType 

type ComputerExtensionAttributesInputType = string

ComputerExtensionAttributesInputType is the set of values accepted by ComputerExtensionAttributes.InputType. 

const (
	ComputerExtensionAttributesInputTypeScript                           ComputerExtensionAttributesInputType = "SCRIPT"
	ComputerExtensionAttributesInputTypeText                             ComputerExtensionAttributesInputType = "TEXT"
	ComputerExtensionAttributesInputTypePopup                            ComputerExtensionAttributesInputType = "POPUP"
	ComputerExtensionAttributesInputTypeDirectoryServiceAttributeMapping ComputerExtensionAttributesInputType = "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"
)

ComputerExtensionAttributesInputType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerExtensionAttributesInputTypeValues 

func ComputerExtensionAttributesInputTypeValues() []ComputerExtensionAttributesInputType

ComputerExtensionAttributesInputTypeValues returns every value the Jamf API accepts for ComputerExtensionAttributesInputType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerExtensionAttributesInventoryDisplayType 

type ComputerExtensionAttributesInventoryDisplayType = string

ComputerExtensionAttributesInventoryDisplayType is the set of values accepted by ComputerExtensionAttributes.InventoryDisplayType. 

const (
	ComputerExtensionAttributesInventoryDisplayTypeGeneral             ComputerExtensionAttributesInventoryDisplayType = "GENERAL"
	ComputerExtensionAttributesInventoryDisplayTypeHardware            ComputerExtensionAttributesInventoryDisplayType = "HARDWARE"
	ComputerExtensionAttributesInventoryDisplayTypeOperatingSystem     ComputerExtensionAttributesInventoryDisplayType = "OPERATING_SYSTEM"
	ComputerExtensionAttributesInventoryDisplayTypeUserAndLocation     ComputerExtensionAttributesInventoryDisplayType = "USER_AND_LOCATION"
	ComputerExtensionAttributesInventoryDisplayTypePurchasing          ComputerExtensionAttributesInventoryDisplayType = "PURCHASING"
	ComputerExtensionAttributesInventoryDisplayTypeExtensionAttributes ComputerExtensionAttributesInventoryDisplayType = "EXTENSION_ATTRIBUTES"
)

ComputerExtensionAttributesInventoryDisplayType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerExtensionAttributesInventoryDisplayTypeValues 

func ComputerExtensionAttributesInventoryDisplayTypeValues() []ComputerExtensionAttributesInventoryDisplayType

ComputerExtensionAttributesInventoryDisplayTypeValues returns every value the Jamf API accepts for ComputerExtensionAttributesInventoryDisplayType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerExtensionAttributesManageExistingData 

type ComputerExtensionAttributesManageExistingData = string

ComputerExtensionAttributesManageExistingData is the set of values accepted by ComputerExtensionAttributes.ManageExistingData. 

const (
	ComputerExtensionAttributesManageExistingDataRetain ComputerExtensionAttributesManageExistingData = "RETAIN"
	ComputerExtensionAttributesManageExistingDataDelete ComputerExtensionAttributesManageExistingData = "DELETE"
)

ComputerExtensionAttributesManageExistingData values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerExtensionAttributesManageExistingDataValues 

func ComputerExtensionAttributesManageExistingDataValues() []ComputerExtensionAttributesManageExistingData

ComputerExtensionAttributesManageExistingDataValues returns every value the Jamf API accepts for ComputerExtensionAttributesManageExistingData, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerGeneral 

type ComputerGeneral struct {
	// The enrollment type reported by Apple.
	// Allowed values: see the ComputerGeneralAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration                    bool                         `json:"awaitingConfiguration"`
	Barcode1                                 string                       `json:"barcode1"`
	Barcode2                                 string                       `json:"barcode2"`
	DeclarativeDeviceManagementEnabled       bool                         `json:"declarativeDeviceManagementEnabled"`
	DistributionPoint                        string                       `json:"distributionPoint"`
	EnrolledViaAutomatedDeviceEnrollment     bool                         `json:"enrolledViaAutomatedDeviceEnrollment"`
	EnrollmentMethod                         *EnrollmentMethod            `json:"enrollmentMethod,omitempty"`
	ExtensionAttributes                      []ComputerExtensionAttribute `json:"extensionAttributes"`
	InitialEntryDate                         string                       `json:"initialEntryDate"`
	ItunesStoreAccountActive                 bool                         `json:"itunesStoreAccountActive"`
	JamfBinaryVersion                        string                       `json:"jamfBinaryVersion"`
	LastCloudBackupDate                      *time.Time                   `json:"lastCloudBackupDate,omitempty"`
	LastContactTime                          *time.Time                   `json:"lastContactTime,omitempty"`
	LastEnrolledDate                         *time.Time                   `json:"lastEnrolledDate,omitempty"`
	LastIPAddress                            string                       `json:"lastIpAddress"`
	LastLoggedInUsernameBinary               *string                      `json:"lastLoggedInUsernameBinary,omitempty"`
	LastLoggedInUsernameBinaryTimestamp      *time.Time                   `json:"lastLoggedInUsernameBinaryTimestamp,omitempty"`
	LastLoggedInUsernameMDM                  *string                      `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp         *time.Time                   `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService          *string                      `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp *time.Time                   `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	// Last reported IPv4 address (Deprecated. Use lastReportedIpV4 instead.).
	LastReportedIp string `json:"lastReportedIp"`
	// Last reported IPv4 address.
	LastReportedIPV4     string                    `json:"lastReportedIpV4"`
	LastReportedIPV6     string                    `json:"lastReportedIpV6"`
	ManagementID         string                    `json:"managementId"`
	MDMCapable           *ComputerMDMCapability    `json:"mdmCapable,omitempty"`
	MDMProfileExpiration *time.Time                `json:"mdmProfileExpiration,omitempty"`
	Name                 string                    `json:"name"`
	Platform             string                    `json:"platform"`
	RemoteManagement     *ComputerRemoteManagement `json:"remoteManagement,omitempty"`
	ReportDate           *time.Time                `json:"reportDate,omitempty"`
	Site                 *ComputerSite             `json:"site,omitempty"`
	Supervised           bool                      `json:"supervised"`
	UserApprovedMDM      bool                      `json:"userApprovedMdm"`
}

ComputerGeneral represents a computer general.

type ComputerGeneralAppleEnrollmentType 

type ComputerGeneralAppleEnrollmentType = string

ComputerGeneralAppleEnrollmentType is the set of values accepted by ComputerGeneral.AppleEnrollmentType. 

const (
	ComputerGeneralAppleEnrollmentTypeNone       ComputerGeneralAppleEnrollmentType = "none"
	ComputerGeneralAppleEnrollmentTypeSupervised ComputerGeneralAppleEnrollmentType = "supervised"
	ComputerGeneralAppleEnrollmentTypeDevice     ComputerGeneralAppleEnrollmentType = "device"
	ComputerGeneralAppleEnrollmentTypeUser       ComputerGeneralAppleEnrollmentType = "user"
	ComputerGeneralAppleEnrollmentTypeUnknown    ComputerGeneralAppleEnrollmentType = "unknown"
)

ComputerGeneralAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerGeneralAppleEnrollmentTypeValues 

func ComputerGeneralAppleEnrollmentTypeValues() []ComputerGeneralAppleEnrollmentType

ComputerGeneralAppleEnrollmentTypeValues returns every value the Jamf API accepts for ComputerGeneralAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerGeneralCreate 

type ComputerGeneralCreate struct {
	AssetTag                             *string    `json:"assetTag,omitempty"`
	Barcode1                             *string    `json:"barcode1,omitempty"`
	Barcode2                             *string    `json:"barcode2,omitempty"`
	DeclarativeDeviceManagementEnabled   *bool      `json:"declarativeDeviceManagementEnabled,omitempty"`
	DistributionPointID                  *string    `json:"distributionPointId,omitempty"`
	EnrolledViaAutomatedDeviceEnrollment *bool      `json:"enrolledViaAutomatedDeviceEnrollment,omitempty"`
	ItunesStoreAccountActive             *bool      `json:"itunesStoreAccountActive,omitempty"`
	JamfBinaryVersion                    *string    `json:"jamfBinaryVersion,omitempty"`
	LastCloudBackupDate                  *time.Time `json:"lastCloudBackupDate,omitempty"`
	LastContactTime                      *time.Time `json:"lastContactTime,omitempty"`
	LastEnrolledDate                     *time.Time `json:"lastEnrolledDate,omitempty"`
	LastIPAddress                        *string    `json:"lastIpAddress,omitempty"`
	LastReportedIp                       *string    `json:"lastReportedIp,omitempty"`
	MDMCapable                           *bool      `json:"mdmCapable,omitempty"`
	Name                                 string     `json:"name"`
	// Allowed values: see the ComputerGeneralCreatePlatform constants.
	Platform         *string                         `json:"platform,omitempty"`
	RemoteManagement *ComputerRemoteManagementCreate `json:"remoteManagement,omitempty"`
	ReportDate       *time.Time                      `json:"reportDate,omitempty"`
	SiteID           *string                         `json:"siteId,omitempty"`
	Supervised       *bool                           `json:"supervised,omitempty"`
	UserApprovedMDM  *bool                           `json:"userApprovedMdm,omitempty"`
}

ComputerGeneralCreate represents a computer general create.

type ComputerGeneralCreatePlatform 

type ComputerGeneralCreatePlatform = string

ComputerGeneralCreatePlatform is the set of values accepted by ComputerGeneralCreate.Platform. 

const (
	ComputerGeneralCreatePlatformWindows ComputerGeneralCreatePlatform = "WINDOWS"
	ComputerGeneralCreatePlatformMac     ComputerGeneralCreatePlatform = "MAC"
	ComputerGeneralCreatePlatformNone    ComputerGeneralCreatePlatform = "NONE"
)

ComputerGeneralCreatePlatform values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerGeneralCreatePlatformValues 

func ComputerGeneralCreatePlatformValues() []ComputerGeneralCreatePlatform

ComputerGeneralCreatePlatformValues returns every value the Jamf API accepts for ComputerGeneralCreatePlatform, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerGeneralCreateV4 

type ComputerGeneralCreateV4 struct {
	AssetTag                             *string    `json:"assetTag,omitempty"`
	Barcode1                             *string    `json:"barcode1,omitempty"`
	Barcode2                             *string    `json:"barcode2,omitempty"`
	DeclarativeDeviceManagementEnabled   *bool      `json:"declarativeDeviceManagementEnabled,omitempty"`
	DistributionPointID                  *string    `json:"distributionPointId,omitempty"`
	EnrolledViaAutomatedDeviceEnrollment *bool      `json:"enrolledViaAutomatedDeviceEnrollment,omitempty"`
	ItunesStoreAccountActive             *bool      `json:"itunesStoreAccountActive,omitempty"`
	JamfBinaryVersion                    *string    `json:"jamfBinaryVersion,omitempty"`
	LastCheckIn                          *time.Time `json:"lastCheckIn,omitempty"`
	LastCloudBackupDate                  *time.Time `json:"lastCloudBackupDate,omitempty"`
	// The most recent time the device communicated with Jamf Pro via any channel (binary check-in, MDM
	// ack, or DDM status report).
	LastContact      *time.Time `json:"lastContact,omitempty"`
	LastEnrolledDate *time.Time `json:"lastEnrolledDate,omitempty"`
	LastIPAddress    *string    `json:"lastIpAddress,omitempty"`
	MDMCapable       *bool      `json:"mdmCapable,omitempty"`
	Name             string     `json:"name"`
	// Allowed values: see the ComputerGeneralCreateV4Platform constants.
	Platform         *string                         `json:"platform,omitempty"`
	RemoteManagement *ComputerRemoteManagementCreate `json:"remoteManagement,omitempty"`
	ReportDate       *time.Time                      `json:"reportDate,omitempty"`
	SiteID           *string                         `json:"siteId,omitempty"`
	Supervised       *bool                           `json:"supervised,omitempty"`
	UserApprovedMDM  *bool                           `json:"userApprovedMdm,omitempty"`
}

ComputerGeneralCreateV4 represents a computer general create v4.

type ComputerGeneralCreateV4Platform 

type ComputerGeneralCreateV4Platform = string

ComputerGeneralCreateV4Platform is the set of values accepted by ComputerGeneralCreateV4.Platform. 

const (
	ComputerGeneralCreateV4PlatformWindows ComputerGeneralCreateV4Platform = "WINDOWS"
	ComputerGeneralCreateV4PlatformMac     ComputerGeneralCreateV4Platform = "MAC"
	ComputerGeneralCreateV4PlatformNone    ComputerGeneralCreateV4Platform = "NONE"
)

ComputerGeneralCreateV4Platform values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerGeneralCreateV4PlatformValues 

func ComputerGeneralCreateV4PlatformValues() []ComputerGeneralCreateV4Platform

ComputerGeneralCreateV4PlatformValues returns every value the Jamf API accepts for ComputerGeneralCreateV4Platform, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerGeneralUpdate 

type ComputerGeneralUpdate struct {
	AssetTag            *string                       `json:"assetTag,omitempty"`
	Barcode1            *string                       `json:"barcode1,omitempty"`
	Barcode2            *string                       `json:"barcode2,omitempty"`
	ExtensionAttributes *[]ComputerExtensionAttribute `json:"extensionAttributes,omitempty"`
	LastIPAddress       *string                       `json:"lastIpAddress,omitempty"`
	Managed             *bool                         `json:"managed,omitempty"`
	Name                *string                       `json:"name,omitempty"`
	SiteID              *string                       `json:"siteId,omitempty"`
}

ComputerGeneralUpdate represents a computer general update.

type ComputerGeneralV4 

type ComputerGeneralV4 struct {
	// The enrollment type reported by Apple.
	// Allowed values: see the ComputerGeneralV4AppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration                    bool                         `json:"awaitingConfiguration"`
	Barcode1                                 string                       `json:"barcode1"`
	Barcode2                                 string                       `json:"barcode2"`
	DeclarativeDeviceManagementEnabled       bool                         `json:"declarativeDeviceManagementEnabled"`
	DistributionPoint                        string                       `json:"distributionPoint"`
	EnrolledViaAutomatedDeviceEnrollment     bool                         `json:"enrolledViaAutomatedDeviceEnrollment"`
	EnrollmentMethod                         *EnrollmentMethod            `json:"enrollmentMethod,omitempty"`
	ExtensionAttributes                      []ComputerExtensionAttribute `json:"extensionAttributes"`
	InitialEntryDate                         string                       `json:"initialEntryDate"`
	ItunesStoreAccountActive                 bool                         `json:"itunesStoreAccountActive"`
	JamfBinaryVersion                        string                       `json:"jamfBinaryVersion"`
	LastCheckIn                              *time.Time                   `json:"lastCheckIn,omitempty"`
	LastCloudBackupDate                      *time.Time                   `json:"lastCloudBackupDate,omitempty"`
	LastContact                              *time.Time                   `json:"lastContact,omitempty"`
	LastEnrolledDate                         *time.Time                   `json:"lastEnrolledDate,omitempty"`
	LastIPAddress                            string                       `json:"lastIpAddress"`
	LastLoggedInUsernameBinary               *string                      `json:"lastLoggedInUsernameBinary,omitempty"`
	LastLoggedInUsernameBinaryTimestamp      *time.Time                   `json:"lastLoggedInUsernameBinaryTimestamp,omitempty"`
	LastLoggedInUsernameMDM                  *string                      `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp         *time.Time                   `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService          *string                      `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp *time.Time                   `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	// Last reported IPv4 address.
	LastReportedIPV4     string                    `json:"lastReportedIpV4"`
	LastReportedIPV6     string                    `json:"lastReportedIpV6"`
	ManagementID         string                    `json:"managementId"`
	MDMCapable           *ComputerMDMCapability    `json:"mdmCapable,omitempty"`
	MDMProfileExpiration *time.Time                `json:"mdmProfileExpiration,omitempty"`
	Name                 string                    `json:"name"`
	Platform             string                    `json:"platform"`
	RemoteManagement     *ComputerRemoteManagement `json:"remoteManagement,omitempty"`
	ReportDate           *time.Time                `json:"reportDate,omitempty"`
	Site                 *ComputerSite             `json:"site,omitempty"`
	Supervised           bool                      `json:"supervised"`
	UserApprovedMDM      bool                      `json:"userApprovedMdm"`
}

ComputerGeneralV4 represents a computer general v4.

type ComputerGeneralV4AppleEnrollmentType 

type ComputerGeneralV4AppleEnrollmentType = string

ComputerGeneralV4AppleEnrollmentType is the set of values accepted by ComputerGeneralV4.AppleEnrollmentType. 

const (
	ComputerGeneralV4AppleEnrollmentTypeNone       ComputerGeneralV4AppleEnrollmentType = "none"
	ComputerGeneralV4AppleEnrollmentTypeSupervised ComputerGeneralV4AppleEnrollmentType = "supervised"
	ComputerGeneralV4AppleEnrollmentTypeDevice     ComputerGeneralV4AppleEnrollmentType = "device"
	ComputerGeneralV4AppleEnrollmentTypeUser       ComputerGeneralV4AppleEnrollmentType = "user"
	ComputerGeneralV4AppleEnrollmentTypeUnknown    ComputerGeneralV4AppleEnrollmentType = "unknown"
)

ComputerGeneralV4AppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerGeneralV4AppleEnrollmentTypeValues 

func ComputerGeneralV4AppleEnrollmentTypeValues() []ComputerGeneralV4AppleEnrollmentType

ComputerGeneralV4AppleEnrollmentTypeValues returns every value the Jamf API accepts for ComputerGeneralV4AppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerGroup 

type ComputerGroup struct {
	Description string `json:"description"`
	ID          string `json:"id"`
	Name        string `json:"name"`
	SmartGroup  bool   `json:"smartGroup"`
}

ComputerGroup represents a computer group.

type ComputerHardware 

type ComputerHardware struct {
	AltMacAddress         string `json:"altMacAddress"`
	AltNetworkAdapterType string `json:"altNetworkAdapterType"`
	AppleSilicon          bool   `json:"appleSilicon"`
	// Remaining percentage of battery power.
	BatteryCapacityPercent int `json:"batteryCapacityPercent"`
	// - NON_GENUINE: The battery isn’t a genuine Apple battery. - NORMAL: The battery is operating
	// normally. - SERVICE_RECOMMENDED: The system recommends battery service. - UNKNOWN: The system
	// couldn’t determine battery health information. - UNSUPPORTED: The device doesn’t support battery
	// health reporting.
	// Allowed values: see the ComputerHardwareBatteryHealth constants.
	BatteryHealth string `json:"batteryHealth"`
	BleCapable    bool   `json:"bleCapable"`
	BootRom       string `json:"bootRom"`
	BusSpeedMhz   int64  `json:"busSpeedMhz"`
	// Cache Size in KB.
	CacheSizeKilobytes  int64                        `json:"cacheSizeKilobytes"`
	CoreCount           int                          `json:"coreCount"`
	ExtensionAttributes []ComputerExtensionAttribute `json:"extensionAttributes"`
	MacAddress          string                       `json:"macAddress"`
	Make                string                       `json:"make"`
	Model               string                       `json:"model"`
	ModelIdentifier     string                       `json:"modelIdentifier"`
	NetworkAdapterType  string                       `json:"networkAdapterType"`
	NicSpeed            string                       `json:"nicSpeed"`
	// Available RAM slots.
	OpenRamSlots          int    `json:"openRamSlots"`
	OpticalDrive          string `json:"opticalDrive"`
	ProcessorArchitecture string `json:"processorArchitecture"`
	ProcessorCount        int    `json:"processorCount"`
	// Processor Speed in MHz.
	ProcessorSpeedMhz      int64  `json:"processorSpeedMhz"`
	ProcessorType          string `json:"processorType"`
	ProvisioningUDID       string `json:"provisioningUdid"`
	SerialNumber           string `json:"serialNumber"`
	SmcVersion             string `json:"smcVersion"`
	SupportsIosAppInstalls bool   `json:"supportsIosAppInstalls"`
	// Total RAM Size in MB.
	TotalRamMegabytes int64 `json:"totalRamMegabytes"`
}

ComputerHardware represents a computer hardware.

type ComputerHardwareBatteryHealth 

type ComputerHardwareBatteryHealth = string

ComputerHardwareBatteryHealth is the set of values accepted by ComputerHardware.BatteryHealth. 

const (
	ComputerHardwareBatteryHealthNonGenuine         ComputerHardwareBatteryHealth = "NON_GENUINE"
	ComputerHardwareBatteryHealthNormal             ComputerHardwareBatteryHealth = "NORMAL"
	ComputerHardwareBatteryHealthServiceRecommended ComputerHardwareBatteryHealth = "SERVICE_RECOMMENDED"
	ComputerHardwareBatteryHealthUnknown            ComputerHardwareBatteryHealth = "UNKNOWN"
	ComputerHardwareBatteryHealthUnsupported        ComputerHardwareBatteryHealth = "UNSUPPORTED"
)

ComputerHardwareBatteryHealth values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerHardwareBatteryHealthValues 

func ComputerHardwareBatteryHealthValues() []ComputerHardwareBatteryHealth

ComputerHardwareBatteryHealthValues returns every value the Jamf API accepts for ComputerHardwareBatteryHealth, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerHardwareCreate 

type ComputerHardwareCreate struct {
	AltMacAddress         *string `json:"altMacAddress,omitempty"`
	AltNetworkAdapterType *string `json:"altNetworkAdapterType,omitempty"`
	AppleSilicon          *bool   `json:"appleSilicon,omitempty"`
	// Remaining percentage of battery power.
	BatteryCapacityPercent *int `json:"batteryCapacityPercent,omitempty"`
	// - NON_GENUINE: The battery isn’t a genuine Apple battery. - NORMAL: The battery is operating
	// normally. - SERVICE_RECOMMENDED: The system recommends battery service. - UNKNOWN: The system
	// couldn’t determine battery health information. - UNSUPPORTED: The device doesn’t support battery
	// health reporting.
	// Allowed values: see the ComputerHardwareCreateBatteryHealth constants.
	BatteryHealth *string `json:"batteryHealth,omitempty"`
	BleCapable    *bool   `json:"bleCapable,omitempty"`
	BootRom       *string `json:"bootRom,omitempty"`
	BusSpeedMhz   *int64  `json:"busSpeedMhz,omitempty"`
	// Cache Size in KB.
	CacheSizeKilobytes *int64  `json:"cacheSizeKilobytes,omitempty"`
	CoreCount          *int    `json:"coreCount,omitempty"`
	MacAddress         *string `json:"macAddress,omitempty"`
	Make               *string `json:"make,omitempty"`
	Model              *string `json:"model,omitempty"`
	ModelIdentifier    *string `json:"modelIdentifier,omitempty"`
	NetworkAdapterType *string `json:"networkAdapterType,omitempty"`
	NicSpeed           *string `json:"nicSpeed,omitempty"`
	// Available RAM slots.
	OpenRamSlots          *int    `json:"openRamSlots,omitempty"`
	OpticalDrive          *string `json:"opticalDrive,omitempty"`
	ProcessorArchitecture *string `json:"processorArchitecture,omitempty"`
	ProcessorCount        *int    `json:"processorCount,omitempty"`
	// Processor Speed in MHz.
	ProcessorSpeedMhz      *int64  `json:"processorSpeedMhz,omitempty"`
	ProcessorType          *string `json:"processorType,omitempty"`
	SerialNumber           *string `json:"serialNumber,omitempty"`
	SmcVersion             *string `json:"smcVersion,omitempty"`
	SupportsIosAppInstalls *bool   `json:"supportsIosAppInstalls,omitempty"`
	// Total RAM Size in MB.
	TotalRamMegabytes *int64 `json:"totalRamMegabytes,omitempty"`
}

ComputerHardwareCreate represents a computer hardware create.

type ComputerHardwareCreateBatteryHealth 

type ComputerHardwareCreateBatteryHealth = string

ComputerHardwareCreateBatteryHealth is the set of values accepted by ComputerHardwareCreate.BatteryHealth. 

const (
	ComputerHardwareCreateBatteryHealthNonGenuine         ComputerHardwareCreateBatteryHealth = "NON_GENUINE"
	ComputerHardwareCreateBatteryHealthNormal             ComputerHardwareCreateBatteryHealth = "NORMAL"
	ComputerHardwareCreateBatteryHealthServiceRecommended ComputerHardwareCreateBatteryHealth = "SERVICE_RECOMMENDED"
	ComputerHardwareCreateBatteryHealthUnknown            ComputerHardwareCreateBatteryHealth = "UNKNOWN"
	ComputerHardwareCreateBatteryHealthUnsupported        ComputerHardwareCreateBatteryHealth = "UNSUPPORTED"
)

ComputerHardwareCreateBatteryHealth values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerHardwareCreateBatteryHealthValues 

func ComputerHardwareCreateBatteryHealthValues() []ComputerHardwareCreateBatteryHealth

ComputerHardwareCreateBatteryHealthValues returns every value the Jamf API accepts for ComputerHardwareCreateBatteryHealth, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerHardwareUpdate 

type ComputerHardwareUpdate struct {
	AltMacAddress         *string                       `json:"altMacAddress,omitempty"`
	AltNetworkAdapterType *string                       `json:"altNetworkAdapterType,omitempty"`
	ExtensionAttributes   *[]ComputerExtensionAttribute `json:"extensionAttributes,omitempty"`
	MacAddress            *string                       `json:"macAddress,omitempty"`
	NetworkAdapterType    *string                       `json:"networkAdapterType,omitempty"`
}

ComputerHardwareUpdate represents a computer hardware update.

type ComputerIbeacon 

type ComputerIbeacon struct {
	Name string `json:"name"`
}

ComputerIbeacon represents a computer ibeacon.

type ComputerInventoryCollectionPreferencesV2 

type ComputerInventoryCollectionPreferencesV2 struct {
	AllowChangingUserAndLocation                 *bool `json:"allowChangingUserAndLocation,omitempty"`
	CalculateSizes                               *bool `json:"calculateSizes,omitempty"`
	CollectSyncedMobileDeviceInfo                *bool `json:"collectSyncedMobileDeviceInfo,omitempty"`
	CollectUnmanagedCertificates                 *bool `json:"collectUnmanagedCertificates,omitempty"`
	IncludeAccounts                              *bool `json:"includeAccounts,omitempty"`
	IncludeHiddenAccounts                        *bool `json:"includeHiddenAccounts,omitempty"`
	IncludePackages                              *bool `json:"includePackages,omitempty"`
	IncludePrinters                              *bool `json:"includePrinters,omitempty"`
	IncludeServices                              *bool `json:"includeServices,omitempty"`
	IncludeSoftwareID                            *bool `json:"includeSoftwareId,omitempty"`
	IncludeSoftwareUpdates                       *bool `json:"includeSoftwareUpdates,omitempty"`
	MonitorApplicationUsage                      *bool `json:"monitorApplicationUsage,omitempty"`
	MonitorBeacons                               *bool `json:"monitorBeacons,omitempty"`
	UpdateLdapInfoOnComputerInventorySubmissions *bool `json:"updateLdapInfoOnComputerInventorySubmissions,omitempty"`
	UseUnixUserPaths                             *bool `json:"useUnixUserPaths,omitempty"`
}

ComputerInventoryCollectionPreferencesV2 represents a computer inventory collection preferences v2.

type ComputerInventoryCollectionSettingsV2 

type ComputerInventoryCollectionSettingsV2 struct {
	ApplicationPaths                       *[]AppPath                                `json:"applicationPaths,omitempty"`
	ComputerInventoryCollectionPreferences *ComputerInventoryCollectionPreferencesV2 `json:"computerInventoryCollectionPreferences,omitempty"`
}

ComputerInventoryCollectionSettingsV2 represents a computer inventory collection settings v2.

type ComputerInventoryCreateRequestV2 

type ComputerInventoryCreateRequestV2 struct {
	Applications          *[]ComputerApplicationCreate          `json:"applications,omitempty"`
	Certificates          *[]ComputerCertificateCreate          `json:"certificates,omitempty"`
	ConfigurationProfiles *[]ComputerConfigurationProfileCreate `json:"configurationProfiles,omitempty"`
	General               *ComputerGeneralCreate                `json:"general,omitempty"`
	Hardware              *ComputerHardwareCreate               `json:"hardware,omitempty"`
	LocalUserAccounts     *[]ComputerLocalUserAccountCreate     `json:"localUserAccounts,omitempty"`
	OperatingSystem       *ComputerOperatingSystemCreate        `json:"operatingSystem,omitempty"`
	// All package receipts are listed by their package name.
	PackageReceipts *ComputerPackageReceiptsCreate  `json:"packageReceipts,omitempty"`
	Printers        *[]ComputerPrinterCreate        `json:"printers,omitempty"`
	Purchasing      *ComputerPurchaseCreate         `json:"purchasing,omitempty"`
	Security        *ComputerSecurityCreate         `json:"security,omitempty"`
	Services        *[]ComputerServiceCreate        `json:"services,omitempty"`
	SoftwareUpdates *[]ComputerSoftwareUpdateCreate `json:"softwareUpdates,omitempty"`
	Storage         *ComputerStorageCreate          `json:"storage,omitempty"`
	UDID            *string                         `json:"udid,omitempty"`
	UserAndLocation *ComputerUserAndLocationCreate  `json:"userAndLocation,omitempty"`
}

ComputerInventoryCreateRequestV2 represents a computer inventory create request v2.

type ComputerInventoryCreateRequestV4 

type ComputerInventoryCreateRequestV4 struct {
	Applications          *[]ComputerApplicationCreate          `json:"applications,omitempty"`
	Certificates          *[]ComputerCertificateCreate          `json:"certificates,omitempty"`
	ConfigurationProfiles *[]ComputerConfigurationProfileCreate `json:"configurationProfiles,omitempty"`
	General               *ComputerGeneralCreateV4              `json:"general,omitempty"`
	Hardware              *ComputerHardwareCreate               `json:"hardware,omitempty"`
	LocalUserAccounts     *[]ComputerLocalUserAccountCreate     `json:"localUserAccounts,omitempty"`
	OperatingSystem       *ComputerOperatingSystemCreate        `json:"operatingSystem,omitempty"`
	// All package receipts are listed by their package name.
	PackageReceipts *ComputerPackageReceiptsCreate  `json:"packageReceipts,omitempty"`
	Printers        *[]ComputerPrinterCreate        `json:"printers,omitempty"`
	Purchasing      *ComputerPurchaseCreate         `json:"purchasing,omitempty"`
	Security        *ComputerSecurityCreate         `json:"security,omitempty"`
	Services        *[]ComputerServiceCreate        `json:"services,omitempty"`
	SoftwareUpdates *[]ComputerSoftwareUpdateCreate `json:"softwareUpdates,omitempty"`
	Storage         *ComputerStorageCreate          `json:"storage,omitempty"`
	UDID            *string                         `json:"udid,omitempty"`
	UserAndLocation *ComputerUserAndLocationCreate  `json:"userAndLocation,omitempty"`
}

ComputerInventoryCreateRequestV4 represents a computer inventory create request v4.

type ComputerInventoryDeviceLockPinResponse 

type ComputerInventoryDeviceLockPinResponse struct {
	Pin string `json:"pin"`
}

ComputerInventoryDeviceLockPinResponse represents a computer inventory device lock pin response.

type ComputerInventoryFileVault 

type ComputerInventoryFileVault struct {
	BootPartitionEncryptionDetails  *ComputerPartitionEncryption `json:"bootPartitionEncryptionDetails,omitempty"`
	ComputerID                      string                       `json:"computerId"`
	DiskEncryptionConfigurationName string                       `json:"diskEncryptionConfigurationName"`
	// Allowed values: see the ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus constants.
	IndividualRecoveryKeyValidityStatus string `json:"individualRecoveryKeyValidityStatus"`
	InstitutionalRecoveryKeyPresent     bool   `json:"institutionalRecoveryKeyPresent"`
	Name                                string `json:"name"`
	PersonalRecoveryKey                 string `json:"personalRecoveryKey"`
}

ComputerInventoryFileVault represents a computer inventory file vault.

type ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus 

type ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus = string

ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus is the set of values accepted by ComputerInventoryFileVault.IndividualRecoveryKeyValidityStatus. 

const (
	ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusValid         ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus = "VALID"
	ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusInvalid       ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus = "INVALID"
	ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusUnknown       ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus = "UNKNOWN"
	ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusNotApplicable ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus = "NOT_APPLICABLE"
)

ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusValues 

func ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusValues() []ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus

ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatusValues returns every value the Jamf API accepts for ComputerInventoryFileVaultIndividualRecoveryKeyValidityStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerInventoryFileVaultSearchResults 

type ComputerInventoryFileVaultSearchResults struct {
	Results    []ComputerInventoryFileVault `json:"results"`
	TotalCount int                          `json:"totalCount"`
}

ComputerInventoryFileVaultSearchResults represents a computer inventory file vault search results.

type ComputerInventoryRecoveryLockPasswordResponse 

type ComputerInventoryRecoveryLockPasswordResponse struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	RecoveryLockPassword string `json:"recoveryLockPassword"`
}

ComputerInventoryRecoveryLockPasswordResponse represents a computer inventory recovery lock password response.

type ComputerInventorySearchResultsV3 

type ComputerInventorySearchResultsV3 struct {
	Results    []ComputerInventoryV3 `json:"results"`
	TotalCount int                   `json:"totalCount"`
}

ComputerInventorySearchResultsV3 represents a computer inventory search results v3.

type ComputerInventorySearchResultsV4 

type ComputerInventorySearchResultsV4 struct {
	Results    []ComputerInventoryV4 `json:"results"`
	TotalCount int                   `json:"totalCount"`
}

ComputerInventorySearchResultsV4 represents a computer inventory search results v4.

type ComputerInventoryUpdateRequest 

type ComputerInventoryUpdateRequest struct {
	ExtensionAttributes *[]ComputerExtensionAttribute  `json:"extensionAttributes,omitempty"`
	General             *ComputerGeneralUpdate         `json:"general,omitempty"`
	Hardware            *ComputerHardwareUpdate        `json:"hardware,omitempty"`
	OperatingSystem     *ComputerOperatingSystemUpdate `json:"operatingSystem,omitempty"`
	Purchasing          *ComputerPurchase              `json:"purchasing,omitempty"`
	UDID                *string                        `json:"udid,omitempty"`
	UserAndLocation     *ComputerUserAndLocation       `json:"userAndLocation,omitempty"`
}

ComputerInventoryUpdateRequest represents a computer inventory update request.

type ComputerInventoryV3 

type ComputerInventoryV3 struct {
	Applications          []ComputerApplicationV3        `json:"applications"`
	Attachments           []ComputerAttachment           `json:"attachments"`
	Certificates          []ComputerCertificate          `json:"certificates"`
	ConfigurationProfiles []ComputerConfigurationProfile `json:"configurationProfiles"`
	ContentCaching        *ComputerContentCaching        `json:"contentCaching,omitempty"`
	DiskEncryption        *ComputerDiskEncryption        `json:"diskEncryption,omitempty"`
	ExtensionAttributes   []ComputerExtensionAttribute   `json:"extensionAttributes"`
	General               *ComputerGeneral               `json:"general,omitempty"`
	GroupMemberships      []GroupMembership              `json:"groupMemberships"`
	Hardware              *ComputerHardware              `json:"hardware,omitempty"`
	Ibeacons              []ComputerIbeacon              `json:"ibeacons"`
	ID                    string                         `json:"id"`
	LicensedSoftware      []ComputerLicensedSoftware     `json:"licensedSoftware"`
	LocalUserAccounts     []ComputerLocalUserAccount     `json:"localUserAccounts"`
	OperatingSystem       *ComputerOperatingSystem       `json:"operatingSystem,omitempty"`
	// All package receipts are listed by their package name.
	PackageReceipts *ComputerPackageReceipts `json:"packageReceipts,omitempty"`
	Printers        []ComputerPrinter        `json:"printers"`
	Purchasing      *ComputerPurchase        `json:"purchasing,omitempty"`
	Security        *ComputerSecurity        `json:"security,omitempty"`
	Services        []ComputerService        `json:"services"`
	SoftwareUpdates []ComputerSoftwareUpdate `json:"softwareUpdates"`
	Storage         *ComputerStorage         `json:"storage,omitempty"`
	UDID            string                   `json:"udid"`
	UserAndLocation *ComputerUserAndLocation `json:"userAndLocation,omitempty"`
}

ComputerInventoryV3 represents a computer inventory v3.

type ComputerInventoryV4 

type ComputerInventoryV4 struct {
	Applications          []ComputerApplicationV3        `json:"applications"`
	Attachments           []ComputerAttachment           `json:"attachments"`
	Certificates          []ComputerCertificate          `json:"certificates"`
	ConfigurationProfiles []ComputerConfigurationProfile `json:"configurationProfiles"`
	ContentCaching        *ComputerContentCaching        `json:"contentCaching,omitempty"`
	DiskEncryption        *ComputerDiskEncryption        `json:"diskEncryption,omitempty"`
	ExtensionAttributes   []ComputerExtensionAttribute   `json:"extensionAttributes"`
	General               *ComputerGeneralV4             `json:"general,omitempty"`
	GroupMemberships      []GroupMembership              `json:"groupMemberships"`
	Hardware              *ComputerHardware              `json:"hardware,omitempty"`
	Ibeacons              []ComputerIbeacon              `json:"ibeacons"`
	ID                    string                         `json:"id"`
	LicensedSoftware      []ComputerLicensedSoftware     `json:"licensedSoftware"`
	LocalUserAccounts     []ComputerLocalUserAccount     `json:"localUserAccounts"`
	OperatingSystem       *ComputerOperatingSystem       `json:"operatingSystem,omitempty"`
	// All package receipts are listed by their package name.
	PackageReceipts *ComputerPackageReceipts `json:"packageReceipts,omitempty"`
	Printers        []ComputerPrinter        `json:"printers"`
	Purchasing      *ComputerPurchase        `json:"purchasing,omitempty"`
	Security        *ComputerSecurity        `json:"security,omitempty"`
	Services        []ComputerService        `json:"services"`
	SoftwareUpdates []ComputerSoftwareUpdate `json:"softwareUpdates"`
	Storage         *ComputerStorage         `json:"storage,omitempty"`
	UDID            string                   `json:"udid"`
	UserAndLocation *ComputerUserAndLocation `json:"userAndLocation,omitempty"`
}

ComputerInventoryV4 represents a computer inventory v4.

type ComputerLicensedSoftware 

type ComputerLicensedSoftware struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

ComputerLicensedSoftware represents a computer licensed software.

type ComputerLocalUserAccount 

type ComputerLocalUserAccount struct {
	Admin bool `json:"admin"`
	// Allowed values: see the ComputerLocalUserAccountAzureActiveDirectoryID constants.
	AzureActiveDirectoryID         string `json:"azureActiveDirectoryId"`
	ComputerAzureActiveDirectoryID string `json:"computerAzureActiveDirectoryId"`
	FileVault2Enabled              bool   `json:"fileVault2Enabled"`
	FullName                       string `json:"fullName"`
	HomeDirectory                  string `json:"homeDirectory"`
	// Home directory size in MB.
	HomeDirectorySizeMb          int64  `json:"homeDirectorySizeMb"`
	PasswordHistoryDepth         int    `json:"passwordHistoryDepth"`
	PasswordMaxAge               int    `json:"passwordMaxAge"`
	PasswordMinComplexCharacters int    `json:"passwordMinComplexCharacters"`
	PasswordMinLength            int    `json:"passwordMinLength"`
	PasswordRequireAlphanumeric  bool   `json:"passwordRequireAlphanumeric"`
	Uid                          string `json:"uid"`
	// Allowed values: see the ComputerLocalUserAccountUserAccountType constants.
	UserAccountType            string `json:"userAccountType"`
	UserAzureActiveDirectoryID string `json:"userAzureActiveDirectoryId"`
	UserGuid                   string `json:"userGuid"`
	Username                   string `json:"username"`
}

ComputerLocalUserAccount represents a computer local user account.

type ComputerLocalUserAccountAzureActiveDirectoryID 

type ComputerLocalUserAccountAzureActiveDirectoryID = string

ComputerLocalUserAccountAzureActiveDirectoryID is the set of values accepted by ComputerLocalUserAccount.AzureActiveDirectoryID. 

const (
	ComputerLocalUserAccountAzureActiveDirectoryIDActivated    ComputerLocalUserAccountAzureActiveDirectoryID = "ACTIVATED"
	ComputerLocalUserAccountAzureActiveDirectoryIDDeactivated  ComputerLocalUserAccountAzureActiveDirectoryID = "DEACTIVATED"
	ComputerLocalUserAccountAzureActiveDirectoryIDUnresponsive ComputerLocalUserAccountAzureActiveDirectoryID = "UNRESPONSIVE"
	ComputerLocalUserAccountAzureActiveDirectoryIDUnknown      ComputerLocalUserAccountAzureActiveDirectoryID = "UNKNOWN"
)

ComputerLocalUserAccountAzureActiveDirectoryID values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerLocalUserAccountAzureActiveDirectoryIDValues 

func ComputerLocalUserAccountAzureActiveDirectoryIDValues() []ComputerLocalUserAccountAzureActiveDirectoryID

ComputerLocalUserAccountAzureActiveDirectoryIDValues returns every value the Jamf API accepts for ComputerLocalUserAccountAzureActiveDirectoryID, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerLocalUserAccountCreate 

type ComputerLocalUserAccountCreate struct {
	Admin                          *bool   `json:"admin,omitempty"`
	ComputerAzureActiveDirectoryID *string `json:"computerAzureActiveDirectoryId,omitempty"`
	FileVault2Enabled              *bool   `json:"fileVault2Enabled,omitempty"`
	FullName                       *string `json:"fullName,omitempty"`
	HomeDirectory                  *string `json:"homeDirectory,omitempty"`
	// Home directory size in MB.
	HomeDirectorySizeMb          *int64  `json:"homeDirectorySizeMb,omitempty"`
	PasswordHistoryDepth         *int    `json:"passwordHistoryDepth,omitempty"`
	PasswordMaxAge               *int    `json:"passwordMaxAge,omitempty"`
	PasswordMinComplexCharacters *int    `json:"passwordMinComplexCharacters,omitempty"`
	PasswordMinLength            *int    `json:"passwordMinLength,omitempty"`
	PasswordRequireAlphanumeric  *bool   `json:"passwordRequireAlphanumeric,omitempty"`
	Uid                          *string `json:"uid,omitempty"`
	// Allowed values: see the ComputerLocalUserAccountCreateUserAccountType constants.
	UserAccountType            *string `json:"userAccountType,omitempty"`
	UserAzureActiveDirectoryID *string `json:"userAzureActiveDirectoryId,omitempty"`
	UserGuid                   *string `json:"userGuid,omitempty"`
	Username                   *string `json:"username,omitempty"`
}

ComputerLocalUserAccountCreate represents a computer local user account create.

type ComputerLocalUserAccountCreateUserAccountType 

type ComputerLocalUserAccountCreateUserAccountType = string

ComputerLocalUserAccountCreateUserAccountType is the set of values accepted by ComputerLocalUserAccountCreate.UserAccountType. 

const (
	ComputerLocalUserAccountCreateUserAccountTypeLocal   ComputerLocalUserAccountCreateUserAccountType = "LOCAL"
	ComputerLocalUserAccountCreateUserAccountTypeMobile  ComputerLocalUserAccountCreateUserAccountType = "MOBILE"
	ComputerLocalUserAccountCreateUserAccountTypeUnknown ComputerLocalUserAccountCreateUserAccountType = "UNKNOWN"
)

ComputerLocalUserAccountCreateUserAccountType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerLocalUserAccountCreateUserAccountTypeValues 

func ComputerLocalUserAccountCreateUserAccountTypeValues() []ComputerLocalUserAccountCreateUserAccountType

ComputerLocalUserAccountCreateUserAccountTypeValues returns every value the Jamf API accepts for ComputerLocalUserAccountCreateUserAccountType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerLocalUserAccountUserAccountType 

type ComputerLocalUserAccountUserAccountType = string

ComputerLocalUserAccountUserAccountType is the set of values accepted by ComputerLocalUserAccount.UserAccountType. 

const (
	ComputerLocalUserAccountUserAccountTypeLocal   ComputerLocalUserAccountUserAccountType = "LOCAL"
	ComputerLocalUserAccountUserAccountTypeMobile  ComputerLocalUserAccountUserAccountType = "MOBILE"
	ComputerLocalUserAccountUserAccountTypeUnknown ComputerLocalUserAccountUserAccountType = "UNKNOWN"
)

ComputerLocalUserAccountUserAccountType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerLocalUserAccountUserAccountTypeValues 

func ComputerLocalUserAccountUserAccountTypeValues() []ComputerLocalUserAccountUserAccountType

ComputerLocalUserAccountUserAccountTypeValues returns every value the Jamf API accepts for ComputerLocalUserAccountUserAccountType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerLocation 

type ComputerLocation struct {
	Position string `json:"position"`
	Room     string `json:"room"`
	Username string `json:"username"`
}

ComputerLocation represents a computer location.

type ComputerMDMCapability 

type ComputerMDMCapability struct {
	Capable bool `json:"capable"`
	// Deprecated. Use userManagementInfo instead.
	CapableUsers       []string                     `json:"capableUsers"`
	UserManagementInfo []ComputerUserManagementInfo `json:"userManagementInfo"`
}

ComputerMDMCapability represents a computer m d m capability.

type ComputerOperatingSystem 

type ComputerOperatingSystem struct {
	ActiveDirectoryStatus string                       `json:"activeDirectoryStatus"`
	Build                 string                       `json:"build"`
	ExtensionAttributes   []ComputerExtensionAttribute `json:"extensionAttributes"`
	// Allowed values: see the ComputerOperatingSystemFileVault2Status constants.
	FileVault2Status string `json:"fileVault2Status"`
	Name             string `json:"name"`
	// Collected for macOS 13.0 or later.
	RapidSecurityResponse  string `json:"rapidSecurityResponse"`
	SoftwareUpdateDeviceID string `json:"softwareUpdateDeviceId"`
	// Collected for macOS 13.0 or later.
	SupplementalBuildVersion string `json:"supplementalBuildVersion"`
	Version                  string `json:"version"`
}

ComputerOperatingSystem represents a computer operating system.

type ComputerOperatingSystemCreate 

type ComputerOperatingSystemCreate struct {
	ActiveDirectoryStatus    *string `json:"activeDirectoryStatus,omitempty"`
	Build                    *string `json:"build,omitempty"`
	Name                     *string `json:"name,omitempty"`
	RapidSecurityResponse    *string `json:"rapidSecurityResponse,omitempty"`
	SoftwareUpdateDeviceID   *string `json:"softwareUpdateDeviceId,omitempty"`
	SupplementalBuildVersion *string `json:"supplementalBuildVersion,omitempty"`
	Version                  *string `json:"version,omitempty"`
}

ComputerOperatingSystemCreate represents a computer operating system create.

type ComputerOperatingSystemFileVault2Status 

type ComputerOperatingSystemFileVault2Status = string

ComputerOperatingSystemFileVault2Status is the set of values accepted by ComputerOperatingSystem.FileVault2Status. 

const (
	ComputerOperatingSystemFileVault2StatusNotApplicable ComputerOperatingSystemFileVault2Status = "NOT_APPLICABLE"
	ComputerOperatingSystemFileVault2StatusNotEncrypted  ComputerOperatingSystemFileVault2Status = "NOT_ENCRYPTED"
	ComputerOperatingSystemFileVault2StatusBootEncrypted ComputerOperatingSystemFileVault2Status = "BOOT_ENCRYPTED"
	ComputerOperatingSystemFileVault2StatusSomeEncrypted ComputerOperatingSystemFileVault2Status = "SOME_ENCRYPTED"
	ComputerOperatingSystemFileVault2StatusAllEncrypted  ComputerOperatingSystemFileVault2Status = "ALL_ENCRYPTED"
)

ComputerOperatingSystemFileVault2Status values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerOperatingSystemFileVault2StatusValues 

func ComputerOperatingSystemFileVault2StatusValues() []ComputerOperatingSystemFileVault2Status

ComputerOperatingSystemFileVault2StatusValues returns every value the Jamf API accepts for ComputerOperatingSystemFileVault2Status, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerOperatingSystemUpdate 

type ComputerOperatingSystemUpdate struct {
	ExtensionAttributes *[]ComputerExtensionAttribute `json:"extensionAttributes,omitempty"`
}

ComputerOperatingSystemUpdate represents a computer operating system update.

type ComputerOverview 

type ComputerOverview struct {
	AssetTag             string            `json:"assetTag"`
	ID                   string            `json:"id"`
	IPAddress            string            `json:"ipAddress"`
	IsManaged            bool              `json:"isManaged"`
	LastContactDate      string            `json:"lastContactDate"`
	LastEnrolledDate     string            `json:"lastEnrolledDate"`
	LastReportDate       string            `json:"lastReportDate"`
	Location             *ComputerLocation `json:"location,omitempty"`
	MacAddress           string            `json:"macAddress"`
	ManagementID         string            `json:"managementId"`
	MDMAccessRights      int               `json:"mdmAccessRights"`
	ModelIdentifier      string            `json:"modelIdentifier"`
	Name                 string            `json:"name"`
	OperatingSystemBuild string            `json:"operatingSystemBuild"`
	// Collected for macOS 13.0 or later.
	OperatingSystemRapidSecurityResponse string `json:"operatingSystemRapidSecurityResponse"`
	// Collected for macOS 13.0 or later.
	OperatingSystemSupplementalBuildVersion string `json:"operatingSystemSupplementalBuildVersion"`
	OperatingSystemVersion                  string `json:"operatingSystemVersion"`
	SerialNumber                            string `json:"serialNumber"`
	UDID                                    string `json:"udid"`
}

ComputerOverview represents a computer overview.

type ComputerPackageReceipts 

type ComputerPackageReceipts struct {
	Cached                  []string `json:"cached"`
	InstalledByInstallerSwu []string `json:"installedByInstallerSwu"`
	InstalledByJamfPro      []string `json:"installedByJamfPro"`
}

ComputerPackageReceipts All package receipts are listed by their package name.

type ComputerPackageReceiptsCreate 

type ComputerPackageReceiptsCreate struct {
	Cached                  *[]string `json:"cached,omitempty"`
	InstalledByInstallerSwu *[]string `json:"installedByInstallerSwu,omitempty"`
	InstalledByJamfPro      *[]string `json:"installedByJamfPro,omitempty"`
}

ComputerPackageReceiptsCreate All package receipts are listed by their package name.

type ComputerPartition 

type ComputerPartition struct {
	// Available space in MB.
	AvailableMegabytes int64 `json:"availableMegabytes"`
	// Percentage progress of current FileVault 2 operation.
	FileVault2ProgressPercent *int                              `json:"fileVault2ProgressPercent,omitempty"`
	FileVault2State           *ComputerPartitionFileVault2State `json:"fileVault2State,omitempty"`
	LvmManaged                bool                              `json:"lvmManaged"`
	Name                      string                            `json:"name"`
	// Allowed values: see the ComputerPartitionPartitionType constants.
	PartitionType string `json:"partitionType"`
	// Percentage of space used.
	PercentUsed int `json:"percentUsed"`
	// Partition Size in MB.
	SizeMegabytes int64 `json:"sizeMegabytes"`
}

ComputerPartition represents a computer partition.

type ComputerPartitionCreate 

type ComputerPartitionCreate struct {
	// Available space in MB.
	AvailableMegabytes *int64 `json:"availableMegabytes,omitempty"`
	// Percentage progress of current FileVault 2 operation.
	FileVault2ProgressPercent *int                              `json:"fileVault2ProgressPercent,omitempty"`
	FileVault2State           *ComputerPartitionFileVault2State `json:"fileVault2State,omitempty"`
	LvmManaged                *bool                             `json:"lvmManaged,omitempty"`
	Name                      *string                           `json:"name,omitempty"`
	// Allowed values: see the ComputerPartitionCreatePartitionType constants.
	PartitionType *string `json:"partitionType,omitempty"`
	// Percentage of space used.
	PercentUsed *int `json:"percentUsed,omitempty"`
	// Partition Size in MB.
	SizeMegabytes *int64 `json:"sizeMegabytes,omitempty"`
}

ComputerPartitionCreate represents a computer partition create.

type ComputerPartitionCreatePartitionType 

type ComputerPartitionCreatePartitionType = string

ComputerPartitionCreatePartitionType is the set of values accepted by ComputerPartitionCreate.PartitionType. 

const (
	ComputerPartitionCreatePartitionTypeBoot     ComputerPartitionCreatePartitionType = "BOOT"
	ComputerPartitionCreatePartitionTypeRecovery ComputerPartitionCreatePartitionType = "RECOVERY"
	ComputerPartitionCreatePartitionTypeOther    ComputerPartitionCreatePartitionType = "OTHER"
)

ComputerPartitionCreatePartitionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerPartitionCreatePartitionTypeValues 

func ComputerPartitionCreatePartitionTypeValues() []ComputerPartitionCreatePartitionType

ComputerPartitionCreatePartitionTypeValues returns every value the Jamf API accepts for ComputerPartitionCreatePartitionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerPartitionEncryption 

type ComputerPartitionEncryption struct {
	PartitionFileVault2Percent int                               `json:"partitionFileVault2Percent"`
	PartitionFileVault2State   *ComputerPartitionFileVault2State `json:"partitionFileVault2State,omitempty"`
	PartitionName              string                            `json:"partitionName"`
}

ComputerPartitionEncryption represents a computer partition encryption.

type ComputerPartitionFileVault2State 

type ComputerPartitionFileVault2State = string

ComputerPartitionFileVault2State represents a computer partition file vault2 state value. 

const (
	ComputerPartitionFileVault2StateUnknown          ComputerPartitionFileVault2State = "UNKNOWN"
	ComputerPartitionFileVault2StateUnencrypted      ComputerPartitionFileVault2State = "UNENCRYPTED"
	ComputerPartitionFileVault2StateIneligible       ComputerPartitionFileVault2State = "INELIGIBLE"
	ComputerPartitionFileVault2StateDecrypted        ComputerPartitionFileVault2State = "DECRYPTED"
	ComputerPartitionFileVault2StateDecrypting       ComputerPartitionFileVault2State = "DECRYPTING"
	ComputerPartitionFileVault2StateEncrypted        ComputerPartitionFileVault2State = "ENCRYPTED"
	ComputerPartitionFileVault2StateEncrypting       ComputerPartitionFileVault2State = "ENCRYPTING"
	ComputerPartitionFileVault2StateRestartNeeded    ComputerPartitionFileVault2State = "RESTART_NEEDED"
	ComputerPartitionFileVault2StateOptimizing       ComputerPartitionFileVault2State = "OPTIMIZING"
	ComputerPartitionFileVault2StateDecryptingPaused ComputerPartitionFileVault2State = "DECRYPTING_PAUSED"
	ComputerPartitionFileVault2StateEncryptingPaused ComputerPartitionFileVault2State = "ENCRYPTING_PAUSED"
)

ComputerPartitionFileVault2State values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerPartitionFileVault2StateValues 

func ComputerPartitionFileVault2StateValues() []ComputerPartitionFileVault2State

ComputerPartitionFileVault2StateValues returns every value the Jamf API accepts for ComputerPartitionFileVault2State, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerPartitionPartitionType 

type ComputerPartitionPartitionType = string

ComputerPartitionPartitionType is the set of values accepted by ComputerPartition.PartitionType. 

const (
	ComputerPartitionPartitionTypeBoot     ComputerPartitionPartitionType = "BOOT"
	ComputerPartitionPartitionTypeRecovery ComputerPartitionPartitionType = "RECOVERY"
	ComputerPartitionPartitionTypeOther    ComputerPartitionPartitionType = "OTHER"
)

ComputerPartitionPartitionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerPartitionPartitionTypeValues 

func ComputerPartitionPartitionTypeValues() []ComputerPartitionPartitionType

ComputerPartitionPartitionTypeValues returns every value the Jamf API accepts for ComputerPartitionPartitionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerPrestageSearchResultsV3 

type ComputerPrestageSearchResultsV3 struct {
	Results    []GetComputerPrestageV3 `json:"results"`
	TotalCount int                     `json:"totalCount"`
}

ComputerPrestageSearchResultsV3 represents a computer prestage search results v3.

type ComputerPrestageV3 

type ComputerPrestageV3 struct {
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                *[]string             `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt              string                `json:"authenticationPrompt"`
	AutoAdvanceSetup                  bool                  `json:"autoAdvanceSetup"`
	CustomPackageDistributionPointID  string                `json:"customPackageDistributionPointId"`
	CustomPackageIds                  []string              `json:"customPackageIds"`
	DefaultPrestage                   bool                  `json:"defaultPrestage"`
	Department                        string                `json:"department"`
	DeviceEnrollmentProgramInstanceID string                `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                       string                `json:"displayName"`
	EnableDeviceBasedActivationLock   bool                  `json:"enableDeviceBasedActivationLock"`
	EnableRecoveryLock                *bool                 `json:"enableRecoveryLock,omitempty"`
	EnrollmentCustomizationID         *string               `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                  string                `json:"enrollmentSiteId"`
	InstallProfilesDuringSetup        bool                  `json:"installProfilesDuringSetup"`
	KeepExistingLocationInformation   bool                  `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership        bool                  `json:"keepExistingSiteMembership"`
	Language                          *string               `json:"language,omitempty"`
	LocationInformation               LocationInformationV2 `json:"locationInformation"`
	Mandatory                         bool                  `json:"mandatory"`
	// The URL to the manifest file for the Platform SSO (PSSO) application Identity first workflow. This
	// URL is used when deploying the PSSO app to devices during the setup process.
	ManifestURL              *string `json:"manifestUrl,omitempty"`
	MDMRemovable             bool    `json:"mdmRemovable"`
	MinimumOsSpecificVersion *string `json:"minimumOsSpecificVersion,omitempty"`
	// The bundle identifier for the Platform SSO (PSSO) application Device first workflow. This identifier
	// is used to specify which PSSO app should be deployed to devices during the setup process.
	PlatformSsoAppBundleID      *string  `json:"platformSsoAppBundleId,omitempty"`
	PrestageInstalledProfileIds []string `json:"prestageInstalledProfileIds"`
	// Allowed values: see the ComputerPrestageV3PrestageMinimumOsTargetVersionType constants.
	PrestageMinimumOsTargetVersionType *string `json:"prestageMinimumOsTargetVersionType,omitempty"`
	PreventActivationLock              bool    `json:"preventActivationLock"`
	// The URL to the configuration profile for the Platform SSO (PSSO) application Identity first
	// workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users
	// should use either profileUrl or populate pssoConfigProfileId, but not both.
	ProfileURL *string `json:"profileUrl,omitempty"`
	// The identifier for the configuration profile associated with the Platform SSO (PSSO) application
	// Identity first workflow. This ID is used to specify which configuration profile should be applied to
	// devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId
	// or populate profileUrl, but not both.
	PssoConfigProfileID *string `json:"pssoConfigProfileId,omitempty"`
	// Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of Device
	// first or Identity first workflows. When enabled, the PSSO application will be deployed to devices
	// during the setup process to facilitate single sign-on (SSO) for users.
	PssoEnabled           *bool                           `json:"pssoEnabled,omitempty"`
	PurchasingInformation PrestagePurchasingInformationV2 `json:"purchasingInformation"`
	// Allowed values: see the ComputerPrestageV3RecoveryLockPasswordType constants.
	RecoveryLockPasswordType   *string          `json:"recoveryLockPasswordType,omitempty"`
	Region                     *string          `json:"region,omitempty"`
	RequireAuthentication      bool             `json:"requireAuthentication"`
	RotateRecoveryLockPassword *bool            `json:"rotateRecoveryLockPassword,omitempty"`
	SkipSetupItems             *map[string]bool `json:"skipSetupItems,omitempty"`
	SupportEmailAddress        string           `json:"supportEmailAddress"`
	SupportPhoneNumber         string           `json:"supportPhoneNumber"`
}

ComputerPrestageV3 represents a computer prestage v3.

type ComputerPrestageV3PrestageMinimumOsTargetVersionType 

type ComputerPrestageV3PrestageMinimumOsTargetVersionType = string

ComputerPrestageV3PrestageMinimumOsTargetVersionType is the set of values accepted by ComputerPrestageV3.PrestageMinimumOsTargetVersionType. 

const (
	ComputerPrestageV3PrestageMinimumOsTargetVersionTypeNoEnforcement               ComputerPrestageV3PrestageMinimumOsTargetVersionType = "NO_ENFORCEMENT"
	ComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestVersion      ComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_VERSION"
	ComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMajorVersion ComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	ComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMinorVersion ComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MINOR_VERSION"
	ComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsSpecificVersion    ComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_SPECIFIC_VERSION"
)

ComputerPrestageV3PrestageMinimumOsTargetVersionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues 

func ComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues() []ComputerPrestageV3PrestageMinimumOsTargetVersionType

ComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues returns every value the Jamf API accepts for ComputerPrestageV3PrestageMinimumOsTargetVersionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerPrestageV3RecoveryLockPasswordType 

type ComputerPrestageV3RecoveryLockPasswordType = string

ComputerPrestageV3RecoveryLockPasswordType is the set of values accepted by ComputerPrestageV3.RecoveryLockPasswordType. 

const (
	ComputerPrestageV3RecoveryLockPasswordTypeManual ComputerPrestageV3RecoveryLockPasswordType = "MANUAL"
	ComputerPrestageV3RecoveryLockPasswordTypeRandom ComputerPrestageV3RecoveryLockPasswordType = "RANDOM"
)

ComputerPrestageV3RecoveryLockPasswordType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerPrestageV3RecoveryLockPasswordTypeValues 

func ComputerPrestageV3RecoveryLockPasswordTypeValues() []ComputerPrestageV3RecoveryLockPasswordType

ComputerPrestageV3RecoveryLockPasswordTypeValues returns every value the Jamf API accepts for ComputerPrestageV3RecoveryLockPasswordType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerPrinter 

type ComputerPrinter struct {
	Location string `json:"location"`
	Name     string `json:"name"`
	Type     string `json:"type"`
	URI      string `json:"uri"`
}

ComputerPrinter represents a computer printer.

type ComputerPrinterCreate 

type ComputerPrinterCreate struct {
	Location *string `json:"location,omitempty"`
	Name     *string `json:"name,omitempty"`
	Type     *string `json:"type,omitempty"`
	URI      *string `json:"uri,omitempty"`
}

ComputerPrinterCreate represents a computer printer create.

type ComputerPurchase 

type ComputerPurchase struct {
	AppleCareID         *string                       `json:"appleCareId,omitempty"`
	ExtensionAttributes *[]ComputerExtensionAttribute `json:"extensionAttributes,omitempty"`
	LeaseDate           *string                       `json:"leaseDate,omitempty"`
	Leased              *bool                         `json:"leased,omitempty"`
	LifeExpectancy      *int                          `json:"lifeExpectancy,omitempty"`
	PoDate              *string                       `json:"poDate,omitempty"`
	PoNumber            *string                       `json:"poNumber,omitempty"`
	PurchasePrice       *string                       `json:"purchasePrice,omitempty"`
	Purchased           *bool                         `json:"purchased,omitempty"`
	PurchasingAccount   *string                       `json:"purchasingAccount,omitempty"`
	PurchasingContact   *string                       `json:"purchasingContact,omitempty"`
	Vendor              *string                       `json:"vendor,omitempty"`
	WarrantyDate        *string                       `json:"warrantyDate,omitempty"`
}

ComputerPurchase represents a computer purchase.

type ComputerPurchaseCreate 

type ComputerPurchaseCreate struct {
	AppleCareID       *string `json:"appleCareId,omitempty"`
	LeaseDate         *string `json:"leaseDate,omitempty"`
	Leased            *bool   `json:"leased,omitempty"`
	LifeExpectancy    *int    `json:"lifeExpectancy,omitempty"`
	PoDate            *string `json:"poDate,omitempty"`
	PoNumber          *string `json:"poNumber,omitempty"`
	PurchasePrice     *string `json:"purchasePrice,omitempty"`
	Purchased         *bool   `json:"purchased,omitempty"`
	PurchasingAccount *string `json:"purchasingAccount,omitempty"`
	PurchasingContact *string `json:"purchasingContact,omitempty"`
	Vendor            *string `json:"vendor,omitempty"`
	WarrantyDate      *string `json:"warrantyDate,omitempty"`
}

ComputerPurchaseCreate represents a computer purchase create.

type ComputerRemoteManagement 

type ComputerRemoteManagement struct {
	Managed bool `json:"managed"`
	// This field always returns null, please use /local-admin-password/ endpoint instead.
	ManagementUsername string `json:"managementUsername"`
}

ComputerRemoteManagement represents a computer remote management.

type ComputerRemoteManagementCreate 

type ComputerRemoteManagementCreate struct {
	Managed *bool `json:"managed,omitempty"`
}

ComputerRemoteManagementCreate represents a computer remote management create.

type ComputerSectionV3 

type ComputerSectionV3 = string

ComputerSectionV3 represents a computer section v3 value. 

const (
	ComputerSectionV3General               ComputerSectionV3 = "GENERAL"
	ComputerSectionV3DiskEncryption        ComputerSectionV3 = "DISK_ENCRYPTION"
	ComputerSectionV3Purchasing            ComputerSectionV3 = "PURCHASING"
	ComputerSectionV3Applications          ComputerSectionV3 = "APPLICATIONS"
	ComputerSectionV3Storage               ComputerSectionV3 = "STORAGE"
	ComputerSectionV3UserAndLocation       ComputerSectionV3 = "USER_AND_LOCATION"
	ComputerSectionV3ConfigurationProfiles ComputerSectionV3 = "CONFIGURATION_PROFILES"
	ComputerSectionV3Printers              ComputerSectionV3 = "PRINTERS"
	ComputerSectionV3Services              ComputerSectionV3 = "SERVICES"
	ComputerSectionV3Hardware              ComputerSectionV3 = "HARDWARE"
	ComputerSectionV3LocalUserAccounts     ComputerSectionV3 = "LOCAL_USER_ACCOUNTS"
	ComputerSectionV3Certificates          ComputerSectionV3 = "CERTIFICATES"
	ComputerSectionV3Attachments           ComputerSectionV3 = "ATTACHMENTS"
	ComputerSectionV3PackageReceipts       ComputerSectionV3 = "PACKAGE_RECEIPTS"
	ComputerSectionV3Security              ComputerSectionV3 = "SECURITY"
	ComputerSectionV3OperatingSystem       ComputerSectionV3 = "OPERATING_SYSTEM"
	ComputerSectionV3LicensedSoftware      ComputerSectionV3 = "LICENSED_SOFTWARE"
	ComputerSectionV3Ibeacons              ComputerSectionV3 = "IBEACONS"
	ComputerSectionV3SoftwareUpdates       ComputerSectionV3 = "SOFTWARE_UPDATES"
	ComputerSectionV3ExtensionAttributes   ComputerSectionV3 = "EXTENSION_ATTRIBUTES"
	ComputerSectionV3ContentCaching        ComputerSectionV3 = "CONTENT_CACHING"
	ComputerSectionV3GroupMemberships      ComputerSectionV3 = "GROUP_MEMBERSHIPS"
)

ComputerSectionV3 values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSectionV3Values 

func ComputerSectionV3Values() []ComputerSectionV3

ComputerSectionV3Values returns every value the Jamf API accepts for ComputerSectionV3, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSectionV4 

type ComputerSectionV4 = string

ComputerSectionV4 represents a computer section v4 value. 

const (
	ComputerSectionV4General               ComputerSectionV4 = "GENERAL"
	ComputerSectionV4DiskEncryption        ComputerSectionV4 = "DISK_ENCRYPTION"
	ComputerSectionV4Purchasing            ComputerSectionV4 = "PURCHASING"
	ComputerSectionV4Applications          ComputerSectionV4 = "APPLICATIONS"
	ComputerSectionV4Storage               ComputerSectionV4 = "STORAGE"
	ComputerSectionV4UserAndLocation       ComputerSectionV4 = "USER_AND_LOCATION"
	ComputerSectionV4ConfigurationProfiles ComputerSectionV4 = "CONFIGURATION_PROFILES"
	ComputerSectionV4Printers              ComputerSectionV4 = "PRINTERS"
	ComputerSectionV4Services              ComputerSectionV4 = "SERVICES"
	ComputerSectionV4Hardware              ComputerSectionV4 = "HARDWARE"
	ComputerSectionV4LocalUserAccounts     ComputerSectionV4 = "LOCAL_USER_ACCOUNTS"
	ComputerSectionV4Certificates          ComputerSectionV4 = "CERTIFICATES"
	ComputerSectionV4Attachments           ComputerSectionV4 = "ATTACHMENTS"
	ComputerSectionV4PackageReceipts       ComputerSectionV4 = "PACKAGE_RECEIPTS"
	ComputerSectionV4Security              ComputerSectionV4 = "SECURITY"
	ComputerSectionV4OperatingSystem       ComputerSectionV4 = "OPERATING_SYSTEM"
	ComputerSectionV4LicensedSoftware      ComputerSectionV4 = "LICENSED_SOFTWARE"
	ComputerSectionV4Ibeacons              ComputerSectionV4 = "IBEACONS"
	ComputerSectionV4SoftwareUpdates       ComputerSectionV4 = "SOFTWARE_UPDATES"
	ComputerSectionV4ExtensionAttributes   ComputerSectionV4 = "EXTENSION_ATTRIBUTES"
	ComputerSectionV4ContentCaching        ComputerSectionV4 = "CONTENT_CACHING"
	ComputerSectionV4GroupMemberships      ComputerSectionV4 = "GROUP_MEMBERSHIPS"
)

ComputerSectionV4 values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSectionV4Values 

func ComputerSectionV4Values() []ComputerSectionV4

ComputerSectionV4Values returns every value the Jamf API accepts for ComputerSectionV4, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurity 

type ComputerSecurity struct {
	// Collected for macOS 10.15.0 or later.
	ActivationLockEnabled bool `json:"activationLockEnabled"`
	// Allowed values: see the ComputerSecurityAttestationStatus constants.
	AttestationStatus string `json:"attestationStatus"`
	AutoLoginDisabled bool   `json:"autoLoginDisabled"`
	// Collected for macOS 11 or later.
	BootstrapTokenAllowed bool `json:"bootstrapTokenAllowed"`
	// Collected for macOS 11 or later.
	// Allowed values: see the ComputerSecurityBootstrapTokenEscrowedStatus constants.
	BootstrapTokenEscrowedStatus string `json:"bootstrapTokenEscrowedStatus"`
	// Collected for macOS 10.15.0 or later.
	// Allowed values: see the ComputerSecurityExternalBootLevel constants.
	ExternalBootLevel string `json:"externalBootLevel"`
	FirewallEnabled   bool   `json:"firewallEnabled"`
	// Allowed values: see the ComputerSecurityGatekeeperStatus constants.
	GatekeeperStatus          string `json:"gatekeeperStatus"`
	LastAttestationAttempt    string `json:"lastAttestationAttempt"`
	LastSuccessfulAttestation string `json:"lastSuccessfulAttestation"`
	// Whether Lockdown Mode is enabled.
	LockdownModeEnabled bool `json:"lockdownModeEnabled"`
	RecoveryLockEnabled bool `json:"recoveryLockEnabled"`
	// Collected for macOS 10.14.4 or later.
	RemoteDesktopEnabled bool `json:"remoteDesktopEnabled"`
	// Collected for macOS 10.15.0 or later.
	// Allowed values: see the ComputerSecuritySecureBootLevel constants.
	SecureBootLevel string `json:"secureBootLevel"`
	// Allowed values: see the ComputerSecuritySipStatus constants.
	SipStatus       string `json:"sipStatus"`
	XprotectVersion string `json:"xprotectVersion"`
}

ComputerSecurity represents a computer security.

type ComputerSecurityAttestationStatus 

type ComputerSecurityAttestationStatus = string

ComputerSecurityAttestationStatus is the set of values accepted by ComputerSecurity.AttestationStatus. 

const (
	ComputerSecurityAttestationStatusPending                     ComputerSecurityAttestationStatus = "PENDING"
	ComputerSecurityAttestationStatusSuccess                     ComputerSecurityAttestationStatus = "SUCCESS"
	ComputerSecurityAttestationStatusCertificateInvalid          ComputerSecurityAttestationStatus = "CERTIFICATE_INVALID"
	ComputerSecurityAttestationStatusDevicePropertiesMismatch    ComputerSecurityAttestationStatus = "DEVICE_PROPERTIES_MISMATCH"
	ComputerSecurityAttestationStatusMdaUnsupportedDueToHardware ComputerSecurityAttestationStatus = "MDA_UNSUPPORTED_DUE_TO_HARDWARE"
	ComputerSecurityAttestationStatusMdaUnsupportedDueToSoftware ComputerSecurityAttestationStatus = "MDA_UNSUPPORTED_DUE_TO_SOFTWARE"
)

ComputerSecurityAttestationStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityAttestationStatusValues 

func ComputerSecurityAttestationStatusValues() []ComputerSecurityAttestationStatus

ComputerSecurityAttestationStatusValues returns every value the Jamf API accepts for ComputerSecurityAttestationStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityBootstrapTokenEscrowedStatus 

type ComputerSecurityBootstrapTokenEscrowedStatus = string

ComputerSecurityBootstrapTokenEscrowedStatus is the set of values accepted by ComputerSecurity.BootstrapTokenEscrowedStatus. 

const (
	ComputerSecurityBootstrapTokenEscrowedStatusEscrowed     ComputerSecurityBootstrapTokenEscrowedStatus = "ESCROWED"
	ComputerSecurityBootstrapTokenEscrowedStatusNotEscrowed  ComputerSecurityBootstrapTokenEscrowedStatus = "NOT_ESCROWED"
	ComputerSecurityBootstrapTokenEscrowedStatusNotSupported ComputerSecurityBootstrapTokenEscrowedStatus = "NOT_SUPPORTED"
)

ComputerSecurityBootstrapTokenEscrowedStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityBootstrapTokenEscrowedStatusValues 

func ComputerSecurityBootstrapTokenEscrowedStatusValues() []ComputerSecurityBootstrapTokenEscrowedStatus

ComputerSecurityBootstrapTokenEscrowedStatusValues returns every value the Jamf API accepts for ComputerSecurityBootstrapTokenEscrowedStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityCreate 

type ComputerSecurityCreate struct {
	ActivationLockEnabled *bool `json:"activationLockEnabled,omitempty"`
	// Allowed values: see the ComputerSecurityCreateExternalBootLevel constants.
	ExternalBootLevel *string `json:"externalBootLevel,omitempty"`
	FirewallEnabled   *bool   `json:"firewallEnabled,omitempty"`
	// Allowed values: see the ComputerSecurityCreateGatekeeperStatus constants.
	GatekeeperStatus    *string `json:"gatekeeperStatus,omitempty"`
	RecoveryLockEnabled *bool   `json:"recoveryLockEnabled,omitempty"`
	// Allowed values: see the ComputerSecurityCreateSecureBootLevel constants.
	SecureBootLevel *string `json:"secureBootLevel,omitempty"`
	// Allowed values: see the ComputerSecurityCreateSipStatus constants.
	SipStatus       *string `json:"sipStatus,omitempty"`
	XprotectVersion *string `json:"xprotectVersion,omitempty"`
}

ComputerSecurityCreate represents a computer security create.

type ComputerSecurityCreateExternalBootLevel 

type ComputerSecurityCreateExternalBootLevel = string

ComputerSecurityCreateExternalBootLevel is the set of values accepted by ComputerSecurityCreate.ExternalBootLevel. 

const (
	ComputerSecurityCreateExternalBootLevelAllowBootingFromExternalMedia    ComputerSecurityCreateExternalBootLevel = "ALLOW_BOOTING_FROM_EXTERNAL_MEDIA"
	ComputerSecurityCreateExternalBootLevelDisallowBootingFromExternalMedia ComputerSecurityCreateExternalBootLevel = "DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA"
	ComputerSecurityCreateExternalBootLevelNotSupported                     ComputerSecurityCreateExternalBootLevel = "NOT_SUPPORTED"
	ComputerSecurityCreateExternalBootLevelUnknown                          ComputerSecurityCreateExternalBootLevel = "UNKNOWN"
)

ComputerSecurityCreateExternalBootLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityCreateExternalBootLevelValues 

func ComputerSecurityCreateExternalBootLevelValues() []ComputerSecurityCreateExternalBootLevel

ComputerSecurityCreateExternalBootLevelValues returns every value the Jamf API accepts for ComputerSecurityCreateExternalBootLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityCreateGatekeeperStatus 

type ComputerSecurityCreateGatekeeperStatus = string

ComputerSecurityCreateGatekeeperStatus is the set of values accepted by ComputerSecurityCreate.GatekeeperStatus. 

const (
	ComputerSecurityCreateGatekeeperStatusNotCollected                    ComputerSecurityCreateGatekeeperStatus = "NOT_COLLECTED"
	ComputerSecurityCreateGatekeeperStatusDisabled                        ComputerSecurityCreateGatekeeperStatus = "DISABLED"
	ComputerSecurityCreateGatekeeperStatusAppStoreAndIdentifiedDevelopers ComputerSecurityCreateGatekeeperStatus = "APP_STORE_AND_IDENTIFIED_DEVELOPERS"
	ComputerSecurityCreateGatekeeperStatusAppStore                        ComputerSecurityCreateGatekeeperStatus = "APP_STORE"
)

ComputerSecurityCreateGatekeeperStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityCreateGatekeeperStatusValues 

func ComputerSecurityCreateGatekeeperStatusValues() []ComputerSecurityCreateGatekeeperStatus

ComputerSecurityCreateGatekeeperStatusValues returns every value the Jamf API accepts for ComputerSecurityCreateGatekeeperStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityCreateSecureBootLevel 

type ComputerSecurityCreateSecureBootLevel = string

ComputerSecurityCreateSecureBootLevel is the set of values accepted by ComputerSecurityCreate.SecureBootLevel. 

const (
	ComputerSecurityCreateSecureBootLevelNoSecurity     ComputerSecurityCreateSecureBootLevel = "NO_SECURITY"
	ComputerSecurityCreateSecureBootLevelMediumSecurity ComputerSecurityCreateSecureBootLevel = "MEDIUM_SECURITY"
	ComputerSecurityCreateSecureBootLevelFullSecurity   ComputerSecurityCreateSecureBootLevel = "FULL_SECURITY"
	ComputerSecurityCreateSecureBootLevelNotSupported   ComputerSecurityCreateSecureBootLevel = "NOT_SUPPORTED"
	ComputerSecurityCreateSecureBootLevelUnknown        ComputerSecurityCreateSecureBootLevel = "UNKNOWN"
)

ComputerSecurityCreateSecureBootLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityCreateSecureBootLevelValues 

func ComputerSecurityCreateSecureBootLevelValues() []ComputerSecurityCreateSecureBootLevel

ComputerSecurityCreateSecureBootLevelValues returns every value the Jamf API accepts for ComputerSecurityCreateSecureBootLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityCreateSipStatus 

type ComputerSecurityCreateSipStatus = string

ComputerSecurityCreateSipStatus is the set of values accepted by ComputerSecurityCreate.SipStatus. 

const (
	ComputerSecurityCreateSipStatusNotCollected ComputerSecurityCreateSipStatus = "NOT_COLLECTED"
	ComputerSecurityCreateSipStatusNotAvailable ComputerSecurityCreateSipStatus = "NOT_AVAILABLE"
	ComputerSecurityCreateSipStatusDisabled     ComputerSecurityCreateSipStatus = "DISABLED"
	ComputerSecurityCreateSipStatusEnabled      ComputerSecurityCreateSipStatus = "ENABLED"
)

ComputerSecurityCreateSipStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityCreateSipStatusValues 

func ComputerSecurityCreateSipStatusValues() []ComputerSecurityCreateSipStatus

ComputerSecurityCreateSipStatusValues returns every value the Jamf API accepts for ComputerSecurityCreateSipStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityExternalBootLevel 

type ComputerSecurityExternalBootLevel = string

ComputerSecurityExternalBootLevel is the set of values accepted by ComputerSecurity.ExternalBootLevel. 

const (
	ComputerSecurityExternalBootLevelAllowBootingFromExternalMedia    ComputerSecurityExternalBootLevel = "ALLOW_BOOTING_FROM_EXTERNAL_MEDIA"
	ComputerSecurityExternalBootLevelDisallowBootingFromExternalMedia ComputerSecurityExternalBootLevel = "DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA"
	ComputerSecurityExternalBootLevelNotSupported                     ComputerSecurityExternalBootLevel = "NOT_SUPPORTED"
	ComputerSecurityExternalBootLevelUnknown                          ComputerSecurityExternalBootLevel = "UNKNOWN"
)

ComputerSecurityExternalBootLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityExternalBootLevelValues 

func ComputerSecurityExternalBootLevelValues() []ComputerSecurityExternalBootLevel

ComputerSecurityExternalBootLevelValues returns every value the Jamf API accepts for ComputerSecurityExternalBootLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecurityGatekeeperStatus 

type ComputerSecurityGatekeeperStatus = string

ComputerSecurityGatekeeperStatus is the set of values accepted by ComputerSecurity.GatekeeperStatus. 

const (
	ComputerSecurityGatekeeperStatusNotCollected                    ComputerSecurityGatekeeperStatus = "NOT_COLLECTED"
	ComputerSecurityGatekeeperStatusDisabled                        ComputerSecurityGatekeeperStatus = "DISABLED"
	ComputerSecurityGatekeeperStatusAppStoreAndIdentifiedDevelopers ComputerSecurityGatekeeperStatus = "APP_STORE_AND_IDENTIFIED_DEVELOPERS"
	ComputerSecurityGatekeeperStatusAppStore                        ComputerSecurityGatekeeperStatus = "APP_STORE"
)

ComputerSecurityGatekeeperStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecurityGatekeeperStatusValues 

func ComputerSecurityGatekeeperStatusValues() []ComputerSecurityGatekeeperStatus

ComputerSecurityGatekeeperStatusValues returns every value the Jamf API accepts for ComputerSecurityGatekeeperStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecuritySecureBootLevel 

type ComputerSecuritySecureBootLevel = string

ComputerSecuritySecureBootLevel is the set of values accepted by ComputerSecurity.SecureBootLevel. 

const (
	ComputerSecuritySecureBootLevelNoSecurity     ComputerSecuritySecureBootLevel = "NO_SECURITY"
	ComputerSecuritySecureBootLevelMediumSecurity ComputerSecuritySecureBootLevel = "MEDIUM_SECURITY"
	ComputerSecuritySecureBootLevelFullSecurity   ComputerSecuritySecureBootLevel = "FULL_SECURITY"
	ComputerSecuritySecureBootLevelNotSupported   ComputerSecuritySecureBootLevel = "NOT_SUPPORTED"
	ComputerSecuritySecureBootLevelUnknown        ComputerSecuritySecureBootLevel = "UNKNOWN"
)

ComputerSecuritySecureBootLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecuritySecureBootLevelValues 

func ComputerSecuritySecureBootLevelValues() []ComputerSecuritySecureBootLevel

ComputerSecuritySecureBootLevelValues returns every value the Jamf API accepts for ComputerSecuritySecureBootLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSecuritySipStatus 

type ComputerSecuritySipStatus = string

ComputerSecuritySipStatus is the set of values accepted by ComputerSecurity.SipStatus. 

const (
	ComputerSecuritySipStatusNotCollected ComputerSecuritySipStatus = "NOT_COLLECTED"
	ComputerSecuritySipStatusNotAvailable ComputerSecuritySipStatus = "NOT_AVAILABLE"
	ComputerSecuritySipStatusDisabled     ComputerSecuritySipStatus = "DISABLED"
	ComputerSecuritySipStatusEnabled      ComputerSecuritySipStatus = "ENABLED"
)

ComputerSecuritySipStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSecuritySipStatusValues 

func ComputerSecuritySipStatusValues() []ComputerSecuritySipStatus

ComputerSecuritySipStatusValues returns every value the Jamf API accepts for ComputerSecuritySipStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerService 

type ComputerService struct {
	Name string `json:"name"`
}

ComputerService represents a computer service.

type ComputerServiceCreate 

type ComputerServiceCreate struct {
	Name *string `json:"name,omitempty"`
}

ComputerServiceCreate represents a computer service create.

type ComputerSite 

type ComputerSite struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

ComputerSite represents a computer site.

type ComputerSmartGroupCriteriaV2 

type ComputerSmartGroupCriteriaV2 struct {
	// Whether this criterion should be ANDed or ORed with the previous criterion. Must be exactly "AND" or
	// "OR" (case-insensitive input accepted, stored as lowercase).
	// Allowed values: see the ComputerSmartGroupCriteriaV2AndOr constants.
	AndOr string `json:"andOr"`
	// Whether to add a closing parenthesis after this criterion.
	ClosingParen *bool `json:"closingParen,omitempty"`
	// The field to search on (e.g., Operating System Version, Computer Name, etc.).
	Name string `json:"name"`
	// Whether to add an opening parenthesis before this criterion.
	OpeningParen *bool `json:"openingParen,omitempty"`
	// The priority order of this criterion (must start at 0 and increment by 1 per new criteria).
	Priority int `json:"priority"`
	// The type of search to perform (e.g., is, is not, like, greater than or equal, etc.).
	SearchType string `json:"searchType"`
	// The value to search for.
	Value string `json:"value"`
}

ComputerSmartGroupCriteriaV2 represents a computer smart group criteria v2.

type ComputerSmartGroupCriteriaV2AndOr 

type ComputerSmartGroupCriteriaV2AndOr = string

ComputerSmartGroupCriteriaV2AndOr is the set of values accepted by ComputerSmartGroupCriteriaV2.AndOr. 

const (
	ComputerSmartGroupCriteriaV2AndOrAnd ComputerSmartGroupCriteriaV2AndOr = "and"
	ComputerSmartGroupCriteriaV2AndOrOr  ComputerSmartGroupCriteriaV2AndOr = "or"
)

ComputerSmartGroupCriteriaV2AndOr values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ComputerSmartGroupCriteriaV2AndOrValues 

func ComputerSmartGroupCriteriaV2AndOrValues() []ComputerSmartGroupCriteriaV2AndOr

ComputerSmartGroupCriteriaV2AndOrValues returns every value the Jamf API accepts for ComputerSmartGroupCriteriaV2AndOr, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ComputerSoftwareUpdate 

type ComputerSoftwareUpdate struct {
	Name        string `json:"name"`
	PackageName string `json:"packageName"`
	Version     string `json:"version"`
}

ComputerSoftwareUpdate represents a computer software update.

type ComputerSoftwareUpdateCreate 

type ComputerSoftwareUpdateCreate struct {
	Name        *string `json:"name,omitempty"`
	PackageName *string `json:"packageName,omitempty"`
	Version     *string `json:"version,omitempty"`
}

ComputerSoftwareUpdateCreate represents a computer software update create.

type ComputerStorage 

type ComputerStorage struct {
	BootDriveAvailableSpaceMegabytes int64          `json:"bootDriveAvailableSpaceMegabytes"`
	Disks                            []ComputerDisk `json:"disks"`
}

ComputerStorage represents a computer storage.

type ComputerStorageCreate 

type ComputerStorageCreate struct {
	Disks *[]ComputerDiskCreate `json:"disks,omitempty"`
}

ComputerStorageCreate represents a computer storage create.

type ComputerUserAndLocation 

type ComputerUserAndLocation struct {
	BuildingID          *string                       `json:"buildingId,omitempty"`
	DepartmentID        *string                       `json:"departmentId,omitempty"`
	Email               *string                       `json:"email,omitempty"`
	ExtensionAttributes *[]ComputerExtensionAttribute `json:"extensionAttributes,omitempty"`
	Phone               *string                       `json:"phone,omitempty"`
	Position            *string                       `json:"position,omitempty"`
	Realname            *string                       `json:"realname,omitempty"`
	Room                *string                       `json:"room,omitempty"`
	Username            *string                       `json:"username,omitempty"`
}

ComputerUserAndLocation represents a computer user and location.

type ComputerUserAndLocationCreate 

type ComputerUserAndLocationCreate struct {
	BuildingID   *string `json:"buildingId,omitempty"`
	DepartmentID *string `json:"departmentId,omitempty"`
	Email        *string `json:"email,omitempty"`
	Phone        *string `json:"phone,omitempty"`
	Position     *string `json:"position,omitempty"`
	Realname     *string `json:"realname,omitempty"`
	Room         *string `json:"room,omitempty"`
	Username     *string `json:"username,omitempty"`
}

ComputerUserAndLocationCreate represents a computer user and location create.

type ComputerUserManagementInfo 

type ComputerUserManagementInfo struct {
	CapableUser  string `json:"capableUser"`
	ManagementID string `json:"managementId"`
}

ComputerUserManagementInfo represents a computer user management info.

type ComputersSearchResults 

type ComputersSearchResults struct {
	Results    []ComputerOverview `json:"results"`
	TotalCount int                `json:"totalCount"`
}

ComputersSearchResults represents a computers search results.

type ConfigurationProfile 

type ConfigurationProfile struct {
	DisplayName string `json:"displayName"`
	Identifier  string `json:"identifier"`
	UUID        string `json:"uuid"`
	Version     string `json:"version"`
}

ConfigurationProfile represents a configuration profile.

type ConfigurationSearchResults 

type ConfigurationSearchResults struct {
	Results    []CloudIDPCommonResponse `json:"results"`
	TotalCount int                      `json:"totalCount"`
}

ConfigurationSearchResults A list with Cloud Identity Providers informations about configurations.

type ConnectionConfigurationCandidateRequest 

type ConnectionConfigurationCandidateRequest struct {
	// Name for Team Viewer Connection Configuration.
	DisplayName string `json:"displayName"`
	// Defines the intent to enable or disable Team Viewer connection.
	Enabled bool `json:"enabled"`
	// Token which is used for connecting to Team Viewer.
	ScriptToken string `json:"scriptToken"`
	// Number of minutes before the session expires.
	SessionTimeout int `json:"sessionTimeout"`
	// An identifier of a site which Team Viewer Remote Administration will be configured on.
	SiteID string `json:"siteId"`
}

ConnectionConfigurationCandidateRequest Request that creates configuration and initialize connection between Jamf Pro and Team Viewer.

type ConnectionConfigurationResponse 

type ConnectionConfigurationResponse struct {
	// Name for Team Viewer Connection Configuration.
	DisplayName string `json:"displayName"`
	// Describes if Team Viewer connection is enabled or disabled.
	Enabled bool `json:"enabled"`
	// An identifier of connection configuration for Team Viewer Remote Administration.
	ID string `json:"id"`
	// Number of minutes before the session expires.
	SessionTimeout *int `json:"sessionTimeout,omitempty"`
	// An identifier of a site which Team Viewer Remote Administration is configured on.
	SiteID string `json:"siteId"`
}

ConnectionConfigurationResponse Response that contains information about connection configuration for Team Viewer.

type ConnectionConfigurationStatusResponse 

type ConnectionConfigurationStatusResponse struct {
	// connection configuration status for Team Viewer.
	ConnectionVerificationResult string `json:"connectionVerificationResult"`
}

ConnectionConfigurationStatusResponse Response that contains connection configuration status for Team Viewer.

type ConnectionConfigurationUpdateRequest 

type ConnectionConfigurationUpdateRequest struct {
	// Name for Team Viewer Connection Configuration.
	DisplayName *string `json:"displayName,omitempty"`
	// Defines the intent to enable or disable Team Viewer connection.
	Enabled *bool `json:"enabled,omitempty"`
	// Number of minutes before the session expires.
	SessionTimeout *int `json:"sessionTimeout,omitempty"`
	// Script token for Team Viewer Connection Configuration.
	Token *string `json:"token,omitempty"`
}

ConnectionConfigurationUpdateRequest Request that updates configuration connection between Jamf Pro and Team Viewer.

type Country 

type Country struct {
	Code string `json:"code"`
	Name string `json:"name"`
}

Country represents a country.

type CountryCodes 

type CountryCodes struct {
	CountryCodes []Country `json:"countryCodes"`
}

CountryCodes represents a country codes.

type CreatePathV2 

type CreatePathV2 struct {
	Path string `json:"path"`
	// Allowed values: see the CreatePathV2Scope constants.
	Scope string `json:"scope"`
}

CreatePathV2 represents a create path v2.

type CreatePathV2Scope 

type CreatePathV2Scope = string

CreatePathV2Scope is the set of values accepted by CreatePathV2.Scope. 

const (
	CreatePathV2ScopeApp CreatePathV2Scope = "APP"
)

CreatePathV2Scope values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func CreatePathV2ScopeValues 

func CreatePathV2ScopeValues() []CreatePathV2Scope

CreatePathV2ScopeValues returns every value the Jamf API accepts for CreatePathV2Scope, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type Credentials 

type Credentials struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	AccessKeyID string `json:"accessKeyID"`
	BucketName  string `json:"bucketName"`
	Expiration  int64  `json:"expiration"`
	Path        string `json:"path"`
	Region      string `json:"region"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	SecretAccessKey string `json:"secretAccessKey"`
	SessionToken    string `json:"sessionToken"`
	UUID            string `json:"uuid"`
}

Credentials represents a credentials.

type CsaTenantIDInfo 

type CsaTenantIDInfo struct {
	// The tenant ID.
	TenantID *string `json:"tenantId,omitempty"`
}

CsaTenantIDInfo represents a csa tenant i d info.

type CsaToken 

type CsaToken struct {
	LegacyJamfSalesforceIds []string `json:"legacyJamfSalesforceIds"`
	RefreshExpiration       int64    `json:"refreshExpiration"`
	Scopes                  []string `json:"scopes"`
	// Salesforce CRM account ID.
	Subject string `json:"subject"`
	// The tenant ID.
	TenantID *string `json:"tenantId,omitempty"`
}

CsaToken represents a csa token.

type DashboardApiError 

type DashboardApiError struct {
	Description    string `json:"description"`
	HttpStatusCode int    `json:"httpStatusCode"`
	ID             string `json:"id"`
}

DashboardApiError represents a dashboard api error.

type DashboardItem 

type DashboardItem struct {
	Details []DashboardItemDetailsItem `json:"details"`
	// Logical to decide whether widget should be enabled or disabled; i.e. Policy.
	Enabled bool               `json:"enabled"`
	Error   *DashboardApiError `json:"error,omitempty"`
	ID      string             `json:"id"`
	// Additional information such as identifiers for a specific policy within a software patch.
	Info     *string                    `json:"info,omitempty"`
	Metrics  []DashboardItemMetricsItem `json:"metrics"`
	Subtitle *string                    `json:"subtitle,omitempty"`
	Title    *string                    `json:"title,omitempty"`
}

DashboardItem represents a dashboard item.

type DashboardItemDetailsItem 

type DashboardItemDetailsItem struct {
	Label string `json:"label"`
	Value string `json:"value"`
}

DashboardItemDetailsItem Additional details that will be found in a legend of the widgets on the dashboard.

type DashboardItemMetricsItem 

type DashboardItemMetricsItem struct {
	// Logical to decide whether metric should be enabled or disabled; i.e. Policy can be at
	// Retrying-Disabled status.
	Enabled bool `json:"enabled"`
	// Allowed values: see the DashboardItemMetricsItemTag constants.
	Tag string `json:"tag"`
	// Usually a number associated with the tag; i.e. 23 Pending Computers.
	Value string `json:"value"`
}

DashboardItemMetricsItem represents a dashboard item metrics item.

type DashboardItemMetricsItemTag 

type DashboardItemMetricsItemTag = string

DashboardItemMetricsItemTag is the set of values accepted by DashboardItemMetricsItem.Tag. 

const (
	DashboardItemMetricsItemTagCompleted        DashboardItemMetricsItemTag = "Completed"
	DashboardItemMetricsItemTagRemaining        DashboardItemMetricsItemTag = "Remaining"
	DashboardItemMetricsItemTagSiteLicense      DashboardItemMetricsItemTag = "Site License"
	DashboardItemMetricsItemTagNoLicenses       DashboardItemMetricsItemTag = "No Licenses"
	DashboardItemMetricsItemTagOver             DashboardItemMetricsItemTag = "Over"
	DashboardItemMetricsItemTagFailed           DashboardItemMetricsItemTag = "Failed"
	DashboardItemMetricsItemTagRetrying         DashboardItemMetricsItemTag = "Retrying"
	DashboardItemMetricsItemTagRetryingDisabled DashboardItemMetricsItemTag = "Retrying-disabled"
	DashboardItemMetricsItemTagPending          DashboardItemMetricsItemTag = "Pending"
	DashboardItemMetricsItemTagExpiring         DashboardItemMetricsItemTag = "Expiring"
	DashboardItemMetricsItemTagActive           DashboardItemMetricsItemTag = "Active"
	DashboardItemMetricsItemTagInactive         DashboardItemMetricsItemTag = "Inactive"
	DashboardItemMetricsItemTagComputers        DashboardItemMetricsItemTag = "Computers"
	DashboardItemMetricsItemTagDevices          DashboardItemMetricsItemTag = "Devices"
	DashboardItemMetricsItemTagUsers            DashboardItemMetricsItemTag = "Users"
	DashboardItemMetricsItemTagInUse            DashboardItemMetricsItemTag = "In Use"
	DashboardItemMetricsItemTagNA               DashboardItemMetricsItemTag = "N/A"
	DashboardItemMetricsItemTagLatestVersion    DashboardItemMetricsItemTag = "Latest Version"
	DashboardItemMetricsItemTagOtherVersions    DashboardItemMetricsItemTag = "Other Versions"
)

DashboardItemMetricsItemTag values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DashboardItemMetricsItemTagValues 

func DashboardItemMetricsItemTagValues() []DashboardItemMetricsItemTag

DashboardItemMetricsItemTagValues returns every value the Jamf API accepts for DashboardItemMetricsItemTag, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DashboardObject 

type DashboardObject struct {
	Enabled  bool   `json:"enabled"`
	ObjectID string `json:"objectId"`
	// Allowed values: see the DashboardObjectObjectType constants.
	ObjectType string `json:"objectType"`
}

DashboardObject Dashboard object consisting of object type, object's ID, and whether it should display on the Jamf Pro dashboard.

type DashboardObjectObjectType 

type DashboardObjectObjectType = string

DashboardObjectObjectType is the set of values accepted by DashboardObject.ObjectType. 

const (
	DashboardObjectObjectTypeTypeIosConfigurationProfile         DashboardObjectObjectType = "TYPE_IOS_CONFIGURATION_PROFILE"
	DashboardObjectObjectTypeTypeMacosConfigurationProfile       DashboardObjectObjectType = "TYPE_MACOS_CONFIGURATION_PROFILE"
	DashboardObjectObjectTypeTypeUserGroup                       DashboardObjectObjectType = "TYPE_USER_GROUP"
	DashboardObjectObjectTypeTypeLicensedSoftware                DashboardObjectObjectType = "TYPE_LICENSED_SOFTWARE"
	DashboardObjectObjectTypeTypePatchSoftwareTitleConfiguration DashboardObjectObjectType = "TYPE_PATCH_SOFTWARE_TITLE_CONFIGURATION"
	DashboardObjectObjectTypeTypePatchPolicy                     DashboardObjectObjectType = "TYPE_PATCH_POLICY"
	DashboardObjectObjectTypeTypePolicy                          DashboardObjectObjectType = "TYPE_POLICY"
	DashboardObjectObjectTypeTypeComputerGroup                   DashboardObjectObjectType = "TYPE_COMPUTER_GROUP"
	DashboardObjectObjectTypeTypeMobileDeviceGroup               DashboardObjectObjectType = "TYPE_MOBILE_DEVICE_GROUP"
	DashboardObjectObjectTypeTypeDigicertPkiManagerSettings      DashboardObjectObjectType = "TYPE_DIGICERT_PKI_MANAGER_SETTINGS"
)

DashboardObjectObjectType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DashboardObjectObjectTypeValues 

func DashboardObjectObjectTypeValues() []DashboardObjectObjectType

DashboardObjectObjectTypeValues returns every value the Jamf API accepts for DashboardObjectObjectType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DashboardSetup 

type DashboardSetup struct {
	FeatureOptions   *DashboardSetupFeatureOptions   `json:"featureOptions,omitempty"`
	SetupTaskOptions *DashboardSetupSetupTaskOptions `json:"setupTaskOptions,omitempty"`
}

DashboardSetup Response object that has lists of information for widgets, and what setup tasks to display.

type DashboardSetupFeatureOptions 

type DashboardSetupFeatureOptions struct {
	// Allowed values: see the DashboardSetupFeatureOptionsFeature constants.
	Feature string `json:"feature"`
}

DashboardSetupFeatureOptions represents a dashboard setup feature options.

type DashboardSetupFeatureOptionsFeature 

type DashboardSetupFeatureOptionsFeature = string

DashboardSetupFeatureOptionsFeature is the set of values accepted by DashboardSetupFeatureOptions.Feature. 

const (
	DashboardSetupFeatureOptionsFeatureTypeIosConfigurationProfile         DashboardSetupFeatureOptionsFeature = "TYPE_IOS_CONFIGURATION_PROFILE"
	DashboardSetupFeatureOptionsFeatureTypeMacosConfigurationProfile       DashboardSetupFeatureOptionsFeature = "TYPE_MACOS_CONFIGURATION_PROFILE"
	DashboardSetupFeatureOptionsFeatureTypeUserGroup                       DashboardSetupFeatureOptionsFeature = "TYPE_USER_GROUP"
	DashboardSetupFeatureOptionsFeatureTypeLicensedSoftware                DashboardSetupFeatureOptionsFeature = "TYPE_LICENSED_SOFTWARE"
	DashboardSetupFeatureOptionsFeatureTypePatchSoftwareTitleConfiguration DashboardSetupFeatureOptionsFeature = "TYPE_PATCH_SOFTWARE_TITLE_CONFIGURATION"
	DashboardSetupFeatureOptionsFeatureTypePatchPolicy                     DashboardSetupFeatureOptionsFeature = "TYPE_PATCH_POLICY"
	DashboardSetupFeatureOptionsFeatureTypePolicy                          DashboardSetupFeatureOptionsFeature = "TYPE_POLICY"
	DashboardSetupFeatureOptionsFeatureTypeComputerGroup                   DashboardSetupFeatureOptionsFeature = "TYPE_COMPUTER_GROUP"
	DashboardSetupFeatureOptionsFeatureTypeMobileDeviceGroup               DashboardSetupFeatureOptionsFeature = "TYPE_MOBILE_DEVICE_GROUP"
	DashboardSetupFeatureOptionsFeatureTypeDigicertPkiManagerSettings      DashboardSetupFeatureOptionsFeature = "TYPE_DIGICERT_PKI_MANAGER_SETTINGS"
)

DashboardSetupFeatureOptionsFeature values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DashboardSetupFeatureOptionsFeatureValues 

func DashboardSetupFeatureOptionsFeatureValues() []DashboardSetupFeatureOptionsFeature

DashboardSetupFeatureOptionsFeatureValues returns every value the Jamf API accepts for DashboardSetupFeatureOptionsFeature, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DashboardSetupSetupTaskOptions 

type DashboardSetupSetupTaskOptions struct {
	// Allowed values: see the DashboardSetupSetupTaskOptionsSetupTask constants.
	SetupTask string `json:"setupTask"`
}

DashboardSetupSetupTaskOptions represents a dashboard setup setup task options.

type DashboardSetupSetupTaskOptionsSetupTask 

type DashboardSetupSetupTaskOptionsSetupTask = string

DashboardSetupSetupTaskOptionsSetupTask is the set of values accepted by DashboardSetupSetupTaskOptions.SetupTask. 

const (
	DashboardSetupSetupTaskOptionsSetupTaskTypeLdapServerSetupTask               DashboardSetupSetupTaskOptionsSetupTask = "TYPE_LDAP_SERVER_SETUP_TASK"
	DashboardSetupSetupTaskOptionsSetupTaskTypePushNotificationSettingsSetupTask DashboardSetupSetupTaskOptionsSetupTask = "TYPE_PUSH_NOTIFICATION_SETTINGS_SETUP_TASK"
	DashboardSetupSetupTaskOptionsSetupTaskTypeSmtpServerSetupTask               DashboardSetupSetupTaskOptionsSetupTask = "TYPE_SMTP_SERVER_SETUP_TASK"
	DashboardSetupSetupTaskOptionsSetupTaskTypeSslSetupTask                      DashboardSetupSetupTaskOptionsSetupTask = "TYPE_SSL_SETUP_TASK"
)

DashboardSetupSetupTaskOptionsSetupTask values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DashboardSetupSetupTaskOptionsSetupTaskValues 

func DashboardSetupSetupTaskOptionsSetupTaskValues() []DashboardSetupSetupTaskOptionsSetupTask

DashboardSetupSetupTaskOptionsSetupTaskValues returns every value the Jamf API accepts for DashboardSetupSetupTaskOptionsSetupTask, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DashboardSetupTask 

type DashboardSetupTask struct {
	Available bool               `json:"available"`
	Error     *DashboardApiError `json:"error,omitempty"`
}

DashboardSetupTask represents a dashboard setup task.

type Department 

type Department struct {
	ID   *string `json:"id,omitempty"`
	Name string  `json:"name"`
}

Department represents a department.

type DepartmentsSearchResults 

type DepartmentsSearchResults struct {
	Results    []Department `json:"results"`
	TotalCount int          `json:"totalCount"`
}

DepartmentsSearchResults represents a departments search results.

type DependencyObjectResults 

type DependencyObjectResults struct {
	Results    []DependencyObjectResultsResultsItem `json:"results"`
	TotalCount int                                  `json:"totalCount"`
}

DependencyObjectResults represents a dependency object results.

type DependencyObjectResultsResultsItem 

type DependencyObjectResultsResultsItem struct {
	// Link to dependent object or to page with list of dependent objects.
	Hyperlink string `json:"hyperlink"`
	// Unique Id for Dependency Object.
	ID int `json:"id"`
	// Name of the dependent object.
	IdentifiableName string `json:"identifiableName"`
	// Name of localization which display dependent object.
	NameLocalization string `json:"nameLocalization"`
	// Object Type Id of the dependency object.
	ObjectID int `json:"objectId"`
}

DependencyObjectResultsResultsItem represents a dependency object results results item.

type DeploymentComputer 

type DeploymentComputer struct {
	// Human readable name of the computer.
	ComputerName string `json:"computerName"`
	// Optional error code describing deployment failure.
	Error string `json:"error"`
	// ID of computer.
	ID string `json:"id"`
	// Is it possible to retry app installation for the current computer.
	Retryable bool `json:"retryable"`
	// Current status of deploying app on computer.
	// Allowed values: see the DeploymentComputerStatus constants.
	Status string `json:"status"`
}

DeploymentComputer represents a deployment computer.

type DeploymentComputerStatus 

type DeploymentComputerStatus = string

DeploymentComputerStatus is the set of values accepted by DeploymentComputer.Status. 

const (
	DeploymentComputerStatusUnqualified DeploymentComputerStatus = "UNQUALIFIED"
	DeploymentComputerStatusAvailable   DeploymentComputerStatus = "AVAILABLE"
	DeploymentComputerStatusInProgress  DeploymentComputerStatus = "IN_PROGRESS"
	DeploymentComputerStatusInstalled   DeploymentComputerStatus = "INSTALLED"
	DeploymentComputerStatusFailed      DeploymentComputerStatus = "FAILED"
)

DeploymentComputerStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DeploymentComputerStatusValues 

func DeploymentComputerStatusValues() []DeploymentComputerStatus

DeploymentComputerStatusValues returns every value the Jamf API accepts for DeploymentComputerStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DeploymentComputersResult 

type DeploymentComputersResult struct {
	Results    []DeploymentComputer `json:"results"`
	TotalCount int                  `json:"totalCount"`
}

DeploymentComputersResult represents a deployment computers result.

type DeploymentTask 

type DeploymentTask struct {
	ComputerID   *json.Number `json:"computerId,omitempty"`
	ComputerName string       `json:"computerName"`
	ID           *json.Number `json:"id,omitempty"`
	// Status of this Jamf Connect deployment task. "Command" below refers to an
	// `InstallEnterpriseApplication` command. Tasks that are not finished (i.e., `COMPLETE` or `GAVE_UP`)
	// are evaluated once every thirty minutes, so the status value for a device may lag behind a
	// successful Jamf Connect package install up to thirty minutes. * `COMMAND_QUEUED` - command has been
	// queued * `NO_COMMAND` - command has not yet been queued * `PENDING_MANIFEST` - task is waiting to
	// obtain a valid package manifest before a command can be queued * `COMPLETE` - command has been
	// completed successfully * `GAVE_UP` - the command failed with an error or the device did not process
	// it in a reasonable amount of time * `UNKNOWN` - unknown; tasks in this state will be evaluated.
	// Allowed values: see the DeploymentTaskStatus constants.
	Status  string     `json:"status"`
	Updated *time.Time `json:"updated,omitempty"`
	Version string     `json:"version"`
}

DeploymentTask represents a deployment task.

type DeploymentTaskSearchResults 

type DeploymentTaskSearchResults struct {
	Results    []DeploymentTask `json:"results"`
	TotalCount int              `json:"totalCount"`
}

DeploymentTaskSearchResults represents a deployment task search results.

type DeploymentTaskStatus 

type DeploymentTaskStatus = string

DeploymentTaskStatus is the set of values accepted by DeploymentTask.Status. 

const (
	DeploymentTaskStatusCommandQueued   DeploymentTaskStatus = "COMMAND_QUEUED"
	DeploymentTaskStatusNoCommand       DeploymentTaskStatus = "NO_COMMAND"
	DeploymentTaskStatusPendingManifest DeploymentTaskStatus = "PENDING_MANIFEST"
	DeploymentTaskStatusComplete        DeploymentTaskStatus = "COMPLETE"
	DeploymentTaskStatusGaveUp          DeploymentTaskStatus = "GAVE_UP"
	DeploymentTaskStatusUnknown         DeploymentTaskStatus = "UNKNOWN"
)

DeploymentTaskStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DeploymentTaskStatusValues 

func DeploymentTaskStatusValues() []DeploymentTaskStatus

DeploymentTaskStatusValues returns every value the Jamf API accepts for DeploymentTaskStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DetailsV2 

type DetailsV2 struct {
	Applications []MobileDeviceApplication  `json:"applications"`
	Attachments  []MobileDeviceAttachmentV2 `json:"attachments"`
	AvailableMb  int                        `json:"availableMb"`
	// - NON_GENUINE: The battery isn’t a genuine Apple battery. - NORMAL: The battery is operating
	// normally. - SERVICE_RECOMMENDED: The system recommends battery service. - UNKNOWN: The system
	// couldn’t determine battery health information. - UNSUPPORTED: The device doesn’t support battery
	// health reporting.
	// Allowed values: see the DetailsV2BatteryHealth constants.
	BatteryHealth               string                             `json:"batteryHealth"`
	BatteryLevel                int                                `json:"batteryLevel"`
	BleCapable                  bool                               `json:"bleCapable"`
	CapacityMb                  int                                `json:"capacityMb"`
	Certificates                []MobileDeviceCertificateV2        `json:"certificates"`
	CloudBackupEnabled          bool                               `json:"cloudBackupEnabled"`
	Computer                    *IDAndNameV2                       `json:"computer,omitempty"`
	ConfigurationProfiles       []ConfigurationProfile             `json:"configurationProfiles"`
	DeviceLocatorServiceEnabled bool                               `json:"deviceLocatorServiceEnabled"`
	DoNotDisturbEnabled         bool                               `json:"doNotDisturbEnabled"`
	Ebooks                      []MobileDeviceEbook                `json:"ebooks"`
	ITunesStoreAccountActive    bool                               `json:"iTunesStoreAccountActive"`
	LastBackupTimestamp         *time.Time                         `json:"lastBackupTimestamp,omitempty"`
	LastCloudBackupTimestamp    *time.Time                         `json:"lastCloudBackupTimestamp,omitempty"`
	LocationServicesEnabled     bool                               `json:"locationServicesEnabled"`
	MDMCapableUsers             []MobileDeviceMDMCapableUser       `json:"mdmCapableUsers"`
	Model                       string                             `json:"model"`
	ModelIdentifier             string                             `json:"modelIdentifier"`
	ModelNumber                 string                             `json:"modelNumber"`
	Network                     *NetworkV2                         `json:"network,omitempty"`
	PercentageUsed              int                                `json:"percentageUsed"`
	ProvisioningProfiles        []MobileDeviceProvisioningProfiles `json:"provisioningProfiles"`
	Purchasing                  *PurchasingV2                      `json:"purchasing,omitempty"`
	// Whether Return to Service is enabled.
	ReturnToServiceEnabled bool                               `json:"returnToServiceEnabled"`
	Security               *SecurityV2                        `json:"security,omitempty"`
	ServiceSubscriptions   []MobileDeviceServiceSubscriptions `json:"serviceSubscriptions"`
	Shared                 bool                               `json:"shared"`
	Supervised             bool                               `json:"supervised"`
	// System health status for device components. Reported for iOS devices.
	SystemHealth *SystemHealthV2 `json:"systemHealth,omitempty"`
	UnlockToken  string          `json:"unlockToken"`
}

DetailsV2 will be populated if the type is ios or visionos.

type DetailsV2BatteryHealth 

type DetailsV2BatteryHealth = string

DetailsV2BatteryHealth is the set of values accepted by DetailsV2.BatteryHealth. 

const (
	DetailsV2BatteryHealthNonGenuine         DetailsV2BatteryHealth = "NON_GENUINE"
	DetailsV2BatteryHealthNormal             DetailsV2BatteryHealth = "NORMAL"
	DetailsV2BatteryHealthServiceRecommended DetailsV2BatteryHealth = "SERVICE_RECOMMENDED"
	DetailsV2BatteryHealthUnknown            DetailsV2BatteryHealth = "UNKNOWN"
	DetailsV2BatteryHealthUnsupported        DetailsV2BatteryHealth = "UNSUPPORTED"
)

DetailsV2BatteryHealth values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DetailsV2BatteryHealthValues 

func DetailsV2BatteryHealthValues() []DetailsV2BatteryHealth

DetailsV2BatteryHealthValues returns every value the Jamf API accepts for DetailsV2BatteryHealth, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DeviceCommonDetails 

type DeviceCommonDetails struct {
	// The client management ID associated with this device.
	ClientManagementID string `json:"clientManagementId"`
	// Unique identifier for the device common details record.
	ID string `json:"id"`
	// URL for MDM check-in.
	MDMCheckinURL *string `json:"mdmCheckinUrl,omitempty"`
	// Whether the MDM profile needs renewal due to CA renewal.
	MDMProfileNeedsRenewalDueToCaRenewed bool `json:"mdmProfileNeedsRenewalDueToCaRenewed"`
	// Whether the MDM profile needs renewal due to expiring device identity certificate.
	MDMProfileNeedsRenewalDueToDeviceIdentityCertExpiring bool `json:"mdmProfileNeedsRenewalDueToDeviceIdentityCertExpiring"`
	// URL for MDM server.
	MDMServerURL *string `json:"mdmServerUrl,omitempty"`
	// Timestamp when MDM profile renewal started (ISO 8601 format).
	RenewMDMProfileStartDate *time.Time `json:"renewMdmProfileStartDate,omitempty"`
}

DeviceCommonDetails represents a device common details.

type DeviceCommonDetailsRequest 

type DeviceCommonDetailsRequest struct {
	// The client management ID associated with this device (required).
	ClientManagementID string `json:"clientManagementId"`
	// URL for MDM check-in.
	MDMCheckinURL *string `json:"mdmCheckinUrl,omitempty"`
	// Whether the MDM profile needs renewal due to CA renewal.
	MDMProfileNeedsRenewalDueToCaRenewed *bool `json:"mdmProfileNeedsRenewalDueToCaRenewed,omitempty"`
	// Whether the MDM profile needs renewal due to expiring device identity certificate.
	MDMProfileNeedsRenewalDueToDeviceIdentityCertExpiring *bool `json:"mdmProfileNeedsRenewalDueToDeviceIdentityCertExpiring,omitempty"`
	// URL for MDM server.
	MDMServerURL *string `json:"mdmServerUrl,omitempty"`
	// Timestamp when MDM profile renewal started (ISO 8601 format).
	RenewMDMProfileStartDate *time.Time `json:"renewMdmProfileStartDate,omitempty"`
}

DeviceCommonDetailsRequest represents a device common details request.

type DeviceCommunicationSettings 

type DeviceCommunicationSettings struct {
	AutoRenewComputerMDMProfileWhenCaRenewed                      *bool `json:"autoRenewComputerMdmProfileWhenCaRenewed,omitempty"`
	AutoRenewComputerMDMProfileWhenDeviceIdentityCertExpiring     *bool `json:"autoRenewComputerMdmProfileWhenDeviceIdentityCertExpiring,omitempty"`
	AutoRenewMobileDeviceMDMProfileWhenCaRenewed                  *bool `json:"autoRenewMobileDeviceMdmProfileWhenCaRenewed,omitempty"`
	AutoRenewMobileDeviceMDMProfileWhenDeviceIdentityCertExpiring *bool `json:"autoRenewMobileDeviceMdmProfileWhenDeviceIdentityCertExpiring,omitempty"`
	// Allowed values: see the DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays
	// constants.
	MDMProfileComputerExpirationLimitInDays *int `json:"mdmProfileComputerExpirationLimitInDays,omitempty"`
	// Allowed values: see the DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays
	// constants.
	MDMProfileMobileDeviceExpirationLimitInDays *int `json:"mdmProfileMobileDeviceExpirationLimitInDays,omitempty"`
}

DeviceCommunicationSettings represents a device communication settings.

type DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays 

type DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays = int

DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays is the set of values accepted by DeviceCommunicationSettings.MDMProfileComputerExpirationLimitInDays. 

const (
	DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays90  DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays = 90
	DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays120 DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays = 120
	DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays180 DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays = 180
)

DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays values accepted by the Jamf API. The alias above is an int, so these constants pass to any parameter or field declared as a plain int.

func DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDaysValues 

func DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDaysValues() []DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays

DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDaysValues returns every value the Jamf API accepts for DeviceCommunicationSettingsMDMProfileComputerExpirationLimitInDays, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's int64validator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays 

type DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays = int

DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays is the set of values accepted by DeviceCommunicationSettings.MDMProfileMobileDeviceExpirationLimitInDays. 

const (
	DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays90  DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays = 90
	DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays120 DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays = 120
	DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays180 DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays = 180
)

DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays values accepted by the Jamf API. The alias above is an int, so these constants pass to any parameter or field declared as a plain int.

func DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDaysValues 

func DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDaysValues() []DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays

DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDaysValues returns every value the Jamf API accepts for DeviceCommunicationSettingsMDMProfileMobileDeviceExpirationLimitInDays, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's int64validator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DeviceComplianceInformation 

type DeviceComplianceInformation struct {
	// If device is applicable for compliance calculation.
	Applicable bool `json:"applicable"`
	// Device compliance state. Possible values are: * `UNKNOWN` for unknow compliance state, this usually
	// means that the compliance state is being calculated, * `NON_COMPLIANT` for non compliant state, *
	// `COMPLIANT` for compliant state.
	// Allowed values: see the DeviceComplianceInformationComplianceState constants.
	ComplianceState string `json:"complianceState"`
	// Name of the compliance vendor.
	ComplianceVendor string `json:"complianceVendor"`
	// Additional, compliance vendor specific device details.
	ComplianceVendorDeviceInformation *ComplianceVendorDeviceInformation `json:"complianceVendorDeviceInformation,omitempty"`
	// ID of the device.
	DeviceID string `json:"deviceId"`
}

DeviceComplianceInformation Device compliance information record.

type DeviceComplianceInformationComplianceState 

type DeviceComplianceInformationComplianceState = string

DeviceComplianceInformationComplianceState is the set of values accepted by DeviceComplianceInformation.ComplianceState. 

const (
	DeviceComplianceInformationComplianceStateUnknown      DeviceComplianceInformationComplianceState = "UNKNOWN"
	DeviceComplianceInformationComplianceStateNonCompliant DeviceComplianceInformationComplianceState = "NON_COMPLIANT"
	DeviceComplianceInformationComplianceStateCompliant    DeviceComplianceInformationComplianceState = "COMPLIANT"
)

DeviceComplianceInformationComplianceState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DeviceComplianceInformationComplianceStateValues 

func DeviceComplianceInformationComplianceStateValues() []DeviceComplianceInformationComplianceState

DeviceComplianceInformationComplianceStateValues returns every value the Jamf API accepts for DeviceComplianceInformationComplianceState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DeviceEnrollmentDevice 

type DeviceEnrollmentDevice struct {
	AssetTag                          string `json:"assetTag"`
	Color                             string `json:"color"`
	Description                       string `json:"description"`
	DeviceAssignedDate                string `json:"deviceAssignedDate"`
	DeviceEnrollmentProgramInstanceID string `json:"deviceEnrollmentProgramInstanceId"`
	ID                                string `json:"id"`
	Model                             string `json:"model"`
	PrestageID                        string `json:"prestageId"`
	ProfileAssignTime                 string `json:"profileAssignTime"`
	ProfilePushTime                   string `json:"profilePushTime"`
	// Allowed values: see the DeviceEnrollmentDeviceProfileStatus constants.
	ProfileStatus string                                `json:"profileStatus"`
	SerialNumber  string                                `json:"serialNumber"`
	SyncState     *AssignRemoveProfileResponseSyncState `json:"syncState,omitempty"`
}

DeviceEnrollmentDevice represents a device enrollment device.

type DeviceEnrollmentDeviceProfileStatus 

type DeviceEnrollmentDeviceProfileStatus = string

DeviceEnrollmentDeviceProfileStatus is the set of values accepted by DeviceEnrollmentDevice.ProfileStatus. 

const (
	DeviceEnrollmentDeviceProfileStatusEmpty    DeviceEnrollmentDeviceProfileStatus = "EMPTY"
	DeviceEnrollmentDeviceProfileStatusAssigned DeviceEnrollmentDeviceProfileStatus = "ASSIGNED"
	DeviceEnrollmentDeviceProfileStatusPushed   DeviceEnrollmentDeviceProfileStatus = "PUSHED"
	DeviceEnrollmentDeviceProfileStatusRemoved  DeviceEnrollmentDeviceProfileStatus = "REMOVED"
)

DeviceEnrollmentDeviceProfileStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DeviceEnrollmentDeviceProfileStatusValues 

func DeviceEnrollmentDeviceProfileStatusValues() []DeviceEnrollmentDeviceProfileStatus

DeviceEnrollmentDeviceProfileStatusValues returns every value the Jamf API accepts for DeviceEnrollmentDeviceProfileStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DeviceEnrollmentDeviceSearchResults 

type DeviceEnrollmentDeviceSearchResults struct {
	Results    []DeviceEnrollmentDevice `json:"results"`
	TotalCount int                      `json:"totalCount"`
}

DeviceEnrollmentDeviceSearchResults represents a device enrollment device search results.

type DeviceEnrollmentDisownBody 

type DeviceEnrollmentDisownBody struct {
	Devices *[]string `json:"devices,omitempty"`
}

DeviceEnrollmentDisownBody represents a device enrollment disown body.

type DeviceEnrollmentDisownResponse 

type DeviceEnrollmentDisownResponse struct {
	Devices map[string]string `json:"devices"`
}

DeviceEnrollmentDisownResponse represents a device enrollment disown response.

type DeviceEnrollmentInstance 

type DeviceEnrollmentInstance struct {
	AdminID               *string `json:"adminId,omitempty"`
	ID                    *string `json:"id,omitempty"`
	Name                  string  `json:"name"`
	OrgAddress            *string `json:"orgAddress,omitempty"`
	OrgEmail              *string `json:"orgEmail,omitempty"`
	OrgName               *string `json:"orgName,omitempty"`
	OrgPhone              *string `json:"orgPhone,omitempty"`
	ServerName            *string `json:"serverName,omitempty"`
	ServerUUID            *string `json:"serverUuid,omitempty"`
	SiteID                *string `json:"siteId,omitempty"`
	SupervisionIdentityID *string `json:"supervisionIdentityId,omitempty"`
	TokenExpirationDate   *string `json:"tokenExpirationDate,omitempty"`
}

DeviceEnrollmentInstance represents a device enrollment instance.

type DeviceEnrollmentInstanceSearchResults 

type DeviceEnrollmentInstanceSearchResults struct {
	Results    []DeviceEnrollmentInstance `json:"results"`
	TotalCount int                        `json:"totalCount"`
}

DeviceEnrollmentInstanceSearchResults represents a device enrollment instance search results.

type DeviceEnrollmentInstanceSyncStatus 

type DeviceEnrollmentInstanceSyncStatus struct {
	InstanceID string `json:"instanceId"`
	SyncState  string `json:"syncState"`
	Timestamp  string `json:"timestamp"`
}

DeviceEnrollmentInstanceSyncStatus represents a device enrollment instance sync status.

type DeviceEnrollmentPrestageV2 

type DeviceEnrollmentPrestageV2 struct {
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                *[]string                       `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt              string                          `json:"authenticationPrompt"`
	AutoAdvanceSetup                  bool                            `json:"autoAdvanceSetup"`
	DefaultPrestage                   bool                            `json:"defaultPrestage"`
	Department                        string                          `json:"department"`
	DeviceEnrollmentProgramInstanceID string                          `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                       string                          `json:"displayName"`
	EnableDeviceBasedActivationLock   bool                            `json:"enableDeviceBasedActivationLock"`
	EnrollmentCustomizationID         *string                         `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                  string                          `json:"enrollmentSiteId"`
	KeepExistingLocationInformation   bool                            `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership        bool                            `json:"keepExistingSiteMembership"`
	Language                          *string                         `json:"language,omitempty"`
	LocationInformation               LocationInformationV2           `json:"locationInformation"`
	Mandatory                         bool                            `json:"mandatory"`
	MDMRemovable                      bool                            `json:"mdmRemovable"`
	PreventActivationLock             bool                            `json:"preventActivationLock"`
	PurchasingInformation             PrestagePurchasingInformationV2 `json:"purchasingInformation"`
	Region                            *string                         `json:"region,omitempty"`
	RequireAuthentication             bool                            `json:"requireAuthentication"`
	SkipSetupItems                    *map[string]bool                `json:"skipSetupItems,omitempty"`
	SupportEmailAddress               string                          `json:"supportEmailAddress"`
	SupportPhoneNumber                string                          `json:"supportPhoneNumber"`
}

DeviceEnrollmentPrestageV2 represents a device enrollment prestage v2.

type DeviceEnrollmentPrestageV3 

type DeviceEnrollmentPrestageV3 struct {
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                *[]string                       `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt              string                          `json:"authenticationPrompt"`
	AutoAdvanceSetup                  bool                            `json:"autoAdvanceSetup"`
	DefaultPrestage                   bool                            `json:"defaultPrestage"`
	Department                        string                          `json:"department"`
	DeviceEnrollmentProgramInstanceID string                          `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                       string                          `json:"displayName"`
	EnableDeviceBasedActivationLock   bool                            `json:"enableDeviceBasedActivationLock"`
	EnrollmentCustomizationID         *string                         `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                  string                          `json:"enrollmentSiteId"`
	KeepExistingLocationInformation   bool                            `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership        bool                            `json:"keepExistingSiteMembership"`
	Language                          *string                         `json:"language,omitempty"`
	LocationInformation               LocationInformationV3           `json:"locationInformation"`
	Mandatory                         bool                            `json:"mandatory"`
	MDMRemovable                      bool                            `json:"mdmRemovable"`
	PreventActivationLock             bool                            `json:"preventActivationLock"`
	PurchasingInformation             PrestagePurchasingInformationV3 `json:"purchasingInformation"`
	Region                            *string                         `json:"region,omitempty"`
	RequireAuthentication             bool                            `json:"requireAuthentication"`
	SkipSetupItems                    *map[string]bool                `json:"skipSetupItems,omitempty"`
	SupportEmailAddress               string                          `json:"supportEmailAddress"`
	SupportPhoneNumber                string                          `json:"supportPhoneNumber"`
}

DeviceEnrollmentPrestageV3 represents a device enrollment prestage v3.

type DeviceEnrollmentToken 

type DeviceEnrollmentToken struct {
	// The base 64 encoded token.
	EncodedToken *[]byte `json:"encodedToken,omitempty"`
	// Optional name of the token to be saved, if no name is provided one will be auto-generated.
	TokenFileName *string `json:"tokenFileName,omitempty"`
}

DeviceEnrollmentToken represents a device enrollment token.

type DeviceGroup 

type DeviceGroup struct {
	// Group Platform ID.
	ID   string `json:"id"`
	Name string `json:"name"`
}

DeviceGroup represents a device group.

type DigiCertSetting 

type DigiCertSetting struct {
	CaName            *string      `json:"caName,omitempty"`
	ClientCert        *Certificate `json:"clientCert,omitempty"`
	Fqdn              *string      `json:"fqdn,omitempty"`
	RevocationEnabled *bool        `json:"revocationEnabled,omitempty"`
}

DigiCertSetting DigiCert Trust Lifecycle Manager object to create, or update with a merge-patch strategy. Certificate data must be provided in full, or not at all for update with merge-patch strategy.

type DigiCertSettingResponse 

type DigiCertSettingResponse struct {
	CaName            string               `json:"caName"`
	ClientCert        *CertificateResponse `json:"clientCert,omitempty"`
	Fqdn              string               `json:"fqdn"`
	ID                string               `json:"id"`
	RevocationEnabled bool                 `json:"revocationEnabled"`
}

DigiCertSettingResponse DigiCert Trust Lifecycle Manager response object.

type DigicertConnectionStatus 

type DigicertConnectionStatus struct {
	Status string `json:"status"`
}

DigicertConnectionStatus represents a digicert connection status.

type DigicertDependencies 

type DigicertDependencies struct {
	Results    []DigicertDependency `json:"results"`
	TotalCount int                  `json:"totalCount"`
}

DigicertDependencies represents a digicert dependencies.

type DigicertDependency 

type DigicertDependency struct {
	ConfigProfileID   int    `json:"configProfileId"`
	ConfigProfileName string `json:"configProfileName"`
	// Allowed values: see the DigicertDependencyConfigProfileType constants.
	ConfigProfileType string `json:"configProfileType"`
}

DigicertDependency represents a digicert dependency.

type DigicertDependencyConfigProfileType 

type DigicertDependencyConfigProfileType = string

DigicertDependencyConfigProfileType is the set of values accepted by DigicertDependency.ConfigProfileType. 

const (
	DigicertDependencyConfigProfileTypeOsxConfigurationProfile DigicertDependencyConfigProfileType = "OSX_CONFIGURATION_PROFILE"
	DigicertDependencyConfigProfileTypeIosConfigurationProfile DigicertDependencyConfigProfileType = "IOS_CONFIGURATION_PROFILE"
)

DigicertDependencyConfigProfileType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DigicertDependencyConfigProfileTypeValues 

func DigicertDependencyConfigProfileTypeValues() []DigicertDependencyConfigProfileType

DigicertDependencyConfigProfileTypeValues returns every value the Jamf API accepts for DigicertDependencyConfigProfileType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DistributionPoint 

type DistributionPoint struct {
	BackupDistributionPointID *string `json:"backupDistributionPointId,omitempty"`
	// This is used to configure load balancing on the backup distribution point. Cannot be enabled when
	// the backup distribution point configured is cloud.
	EnableLoadBalancing *bool `json:"enableLoadBalancing,omitempty"`
	// Specify the type of connection , Either of fileSharingConnectionType (or) https connection type
	// needs to be enabled using httpsEnabled for a distribution point to be created.
	// Allowed values: see the DistributionPointFileSharingConnectionType constants.
	FileSharingConnectionType string `json:"fileSharingConnectionType"`
	// Path to the share (e.g. if the share is accessible at http://192.168.10.10/JamfShare, the context is
	// "JamfShare") - required if HTTPS enabled.
	HttpsContext *string `json:"httpsContext,omitempty"`
	// Allow downloads over HTTPS - requires installation of a valid SSL certificate.
	HttpsEnabled *bool `json:"httpsEnabled,omitempty"`
	// Required if httpsSecurityType is USERNAME_PASSWORD.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	HttpsPassword *string `json:"httpsPassword,omitempty"`
	// Port number of the server - required if HTTPS enabled.
	HttpsPort *int `json:"httpsPort,omitempty"`
	// Type of authentication required to download files from the distribution point - required if HTTPS
	// enabled.
	// Allowed values: see the DistributionPointHttpsSecurityType constants.
	HttpsSecurityType *string `json:"httpsSecurityType,omitempty"`
	// Required if httpsSecurityType is USERNAME_PASSWORD.
	HttpsUsername    *string `json:"httpsUsername,omitempty"`
	ID               *string `json:"id,omitempty"`
	LocalPathToShare *string `json:"localPathToShare,omitempty"`
	Name             string  `json:"name"`
	// Required if fileSharingConnectionType is either AFP (or) SMB.
	Port      *int  `json:"port,omitempty"`
	Principal *bool `json:"principal,omitempty"`
	// Required if fileSharingConnectionType is either AFP (or) SMB.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	ReadOnlyPassword *string `json:"readOnlyPassword,omitempty"`
	// Required if fileSharingConnectionType is either AFP (or) SMB.
	ReadOnlyUsername *string `json:"readOnlyUsername,omitempty"`
	// Required if fileSharingConnectionType is either AFP (or) SMB.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	ReadWritePassword *string `json:"readWritePassword,omitempty"`
	// Required if fileSharingConnectionType is either AFP (or) SMB.
	ReadWriteUsername *string `json:"readWriteUsername,omitempty"`
	ServerName        string  `json:"serverName"`
	// Required if fileSharingConnectionType is either AFP (or) SMB.
	ShareName *string `json:"shareName,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	SshPassword *string `json:"sshPassword,omitempty"`
	SshUsername *string `json:"sshUsername,omitempty"`
	Workgroup   *string `json:"workgroup,omitempty"`
}

DistributionPoint represents a distribution point.

type DistributionPointFileSharingConnectionType 

type DistributionPointFileSharingConnectionType = string

DistributionPointFileSharingConnectionType is the set of values accepted by DistributionPoint.FileSharingConnectionType. 

const (
	DistributionPointFileSharingConnectionTypeAfp  DistributionPointFileSharingConnectionType = "AFP"
	DistributionPointFileSharingConnectionTypeSmb  DistributionPointFileSharingConnectionType = "SMB"
	DistributionPointFileSharingConnectionTypeNone DistributionPointFileSharingConnectionType = "NONE"
)

DistributionPointFileSharingConnectionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DistributionPointFileSharingConnectionTypeValues 

func DistributionPointFileSharingConnectionTypeValues() []DistributionPointFileSharingConnectionType

DistributionPointFileSharingConnectionTypeValues returns every value the Jamf API accepts for DistributionPointFileSharingConnectionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DistributionPointHttpsSecurityType 

type DistributionPointHttpsSecurityType = string

DistributionPointHttpsSecurityType is the set of values accepted by DistributionPoint.HttpsSecurityType. 

const (
	DistributionPointHttpsSecurityTypeUsernamePassword DistributionPointHttpsSecurityType = "USERNAME_PASSWORD"
	DistributionPointHttpsSecurityTypeNone             DistributionPointHttpsSecurityType = "NONE"
)

DistributionPointHttpsSecurityType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DistributionPointHttpsSecurityTypeValues 

func DistributionPointHttpsSecurityTypeValues() []DistributionPointHttpsSecurityType

DistributionPointHttpsSecurityTypeValues returns every value the Jamf API accepts for DistributionPointHttpsSecurityType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DistributionPointSearchResults 

type DistributionPointSearchResults struct {
	Results    []DistributionPoint `json:"results"`
	TotalCount int                 `json:"totalCount"`
}

DistributionPointSearchResults represents a distribution point search results.

type DockItem 

type DockItem struct {
	Contents *string `json:"contents,omitempty"`
	ID       *string `json:"id,omitempty"`
	Name     string  `json:"name"`
	Path     string  `json:"path"`
	// Allowed values: see the DockItemType constants.
	Type string `json:"type"`
}

DockItem represents a dock item.

type DockItemType 

type DockItemType = string

DockItemType is the set of values accepted by DockItem.Type. 

const (
	DockItemTypeApp    DockItemType = "APP"
	DockItemTypeFile   DockItemType = "FILE"
	DockItemTypeFolder DockItemType = "FOLDER"
)

DockItemType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DockItemTypeValues 

func DockItemTypeValues() []DockItemType

DockItemTypeValues returns every value the Jamf API accepts for DockItemType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DownloadURL 

type DownloadURL struct {
	URI string `json:"uri"`
}

DownloadURL The URL to download a file from.

type DssDeclaration 

type DssDeclaration struct {
	// Allowed values: see the DssDeclarationGroup constants.
	Group       *string `json:"group,omitempty"`
	PayloadJson *string `json:"payloadJson,omitempty"`
	Type        *string `json:"type,omitempty"`
	UUID        string  `json:"uuid"`
}

DssDeclaration represents a dss declaration.

type DssDeclarationGroup 

type DssDeclarationGroup = string

DssDeclarationGroup is the set of values accepted by DssDeclaration.Group. 

const (
	DssDeclarationGroupActivation    DssDeclarationGroup = "ACTIVATION"
	DssDeclarationGroupAsset         DssDeclarationGroup = "ASSET"
	DssDeclarationGroupConfiguration DssDeclarationGroup = "CONFIGURATION"
	DssDeclarationGroupManagement    DssDeclarationGroup = "MANAGEMENT"
)

DssDeclarationGroup values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func DssDeclarationGroupValues 

func DssDeclarationGroupValues() []DssDeclarationGroup

DssDeclarationGroupValues returns every value the Jamf API accepts for DssDeclarationGroup, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type DssDeclarations 

type DssDeclarations struct {
	Declarations []DssDeclaration `json:"declarations"`
}

DssDeclarations represents a dss declarations.

type Ebook 

type Ebook struct {
	Author     string `json:"author"`
	CategoryID string `json:"categoryId"`
	// If true, it will be automatically installed.
	DeployAsManaged      bool   `json:"deployAsManaged"`
	Free                 bool   `json:"free"`
	ID                   string `json:"id"`
	InstallAutomatically bool   `json:"installAutomatically"`
	// Allowed values: see the EbookKind constants.
	Kind    string `json:"kind"`
	Name    string `json:"name"`
	SiteID  string `json:"siteId"`
	URL     string `json:"url"`
	Version string `json:"version"`
}

Ebook represents a ebook.

type EbookExclusions 

type EbookExclusions struct {
	BuildingIds          []string          `json:"buildingIds"`
	ComputerGroupIds     []string          `json:"computerGroupIds"`
	ComputerIds          []string          `json:"computerIds"`
	DepartmentIds        []string          `json:"departmentIds"`
	Limitations          *EbookLimitations `json:"limitations,omitempty"`
	MobileDeviceGroupIds []string          `json:"mobileDeviceGroupIds"`
	MobileDeviceIds      []string          `json:"mobileDeviceIds"`
	UserGroupIds         []string          `json:"userGroupIds"`
	UserIds              []string          `json:"userIds"`
}

EbookExclusions represents a ebook exclusions.

type EbookKind 

type EbookKind = string

EbookKind is the set of values accepted by Ebook.Kind. 

const (
	EbookKindUnknown EbookKind = "UNKNOWN"
	EbookKindPdf     EbookKind = "PDF"
	EbookKindEpub    EbookKind = "EPUB"
	EbookKindIbooks  EbookKind = "IBOOKS"
)

EbookKind values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func EbookKindValues 

func EbookKindValues() []EbookKind

EbookKindValues returns every value the Jamf API accepts for EbookKind, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type EbookLimitations 

type EbookLimitations struct {
	NetworkSegments []string                    `json:"networkSegments"`
	UserGroups      []string                    `json:"userGroups"`
	Users           []EbookLimitationsUsersItem `json:"users"`
}

EbookLimitations represents a ebook limitations.

type EbookLimitationsUsersItem 

type EbookLimitationsUsersItem struct {
	Name string `json:"name"`
}

EbookLimitationsUsersItem represents a ebook limitations users item.

type EbookScope 

type EbookScope struct {
	AllComputers         bool              `json:"allComputers"`
	AllMobileDevices     bool              `json:"allMobileDevices"`
	AllUsers             bool              `json:"allUsers"`
	BuildingIds          []string          `json:"buildingIds"`
	ClassroomIds         []string          `json:"classroomIds"`
	ComputerGroupIds     []string          `json:"computerGroupIds"`
	ComputerIds          []string          `json:"computerIds"`
	DepartmentIds        []string          `json:"departmentIds"`
	Exclusions           *EbookExclusions  `json:"exclusions,omitempty"`
	Limitations          *EbookLimitations `json:"limitations,omitempty"`
	MobileDeviceGroupIds []string          `json:"mobileDeviceGroupIds"`
	MobileDeviceIds      []string          `json:"mobileDeviceIds"`
	UserGroupIds         []string          `json:"userGroupIds"`
	UserIds              []string          `json:"userIds"`
}

EbookScope represents a ebook scope.

type EbookSearchResults 

type EbookSearchResults struct {
	Results    []Ebook `json:"results"`
	TotalCount int     `json:"totalCount"`
}

EbookSearchResults represents a ebook search results.

type EnablePushRequest 

type EnablePushRequest struct {
	// Unique identifier for the device management record to enable push for.
	ManagementID string `json:"managementId"`
}

EnablePushRequest Request body to enable push notifications for a client.

type EnrollmentAccessGroupPreview 

type EnrollmentAccessGroupPreview struct {
	AccountDrivenUserEnrollmentEnabled *bool `json:"accountDrivenUserEnrollmentEnabled,omitempty"`
	EnterpriseEnrollmentEnabled        *bool `json:"enterpriseEnrollmentEnabled,omitempty"`
	// LDAP Group ID.
	GroupID string `json:"groupId"`
	// Autogenerated ID.
	ID                        *string `json:"id,omitempty"`
	LdapServerID              string  `json:"ldapServerId"`
	Name                      string  `json:"name"`
	PersonalEnrollmentEnabled *bool   `json:"personalEnrollmentEnabled,omitempty"`
	RequireEula               *bool   `json:"requireEula,omitempty"`
	SiteID                    *string `json:"siteId,omitempty"`
}

EnrollmentAccessGroupPreview represents a enrollment access group preview.

type EnrollmentCustomizationBrandingSettings 

type EnrollmentCustomizationBrandingSettings struct {
	BackgroundColor string `json:"backgroundColor"`
	ButtonColor     string `json:"buttonColor"`
	ButtonTextColor string `json:"buttonTextColor"`
	IconURL         string `json:"iconUrl"`
	TextColor       string `json:"textColor"`
}

EnrollmentCustomizationBrandingSettings represents a enrollment customization branding settings.

type EnrollmentCustomizationDependencies 

type EnrollmentCustomizationDependencies struct {
	Dependencies []EnrollmentCustomizationDependency `json:"dependencies"`
}

EnrollmentCustomizationDependencies represents a enrollment customization dependencies.

type EnrollmentCustomizationDependency 

type EnrollmentCustomizationDependency struct {
	HumanReadableName string `json:"humanReadableName"`
	Hyperlink         string `json:"hyperlink"`
	Name              string `json:"name"`
}

EnrollmentCustomizationDependency represents a enrollment customization dependency.

type EnrollmentCustomizationLdapGroupAccess 

type EnrollmentCustomizationLdapGroupAccess struct {
	GroupName    *string `json:"groupName,omitempty"`
	LdapServerID *int    `json:"ldapServerId,omitempty"`
}

EnrollmentCustomizationLdapGroupAccess represents a enrollment customization ldap group access.

type EnrollmentCustomizationPanel 

type EnrollmentCustomizationPanel struct {
	DisplayName string `json:"displayName"`
	Rank        int    `json:"rank"`
}

EnrollmentCustomizationPanel represents a enrollment customization panel.

type EnrollmentCustomizationPanelLdapAuth 

type EnrollmentCustomizationPanelLdapAuth struct {
	BackButtonText     string                                    `json:"backButtonText"`
	ContinueButtonText string                                    `json:"continueButtonText"`
	DisplayName        string                                    `json:"displayName"`
	LdapGroupAccess    *[]EnrollmentCustomizationLdapGroupAccess `json:"ldapGroupAccess,omitempty"`
	PasswordLabel      string                                    `json:"passwordLabel"`
	Rank               int                                       `json:"rank"`
	Title              string                                    `json:"title"`
	UsernameLabel      string                                    `json:"usernameLabel"`
}

EnrollmentCustomizationPanelLdapAuth represents a enrollment customization panel ldap auth.

type EnrollmentCustomizationPanelList 

type EnrollmentCustomizationPanelList struct {
	Panels []GetEnrollmentCustomizationPanel `json:"panels"`
}

EnrollmentCustomizationPanelList represents a enrollment customization panel list.

type EnrollmentCustomizationPanelSsoAuth 

type EnrollmentCustomizationPanelSsoAuth struct {
	DisplayName                    string `json:"displayName"`
	GroupEnrollmentAccessName      string `json:"groupEnrollmentAccessName"`
	IsGroupEnrollmentAccessEnabled bool   `json:"isGroupEnrollmentAccessEnabled"`
	IsUseJamfConnect               bool   `json:"isUseJamfConnect"`
	LongNameAttribute              string `json:"longNameAttribute"`
	Rank                           int    `json:"rank"`
	ShortNameAttribute             string `json:"shortNameAttribute"`
}

EnrollmentCustomizationPanelSsoAuth represents a enrollment customization panel sso auth.

type EnrollmentCustomizationPanelText 

type EnrollmentCustomizationPanelText struct {
	BackButtonText     string  `json:"backButtonText"`
	Body               string  `json:"body"`
	ContinueButtonText string  `json:"continueButtonText"`
	DisplayName        string  `json:"displayName"`
	Rank               int     `json:"rank"`
	Subtext            *string `json:"subtext,omitempty"`
	Title              string  `json:"title"`
}

EnrollmentCustomizationPanelText represents a enrollment customization panel text.

type EnrollmentCustomizationSearchResultsV2 

type EnrollmentCustomizationSearchResultsV2 struct {
	Results    []EnrollmentCustomizationV2 `json:"results"`
	TotalCount int                         `json:"totalCount"`
}

EnrollmentCustomizationSearchResultsV2 represents a enrollment customization search results v2.

type EnrollmentCustomizationV2 

type EnrollmentCustomizationV2 struct {
	Description                             string                                  `json:"description"`
	DisplayName                             string                                  `json:"displayName"`
	EnrollmentCustomizationBrandingSettings EnrollmentCustomizationBrandingSettings `json:"enrollmentCustomizationBrandingSettings"`
	ID                                      *string                                 `json:"id,omitempty"`
	SiteID                                  string                                  `json:"siteId"`
}

EnrollmentCustomizationV2 represents a enrollment customization v2.

type EnrollmentMethod 

type EnrollmentMethod struct {
	ID         string `json:"id"`
	ObjectName string `json:"objectName"`
	ObjectType string `json:"objectType"`
}

EnrollmentMethod represents a enrollment method.

type EnrollmentMethodPrestage 

type EnrollmentMethodPrestage struct {
	MobileDevicePrestageID string `json:"mobileDevicePrestageId"`
	ProfileName            string `json:"profileName"`
}

EnrollmentMethodPrestage represents a enrollment method prestage.

type EnrollmentProcessTextObject 

type EnrollmentProcessTextObject struct {
	CertificateButton                *string `json:"certificateButton,omitempty"`
	CertificateProfileDescription    *string `json:"certificateProfileDescription,omitempty"`
	CertificateProfileName           *string `json:"certificateProfileName,omitempty"`
	CertificateText                  *string `json:"certificateText,omitempty"`
	CheckEnrollmentMessage           *string `json:"checkEnrollmentMessage,omitempty"`
	CheckNowButton                   *string `json:"checkNowButton,omitempty"`
	CompleteMessage                  *string `json:"completeMessage,omitempty"`
	DeviceClassButton                *string `json:"deviceClassButton,omitempty"`
	DeviceClassDescription           *string `json:"deviceClassDescription,omitempty"`
	DeviceClassEnterprise            *string `json:"deviceClassEnterprise,omitempty"`
	DeviceClassEnterpriseDescription *string `json:"deviceClassEnterpriseDescription,omitempty"`
	DeviceClassPersonal              *string `json:"deviceClassPersonal,omitempty"`
	DeviceClassPersonalDescription   *string `json:"deviceClassPersonalDescription,omitempty"`
	EnterpriseButton                 *string `json:"enterpriseButton,omitempty"`
	EnterpriseEula                   *string `json:"enterpriseEula,omitempty"`
	EnterprisePending                *string `json:"enterprisePending,omitempty"`
	EnterpriseProfileDescription     *string `json:"enterpriseProfileDescription,omitempty"`
	EnterpriseProfileName            *string `json:"enterpriseProfileName,omitempty"`
	EnterpriseText                   *string `json:"enterpriseText,omitempty"`
	EulaButton                       *string `json:"eulaButton,omitempty"`
	FailedMessage                    *string `json:"failedMessage,omitempty"`
	LanguageCode                     *string `json:"languageCode,omitempty"`
	LoginButton                      *string `json:"loginButton,omitempty"`
	LoginDescription                 *string `json:"loginDescription,omitempty"`
	LogoutButton                     *string `json:"logoutButton,omitempty"`
	Name                             *string `json:"name,omitempty"`
	Password                         *string `json:"password,omitempty"`
	// **Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any
	// input values in PUT requests.
	PersonalButton *string `json:"personalButton,omitempty"`
	PersonalEula   *string `json:"personalEula,omitempty"`
	// **Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any
	// input values in PUT requests.
	PersonalProfileDescription *string `json:"personalProfileDescription,omitempty"`
	// **Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any
	// input values in PUT requests.
	PersonalProfileName *string `json:"personalProfileName,omitempty"`
	// **Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any
	// input values in PUT requests.
	PersonalText                     *string `json:"personalText,omitempty"`
	QuickAddButton                   *string `json:"quickAddButton,omitempty"`
	QuickAddName                     *string `json:"quickAddName,omitempty"`
	QuickAddPending                  *string `json:"quickAddPending,omitempty"`
	QuickAddText                     *string `json:"quickAddText,omitempty"`
	SiteDescription                  *string `json:"siteDescription,omitempty"`
	Title                            *string `json:"title,omitempty"`
	TryAgainButton                   *string `json:"tryAgainButton,omitempty"`
	UserEnrollmentButton             *string `json:"userEnrollmentButton,omitempty"`
	UserEnrollmentProfileDescription *string `json:"userEnrollmentProfileDescription,omitempty"`
	UserEnrollmentProfileName        *string `json:"userEnrollmentProfileName,omitempty"`
	UserEnrollmentText               *string `json:"userEnrollmentText,omitempty"`
	Username                         *string `json:"username,omitempty"`
}

EnrollmentProcessTextObject represents a enrollment process text object.

type EnrollmentSettingsV4 

type EnrollmentSettingsV4 struct {
	AccountDrivenDeviceIosEnrollmentEnabled      *bool                  `json:"accountDrivenDeviceIosEnrollmentEnabled,omitempty"`
	AccountDrivenDeviceMacosEnrollmentEnabled    *bool                  `json:"accountDrivenDeviceMacosEnrollmentEnabled,omitempty"`
	AccountDrivenDeviceVisionosEnrollmentEnabled *bool                  `json:"accountDrivenDeviceVisionosEnrollmentEnabled,omitempty"`
	AccountDrivenUserEnrollmentEnabled           *bool                  `json:"accountDrivenUserEnrollmentEnabled,omitempty"`
	AccountDrivenUserVisionosEnrollmentEnabled   *bool                  `json:"accountDrivenUserVisionosEnrollmentEnabled,omitempty"`
	AllowSshOnlyManagementAccount                *bool                  `json:"allowSshOnlyManagementAccount,omitempty"`
	CreateManagementAccount                      *bool                  `json:"createManagementAccount,omitempty"`
	DeveloperCertificateIdentity                 *CertificateIdentityV2 `json:"developerCertificateIdentity,omitempty"`
	DeveloperCertificateIdentityDetails          *CertificateDetails    `json:"developerCertificateIdentityDetails,omitempty"`
	EnsureSshRunning                             *bool                  `json:"ensureSshRunning,omitempty"`
	FlushExtensionAttributes                     *bool                  `json:"flushExtensionAttributes,omitempty"`
	FlushLocationHistoryInformation              *bool                  `json:"flushLocationHistoryInformation,omitempty"`
	FlushLocationInformation                     *bool                  `json:"flushLocationInformation,omitempty"`
	// Allowed values: see the EnrollmentSettingsV4FlushMDMCommandsOnReenroll constants.
	FlushMDMCommandsOnReenroll       *string                `json:"flushMdmCommandsOnReenroll,omitempty"`
	FlushPolicyHistory               *bool                  `json:"flushPolicyHistory,omitempty"`
	FlushSoftwareUpdatePlans         *bool                  `json:"flushSoftwareUpdatePlans,omitempty"`
	HideManagementAccount            *bool                  `json:"hideManagementAccount,omitempty"`
	InstallSingleProfile             *bool                  `json:"installSingleProfile,omitempty"`
	IosEnterpriseEnrollmentEnabled   *bool                  `json:"iosEnterpriseEnrollmentEnabled,omitempty"`
	IosPersonalEnrollmentEnabled     *bool                  `json:"iosPersonalEnrollmentEnabled,omitempty"`
	LaunchSelfService                *bool                  `json:"launchSelfService,omitempty"`
	MacOsEnterpriseEnrollmentEnabled *bool                  `json:"macOsEnterpriseEnrollmentEnabled,omitempty"`
	MaidUsernameMergeEnabled         *bool                  `json:"maidUsernameMergeEnabled,omitempty"`
	ManagementUsername               string                 `json:"managementUsername"`
	MDMSigningCertificate            *CertificateIdentityV2 `json:"mdmSigningCertificate,omitempty"`
	MDMSigningCertificateDetails     *CertificateDetails    `json:"mdmSigningCertificateDetails,omitempty"`
	// **Deprecated as of 11.25.** This field always returns "USERENROLLMENT" in GET responses and ignores
	// any input values in PUT requests.
	PersonalDeviceEnrollmentType *string `json:"personalDeviceEnrollmentType,omitempty"`
	RestrictReenrollment         *bool   `json:"restrictReenrollment,omitempty"`
	SignQuickAdd                 *bool   `json:"signQuickAdd,omitempty"`
	SigningMDMProfileEnabled     *bool   `json:"signingMdmProfileEnabled,omitempty"`
}

EnrollmentSettingsV4 represents a enrollment settings v4.

type EnrollmentSettingsV4FlushMDMCommandsOnReenroll 

type EnrollmentSettingsV4FlushMDMCommandsOnReenroll = string

EnrollmentSettingsV4FlushMDMCommandsOnReenroll is the set of values accepted by EnrollmentSettingsV4.FlushMDMCommandsOnReenroll. 

const (
	EnrollmentSettingsV4FlushMDMCommandsOnReenrollDeleteNothing                      EnrollmentSettingsV4FlushMDMCommandsOnReenroll = "DELETE_NOTHING"
	EnrollmentSettingsV4FlushMDMCommandsOnReenrollDeleteErrors                       EnrollmentSettingsV4FlushMDMCommandsOnReenroll = "DELETE_ERRORS"
	EnrollmentSettingsV4FlushMDMCommandsOnReenrollDeleteEverythingExceptAcknowledged EnrollmentSettingsV4FlushMDMCommandsOnReenroll = "DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED"
	EnrollmentSettingsV4FlushMDMCommandsOnReenrollDeleteEverything                   EnrollmentSettingsV4FlushMDMCommandsOnReenroll = "DELETE_EVERYTHING"
)

EnrollmentSettingsV4FlushMDMCommandsOnReenroll values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func EnrollmentSettingsV4FlushMDMCommandsOnReenrollValues 

func EnrollmentSettingsV4FlushMDMCommandsOnReenrollValues() []EnrollmentSettingsV4FlushMDMCommandsOnReenroll

EnrollmentSettingsV4FlushMDMCommandsOnReenrollValues returns every value the Jamf API accepts for EnrollmentSettingsV4FlushMDMCommandsOnReenroll, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type EnrollmentSsoConfig 

type EnrollmentSsoConfig struct {
	Hosts          *[]string `json:"hosts"`
	ManagementHint *string   `json:"managementHint"`
}

EnrollmentSsoConfig represents a enrollment sso config.

type EraseDeviceComputerRequest 

type EraseDeviceComputerRequest struct {
	// The six-character PIN for Find My.
	Pin *string `json:"pin,omitempty"`
}

EraseDeviceComputerRequest represents a erase device computer request.

type EraseDeviceComputerResponse 

type EraseDeviceComputerResponse struct {
	// Uuid of the queued eraseDevice command.
	CommandUUID string `json:"commandUuid"`
	// Id of the computer for which eraseDevice command was queued.
	DeviceID string `json:"deviceId"`
}

EraseDeviceComputerResponse represents a erase device computer response.

type EraseDeviceMobileDeviceRequest 

type EraseDeviceMobileDeviceRequest struct {
	// Clear the activation lock on the device.
	ClearActivationLock *bool `json:"clearActivationLock,omitempty"`
	// If 'true', disable Proximity Setup on the next reboot and skip the pane in Setup Assistant.
	DisallowProximitySetup *bool `json:"disallowProximitySetup,omitempty"`
	// If 'true', preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists.
	PreserveDataPlan *bool `json:"preserveDataPlan,omitempty"`
	// If 'true', the device will be returned to service after the erase is complete.
	ReturnToService *bool `json:"returnToService,omitempty"`
}

EraseDeviceMobileDeviceRequest represents a erase device mobile device request.

type EraseDeviceMobileDeviceResponse 

type EraseDeviceMobileDeviceResponse struct {
	// Uuid of the queued eraseDevice command.
	CommandUUID string `json:"commandUuid"`
	// Id of the mobile device for which eraseDevice command was queued.
	DeviceID string `json:"deviceId"`
}

EraseDeviceMobileDeviceResponse represents a erase device mobile device response.

type ExportField 

type ExportField struct {
	// Name which should be used for the label in the response - can be in any language. When null the
	// fieldName itself will be used as the label.
	FieldLabelOverride *string `json:"fieldLabelOverride,omitempty"`
	// English name of the field to be exported.
	FieldName *string `json:"fieldName,omitempty"`
}

ExportField Field to be included in the export operation.

type ExportParameters 

type ExportParameters struct {
	// Used to change default order or ignore some of the fields. When null or empty array, all fields will
	// be exported.
	Fields   *[]ExportField `json:"fields,omitempty"`
	Filter   *string        `json:"filter,omitempty"`
	Page     *int           `json:"page,omitempty"`
	PageSize *int           `json:"pageSize,omitempty"`
	// Sorting criteria in the format: [<property>[:asc/desc]. Default direction when not stated is
	// ascending.
	Sort *[]string `json:"sort,omitempty"`
}

ExportParameters represents a export parameters.

type ExtensionAttributeV2 

type ExtensionAttributeV2 struct {
	ExtensionAttributeCollectionAllowed *bool   `json:"extensionAttributeCollectionAllowed,omitempty"`
	ID                                  *string `json:"id,omitempty"`
	Name                                *string `json:"name,omitempty"`
	// Allowed values: see the ExtensionAttributeV2Type constants.
	Type  *string   `json:"type,omitempty"`
	Value *[]string `json:"value,omitempty"`
}

ExtensionAttributeV2 represents a extension attribute v2.

type ExtensionAttributeV2Type 

type ExtensionAttributeV2Type = string

ExtensionAttributeV2Type is the set of values accepted by ExtensionAttributeV2.Type. 

const (
	ExtensionAttributeV2TypeString  ExtensionAttributeV2Type = "STRING"
	ExtensionAttributeV2TypeInteger ExtensionAttributeV2Type = "INTEGER"
	ExtensionAttributeV2TypeDate    ExtensionAttributeV2Type = "DATE"
)

ExtensionAttributeV2Type values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ExtensionAttributeV2TypeValues 

func ExtensionAttributeV2TypeValues() []ExtensionAttributeV2Type

ExtensionAttributeV2TypeValues returns every value the Jamf API accepts for ExtensionAttributeV2Type, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ExtensionAttributeValue 

type ExtensionAttributeValue struct {
	DisplayName string  `json:"displayName"`
	Value       *string `json:"value,omitempty"`
}

ExtensionAttributeValue represents a extension attribute value.

type ExtensionAttributes 

type ExtensionAttributes struct {
	// Type of data being collected.
	// Allowed values: see the ExtensionAttributesDataType constants.
	DataType string `json:"dataType"`
	// Description for the extension attribute.
	Description *string `json:"description,omitempty"`
	// Unique Id for Mobile Device Extension Attribute.
	ID *string `json:"id,omitempty"`
	// Display name for the extension attribute.
	Name string `json:"name"`
}

ExtensionAttributes represents a extension attributes.

type ExtensionAttributesDataType 

type ExtensionAttributesDataType = string

ExtensionAttributesDataType is the set of values accepted by ExtensionAttributes.DataType. 

const (
	ExtensionAttributesDataTypeInteger ExtensionAttributesDataType = "INTEGER"
	ExtensionAttributesDataTypeString  ExtensionAttributesDataType = "STRING"
	ExtensionAttributesDataTypeDate    ExtensionAttributesDataType = "DATE"
)

ExtensionAttributesDataType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ExtensionAttributesDataTypeValues 

func ExtensionAttributesDataTypeValues() []ExtensionAttributesDataType

ExtensionAttributesDataTypeValues returns every value the Jamf API accepts for ExtensionAttributesDataType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ExternalRecipient 

type ExternalRecipient struct {
	Email string `json:"email"`
	Name  string `json:"name"`
}

ExternalRecipient represents a external recipient.

type FileAttachmentV3 

type FileAttachmentV3 struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

FileAttachmentV3 represents a file attachment v3.

type FileData 

type FileData struct {
	// The name of the file.
	FileName string `json:"fileName"`
	// The length in bytes.
	Length int `json:"length"`
	// The MD5 in hex.
	Md5 string `json:"md5"`
	// The region the file is hosted in.
	Region string `json:"region"`
	// The SHA3_512 in hex.
	Sha3 string `json:"sha3"`
}

FileData Metadata pertaining to the file.

type FileTransferItem 

type FileTransferItem struct {
	FilePath string `json:"filePath"`
	// Allowed values: see the FileTransferItemFileTransferType constants.
	FileTransferType  string     `json:"fileTransferType"`
	TransferTimestamp *time.Time `json:"transferTimestamp,omitempty"`
}

FileTransferItem represents a file transfer item.

type FileTransferItemFileTransferType 

type FileTransferItemFileTransferType = string

FileTransferItemFileTransferType is the set of values accepted by FileTransferItem.FileTransferType. 

const (
	FileTransferItemFileTransferTypeDownload FileTransferItemFileTransferType = "DOWNLOAD"
	FileTransferItemFileTransferTypeUpload   FileTransferItemFileTransferType = "UPLOAD"
)

FileTransferItemFileTransferType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func FileTransferItemFileTransferTypeValues 

func FileTransferItemFileTransferTypeValues() []FileTransferItemFileTransferType

FileTransferItemFileTransferTypeValues returns every value the Jamf API accepts for FileTransferItemFileTransferType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GetComputerPrestageV3 

type GetComputerPrestageV3 struct {
	AccountSettings *AccountSettingsResponse `json:"accountSettings,omitempty"`
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                []string               `json:"anchorCertificates"`
	AuthenticationPrompt              string                 `json:"authenticationPrompt"`
	AutoAdvanceSetup                  bool                   `json:"autoAdvanceSetup"`
	CustomPackageDistributionPointID  string                 `json:"customPackageDistributionPointId"`
	CustomPackageIds                  []string               `json:"customPackageIds"`
	DefaultPrestage                   bool                   `json:"defaultPrestage"`
	Department                        string                 `json:"department"`
	DeviceEnrollmentProgramInstanceID string                 `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                       string                 `json:"displayName"`
	EnableDeviceBasedActivationLock   bool                   `json:"enableDeviceBasedActivationLock"`
	EnableRecoveryLock                bool                   `json:"enableRecoveryLock"`
	EnrollmentCustomizationID         string                 `json:"enrollmentCustomizationId"`
	EnrollmentSiteID                  string                 `json:"enrollmentSiteId"`
	ID                                string                 `json:"id"`
	InstallProfilesDuringSetup        bool                   `json:"installProfilesDuringSetup"`
	KeepExistingLocationInformation   bool                   `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership        bool                   `json:"keepExistingSiteMembership"`
	Language                          string                 `json:"language"`
	LocationInformation               *LocationInformationV2 `json:"locationInformation,omitempty"`
	Mandatory                         bool                   `json:"mandatory"`
	// The URL to the manifest file for the Platform SSO (PSSO) application Identity first workflow. This
	// URL is used when deploying the PSSO app to devices during the setup process.
	ManifestURL              *string `json:"manifestUrl,omitempty"`
	MDMRemovable             bool    `json:"mdmRemovable"`
	MinimumOsSpecificVersion string  `json:"minimumOsSpecificVersion"`
	// The bundle identifier for the Platform SSO (PSSO) application Device first workflow. This identifier
	// is used to specify which PSSO app should be deployed to devices during the setup process.
	PlatformSsoAppBundleID      string   `json:"platformSsoAppBundleId"`
	PrestageInstalledProfileIds []string `json:"prestageInstalledProfileIds"`
	// Allowed values: see the GetComputerPrestageV3PrestageMinimumOsTargetVersionType constants.
	PrestageMinimumOsTargetVersionType string `json:"prestageMinimumOsTargetVersionType"`
	PreventActivationLock              bool   `json:"preventActivationLock"`
	// The URL to the configuration profile for the Platform SSO (PSSO) application Identity first
	// workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users
	// should use either profileUrl or populate pssoConfigProfileId, but not both.
	ProfileURL  *string `json:"profileUrl,omitempty"`
	ProfileUUID string  `json:"profileUuid"`
	// The identifier for the configuration profile associated with the Platform SSO (PSSO) application
	// Identity first workflow. This ID is used to specify which configuration profile should be applied to
	// devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId
	// or populate profileUrl, but not both.
	PssoConfigProfileID *string `json:"pssoConfigProfileId,omitempty"`
	// Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of Device
	// first or Identity first workflows. When enabled, the PSSO application will be deployed to devices
	// during the setup process to facilitate single sign-on (SSO) for users.
	PssoEnabled           bool                             `json:"pssoEnabled"`
	PurchasingInformation *PrestagePurchasingInformationV2 `json:"purchasingInformation,omitempty"`
	// Allowed values: see the GetComputerPrestageV3RecoveryLockPasswordType constants.
	RecoveryLockPasswordType   string          `json:"recoveryLockPasswordType"`
	Region                     string          `json:"region"`
	RequireAuthentication      bool            `json:"requireAuthentication"`
	RotateRecoveryLockPassword bool            `json:"rotateRecoveryLockPassword"`
	SiteID                     string          `json:"siteId"`
	SkipSetupItems             map[string]bool `json:"skipSetupItems"`
	SupportEmailAddress        string          `json:"supportEmailAddress"`
	SupportPhoneNumber         string          `json:"supportPhoneNumber"`
	VersionLock                int             `json:"versionLock"`
}

GetComputerPrestageV3 represents a get computer prestage v3.

type GetComputerPrestageV3PrestageMinimumOsTargetVersionType 

type GetComputerPrestageV3PrestageMinimumOsTargetVersionType = string

GetComputerPrestageV3PrestageMinimumOsTargetVersionType is the set of values accepted by GetComputerPrestageV3.PrestageMinimumOsTargetVersionType. 

const (
	GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeNoEnforcement               GetComputerPrestageV3PrestageMinimumOsTargetVersionType = "NO_ENFORCEMENT"
	GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestVersion      GetComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_VERSION"
	GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMajorVersion GetComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMinorVersion GetComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MINOR_VERSION"
	GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsSpecificVersion    GetComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_SPECIFIC_VERSION"
)

GetComputerPrestageV3PrestageMinimumOsTargetVersionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues 

func GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues() []GetComputerPrestageV3PrestageMinimumOsTargetVersionType

GetComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues returns every value the Jamf API accepts for GetComputerPrestageV3PrestageMinimumOsTargetVersionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GetComputerPrestageV3RecoveryLockPasswordType 

type GetComputerPrestageV3RecoveryLockPasswordType = string

GetComputerPrestageV3RecoveryLockPasswordType is the set of values accepted by GetComputerPrestageV3.RecoveryLockPasswordType. 

const (
	GetComputerPrestageV3RecoveryLockPasswordTypeManual GetComputerPrestageV3RecoveryLockPasswordType = "MANUAL"
	GetComputerPrestageV3RecoveryLockPasswordTypeRandom GetComputerPrestageV3RecoveryLockPasswordType = "RANDOM"
)

GetComputerPrestageV3RecoveryLockPasswordType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GetComputerPrestageV3RecoveryLockPasswordTypeValues 

func GetComputerPrestageV3RecoveryLockPasswordTypeValues() []GetComputerPrestageV3RecoveryLockPasswordType

GetComputerPrestageV3RecoveryLockPasswordTypeValues returns every value the Jamf API accepts for GetComputerPrestageV3RecoveryLockPasswordType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GetEnrollmentCustomizationPanel 

type GetEnrollmentCustomizationPanel struct {
	DisplayName string `json:"displayName"`
	ID          int    `json:"id"`
	Rank        int    `json:"rank"`
	Type        string `json:"type"`
}

GetEnrollmentCustomizationPanel represents a get enrollment customization panel.

type GetEnrollmentCustomizationPanelLdapAuth 

type GetEnrollmentCustomizationPanelLdapAuth struct {
	BackButtonText     string                                   `json:"backButtonText"`
	ContinueButtonText string                                   `json:"continueButtonText"`
	DisplayName        string                                   `json:"displayName"`
	ID                 int                                      `json:"id"`
	LdapGroupAccess    []EnrollmentCustomizationLdapGroupAccess `json:"ldapGroupAccess"`
	PasswordLabel      string                                   `json:"passwordLabel"`
	Rank               int                                      `json:"rank"`
	Title              string                                   `json:"title"`
	Type               string                                   `json:"type"`
	UsernameLabel      string                                   `json:"usernameLabel"`
}

GetEnrollmentCustomizationPanelLdapAuth represents a get enrollment customization panel ldap auth.

type GetEnrollmentCustomizationPanelSsoAuth 

type GetEnrollmentCustomizationPanelSsoAuth struct {
	DisplayName                    string `json:"displayName"`
	GroupEnrollmentAccessName      string `json:"groupEnrollmentAccessName"`
	ID                             int    `json:"id"`
	IsGroupEnrollmentAccessEnabled bool   `json:"isGroupEnrollmentAccessEnabled"`
	IsUseJamfConnect               bool   `json:"isUseJamfConnect"`
	LongNameAttribute              string `json:"longNameAttribute"`
	Rank                           int    `json:"rank"`
	ShortNameAttribute             string `json:"shortNameAttribute"`
	Type                           string `json:"type"`
}

GetEnrollmentCustomizationPanelSsoAuth represents a get enrollment customization panel sso auth.

type GetEnrollmentCustomizationPanelText 

type GetEnrollmentCustomizationPanelText struct {
	BackButtonText     string `json:"backButtonText"`
	Body               string `json:"body"`
	ContinueButtonText string `json:"continueButtonText"`
	DisplayName        string `json:"displayName"`
	ID                 int    `json:"id"`
	Rank               int    `json:"rank"`
	Subtext            string `json:"subtext"`
	Title              string `json:"title"`
	Type               string `json:"type"`
}

GetEnrollmentCustomizationPanelText represents a get enrollment customization panel text.

type GetMobileDevicePrestageV3 

type GetMobileDevicePrestageV3 struct {
	AllowPairing bool `json:"allowPairing"`
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                  []string `json:"anchorCertificates"`
	AuthenticationPrompt                string   `json:"authenticationPrompt"`
	AutoAdvanceSetup                    bool     `json:"autoAdvanceSetup"`
	ConfigureDeviceBeforeSetupAssistant bool     `json:"configureDeviceBeforeSetupAssistant"`
	DefaultPrestage                     bool     `json:"defaultPrestage"`
	Department                          string   `json:"department"`
	DeviceEnrollmentProgramInstanceID   string   `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                         string   `json:"displayName"`
	// If true, the device does not use the profile when it restores a backup. Default is false. Available
	// in iOS 26 and later, and visionOS 26 and later; otherwise ignored by devices.
	DoNotUseProfileFromBackup       bool   `json:"doNotUseProfileFromBackup"`
	EnableDeviceBasedActivationLock bool   `json:"enableDeviceBasedActivationLock"`
	EnforceTemporarySessionTimeout  bool   `json:"enforceTemporarySessionTimeout"`
	EnforceUserSessionTimeout       bool   `json:"enforceUserSessionTimeout"`
	EnrollmentCustomizationID       string `json:"enrollmentCustomizationId"`
	EnrollmentSiteID                string `json:"enrollmentSiteId"`
	ID                              string `json:"id"`
	// Controls whether apps are installed during the enrollment process.
	InstallAppsDuringEnrollment     bool                         `json:"installAppsDuringEnrollment"`
	KeepExistingLocationInformation bool                         `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership      bool                         `json:"keepExistingSiteMembership"`
	Language                        string                       `json:"language"`
	LocationInformation             *LocationInformationV3       `json:"locationInformation,omitempty"`
	Mandatory                       bool                         `json:"mandatory"`
	MaximumSharedAccounts           int                          `json:"maximumSharedAccounts"`
	MDMRemovable                    bool                         `json:"mdmRemovable"`
	MinimumOsSpecificVersionIos     string                       `json:"minimumOsSpecificVersionIos"`
	MinimumOsSpecificVersionIpad    string                       `json:"minimumOsSpecificVersionIpad"`
	MultiUser                       bool                         `json:"multiUser"`
	Names                           *MobileDevicePrestageNamesV3 `json:"names,omitempty"`
	// Controls whether managed apps are preserved during Return to Service operations.
	PreserveManagedApps bool `json:"preserveManagedApps"`
	// Allowed values: see the GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos constants.
	PrestageMinimumOsTargetVersionTypeIos string `json:"prestageMinimumOsTargetVersionTypeIos"`
	// Allowed values: see the GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad constants.
	PrestageMinimumOsTargetVersionTypeIpad string                           `json:"prestageMinimumOsTargetVersionTypeIpad"`
	PreventActivationLock                  bool                             `json:"preventActivationLock"`
	ProfileUUID                            string                           `json:"profileUuid"`
	PurchasingInformation                  *PrestagePurchasingInformationV3 `json:"purchasingInformation,omitempty"`
	Region                                 string                           `json:"region"`
	RequireAuthentication                  bool                             `json:"requireAuthentication"`
	RtsConfigProfileID                     string                           `json:"rtsConfigProfileId"`
	RtsEnabled                             bool                             `json:"rtsEnabled"`
	SendTimezone                           bool                             `json:"sendTimezone"`
	SiteID                                 string                           `json:"siteId"`
	SkipSetupItems                         map[string]bool                  `json:"skipSetupItems"`
	StorageQuotaSizeMegabytes              int                              `json:"storageQuotaSizeMegabytes"`
	Supervised                             bool                             `json:"supervised"`
	SupportEmailAddress                    string                           `json:"supportEmailAddress"`
	SupportPhoneNumber                     string                           `json:"supportPhoneNumber"`
	TemporarySessionOnly                   bool                             `json:"temporarySessionOnly"`
	TemporarySessionTimeout                int                              `json:"temporarySessionTimeout"`
	Timezone                               string                           `json:"timezone"`
	UseStorageQuotaSize                    bool                             `json:"useStorageQuotaSize"`
	UserSessionTimeout                     int                              `json:"userSessionTimeout"`
	VersionLock                            int                              `json:"versionLock"`
}

GetMobileDevicePrestageV3 represents a get mobile device prestage v3.

type GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos 

type GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = string

GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos is the set of values accepted by GetMobileDevicePrestageV3.PrestageMinimumOsTargetVersionTypeIos. 

const (
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosNoEnforcement               GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "NO_ENFORCEMENT"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestVersion      GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_VERSION"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestMajorVersion GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestMinorVersion GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_MINOR_VERSION"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsSpecificVersion    GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_SPECIFIC_VERSION"
)

GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues 

func GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues() []GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos

GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues returns every value the Jamf API accepts for GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad 

type GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = string

GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad is the set of values accepted by GetMobileDevicePrestageV3.PrestageMinimumOsTargetVersionTypeIpad. 

const (
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadNoEnforcement               GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "NO_ENFORCEMENT"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestVersion      GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_VERSION"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestMajorVersion GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestMinorVersion GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_MINOR_VERSION"
	GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsSpecificVersion    GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_SPECIFIC_VERSION"
)

GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues 

func GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues() []GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad

GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues returns every value the Jamf API accepts for GetMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GlobalSettingsEndUserExperience 

type GlobalSettingsEndUserExperience struct {
	// Custom notification displayed on computers when an app update has been successfully completed.
	// Default value will be used if set to null.
	CompleteMessage *string `json:"completeMessage,omitempty"`
	// Duration in hours before the app is forcefully closed.
	Deadline *int64 `json:"deadline,omitempty"`
	// Custom notification message displayed on computers when app is about to be forcefully closed.
	// Default value will be used if set to null.
	DeadlineMessage *string `json:"deadlineMessage,omitempty"`
	// Custom interval in hours to display notifications on computers. Default value will be used if set to
	// null.
	NotificationInterval *int64 `json:"notificationInterval,omitempty"`
	// Custom notification message to display on computers when app update is available but the app is
	// running. Default value will be used if set to null.
	NotificationMessage *string `json:"notificationMessage,omitempty"`
	// Additional duration in minutes before the app is forcefully closed. Default value will be used if
	// set to null.
	QuitDelay *int64 `json:"quitDelay,omitempty"`
	// Determines whether the app should be restarted after a successful update.
	Relaunch *bool `json:"relaunch,omitempty"`
	// Determines whether all notifications should be suppressed.
	Suppress *bool `json:"suppress,omitempty"`
}

GlobalSettingsEndUserExperience End user experience settings in global app installers settings.

type GroupDtoV1 

type GroupDtoV1 struct {
	GroupDescription string `json:"groupDescription"`
	GroupJamfProID   string `json:"groupJamfProId"`
	GroupName        string `json:"groupName"`
	GroupPlatformID  string `json:"groupPlatformId"`
	// Allowed values: see the GroupDtoV1GroupType constants.
	GroupType       string `json:"groupType"`
	MembershipCount int    `json:"membershipCount"`
	Smart           bool   `json:"smart"`
}

GroupDtoV1 represents a group dto v1.

type GroupDtoV1GroupType 

type GroupDtoV1GroupType = string

GroupDtoV1GroupType is the set of values accepted by GroupDtoV1.GroupType. 

const (
	GroupDtoV1GroupTypeMobile   GroupDtoV1GroupType = "MOBILE"
	GroupDtoV1GroupTypeComputer GroupDtoV1GroupType = "COMPUTER"
)

GroupDtoV1GroupType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GroupDtoV1GroupTypeValues 

func GroupDtoV1GroupTypeValues() []GroupDtoV1GroupType

GroupDtoV1GroupTypeValues returns every value the Jamf API accepts for GroupDtoV1GroupType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GroupMappings 

type GroupMappings struct {
	GroupID   string `json:"groupID"`
	GroupName string `json:"groupName"`
	GroupUUID string `json:"groupUuid"`
	// Allowed values: see the GroupMappingsObjectClassLimitation constants.
	ObjectClassLimitation string `json:"objectClassLimitation"`
	ObjectClasses         string `json:"objectClasses"`
	SearchBase            string `json:"searchBase"`
	// Allowed values: see the GroupMappingsSearchScope constants.
	SearchScope string `json:"searchScope"`
}

GroupMappings Cloud Identity Provider user group mappings configuration.

type GroupMappingsObjectClassLimitation 

type GroupMappingsObjectClassLimitation = string

GroupMappingsObjectClassLimitation is the set of values accepted by GroupMappings.ObjectClassLimitation. 

const (
	GroupMappingsObjectClassLimitationAnyObjectClasses GroupMappingsObjectClassLimitation = "ANY_OBJECT_CLASSES"
	GroupMappingsObjectClassLimitationAllObjectClasses GroupMappingsObjectClassLimitation = "ALL_OBJECT_CLASSES"
)

GroupMappingsObjectClassLimitation values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GroupMappingsObjectClassLimitationValues 

func GroupMappingsObjectClassLimitationValues() []GroupMappingsObjectClassLimitation

GroupMappingsObjectClassLimitationValues returns every value the Jamf API accepts for GroupMappingsObjectClassLimitation, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GroupMappingsSearchScope 

type GroupMappingsSearchScope = string

GroupMappingsSearchScope is the set of values accepted by GroupMappings.SearchScope. 

const (
	GroupMappingsSearchScopeAllSubtrees    GroupMappingsSearchScope = "ALL_SUBTREES"
	GroupMappingsSearchScopeFirstLevelOnly GroupMappingsSearchScope = "FIRST_LEVEL_ONLY"
)

GroupMappingsSearchScope values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GroupMappingsSearchScopeValues 

func GroupMappingsSearchScopeValues() []GroupMappingsSearchScope

GroupMappingsSearchScopeValues returns every value the Jamf API accepts for GroupMappingsSearchScope, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GroupMembership 

type GroupMembership struct {
	GroupDescription string `json:"groupDescription"`
	GroupID          string `json:"groupId"`
	GroupName        string `json:"groupName"`
	// Indicates that group is smart group.
	SmartGroup bool `json:"smartGroup"`
}

GroupMembership represents a group membership.

type GroupResetRequest 

type GroupResetRequest struct {
	ClearActivationLock    *bool `json:"clearActivationLock,omitempty"`
	DisallowProximitySetup *bool `json:"disallowProximitySetup,omitempty"`
	PreserveDataPlan       *bool `json:"preserveDataPlan,omitempty"`
	ReturnToService        *bool `json:"returnToService,omitempty"`
}

GroupResetRequest represents a group reset request.

type GroupSearchResult 

type GroupSearchResult struct {
	Results    []GroupDtoV1 `json:"results"`
	TotalCount int          `json:"totalCount"`
}

GroupSearchResult represents a group search result.

type GroupTestSearch 

type GroupTestSearch struct {
	DistinguishedName string `json:"distinguishedName"`
	ID                string `json:"id"`
	Name              string `json:"name"`
	ServerID          string `json:"serverId"`
	UUID              string `json:"uuid"`
}

GroupTestSearch represents a group test search.

type GroupTestSearchRequest 

type GroupTestSearchRequest struct {
	Groupname string `json:"groupname"`
}

GroupTestSearchRequest represents a group test search request.

type GroupTestSearchResponse 

type GroupTestSearchResponse struct {
	Results    []GroupTestSearch `json:"results"`
	TotalCount int               `json:"totalCount"`
}

GroupTestSearchResponse represents a group test search response.

type GroupUpdateDtoV2 

type GroupUpdateDtoV2 struct {
	Assignments      *[]AssignmentDtoV1             `json:"assignments,omitempty"`
	Criteria         *[]UnifiedSmartGroupCriteriaV2 `json:"criteria,omitempty"`
	GroupDescription *string                        `json:"groupDescription,omitempty"`
	GroupName        *string                        `json:"groupName,omitempty"`
}

GroupUpdateDtoV2 represents a group update dto v2.

type GroupWithCriteriaDtoV1 

type GroupWithCriteriaDtoV1 struct {
	Criteria         *[]SmartGroupCriteria `json:"criteria,omitempty"`
	GroupDescription string                `json:"groupDescription"`
	GroupJamfProID   string                `json:"groupJamfProId"`
	GroupName        string                `json:"groupName"`
	GroupPlatformID  string                `json:"groupPlatformId"`
	// Allowed values: see the GroupWithCriteriaDtoV1GroupType constants.
	GroupType       string `json:"groupType"`
	MembershipCount int    `json:"membershipCount"`
	Smart           bool   `json:"smart"`
}

GroupWithCriteriaDtoV1 represents a group with criteria dto v1.

type GroupWithCriteriaDtoV1GroupType 

type GroupWithCriteriaDtoV1GroupType = string

GroupWithCriteriaDtoV1GroupType is the set of values accepted by GroupWithCriteriaDtoV1.GroupType. 

const (
	GroupWithCriteriaDtoV1GroupTypeMobile   GroupWithCriteriaDtoV1GroupType = "MOBILE"
	GroupWithCriteriaDtoV1GroupTypeComputer GroupWithCriteriaDtoV1GroupType = "COMPUTER"
)

GroupWithCriteriaDtoV1GroupType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func GroupWithCriteriaDtoV1GroupTypeValues 

func GroupWithCriteriaDtoV1GroupTypeValues() []GroupWithCriteriaDtoV1GroupType

GroupWithCriteriaDtoV1GroupTypeValues returns every value the Jamf API accepts for GroupWithCriteriaDtoV1GroupType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type GsxConnection 

type GsxConnection struct {
	Enabled          bool        `json:"enabled"`
	GsxKeystore      GsxKeystore `json:"gsxKeystore"`
	ServiceAccountNo string      `json:"serviceAccountNo"`
	ShipToNo         *string     `json:"shipToNo,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Token    string `json:"token"`
	Username string `json:"username"`
}

GsxConnection represents a gsx connection.

type GsxConnectionUpdate 

type GsxConnectionUpdate struct {
	Enabled          *bool        `json:"enabled,omitempty"`
	GsxKeystore      *GsxKeystore `json:"gsxKeystore,omitempty"`
	ServiceAccountNo *string      `json:"serviceAccountNo,omitempty"`
	ShipToNo         *string      `json:"shipToNo,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Token    *string `json:"token,omitempty"`
	Username *string `json:"username,omitempty"`
}

GsxConnectionUpdate represents a gsx connection update.

type GsxKeystore 

type GsxKeystore struct {
	ErrorMessage    *string `json:"errorMessage,omitempty"`
	ExpirationEpoch *int64  `json:"expirationEpoch,omitempty"`
	// The base 64 encoded of the GSX Connection keystore.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	KeystoreBytes *[]byte `json:"keystoreBytes,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	KeystorePassword string `json:"keystorePassword"`
	Name             string `json:"name"`
}

GsxKeystore represents a gsx keystore.

type GsxTestResponse 

type GsxTestResponse struct {
	Message  string `json:"message"`
	Request  string `json:"request"`
	Response string `json:"response"`
}

GsxTestResponse represents a gsx test response.

type HealthStatus 

type HealthStatus struct {
	Api        *HealthStatusStats `json:"api,omitempty"`
	Default    *HealthStatusStats `json:"default,omitempty"`
	Device     *HealthStatusStats `json:"device,omitempty"`
	Enrollment *HealthStatusStats `json:"enrollment,omitempty"`
	Ui         *HealthStatusStats `json:"ui,omitempty"`
}

HealthStatus represents a health status.

type HealthStatusStats 

type HealthStatusStats struct {
	// Percentage of accepted requests out of total requests for the last 15 minutes.
	FifteenMinutes float64 `json:"fifteenMinutes"`
	// Percentage of accepted requests out of total requests for the last 5 minutes.
	FiveMinutes float64 `json:"fiveMinutes"`
	// Percentage of accepted requests out of total requests for the last 1 minute.
	OneMinute float64 `json:"oneMinute"`
	// Percentage of accepted requests out of total requests for the last 30 minutes.
	ThirtyMinutes float64 `json:"thirtyMinutes"`
	// Percentage of accepted requests out of total requests for the last 30 seconds.
	ThirtySeconds float64 `json:"thirtySeconds"`
}

HealthStatusStats represents a health status stats.

type HistorySearchResults 

type HistorySearchResults struct {
	Results    []ObjectHistory `json:"results"`
	TotalCount int             `json:"totalCount"`
}

HistorySearchResults represents a history search results.

type HistorySearchResultsV1 

type HistorySearchResultsV1 struct {
	Results    []ObjectHistoryV1 `json:"results"`
	TotalCount int               `json:"totalCount"`
}

HistorySearchResultsV1 represents a history search results v1.

type HrefResponse 

type HrefResponse struct {
	Href string `json:"href"`
	ID   string `json:"id"`
}

HrefResponse represents a href response.

type IDAndNameV2 

type IDAndNameV2 struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

IDAndNameV2 represents a i d and name v2.

type IconResponse 

type IconResponse struct {
	ID  int    `json:"id"`
	URL string `json:"url"`
}

IconResponse represents a icon response.

type Ids 

type Ids struct {
	IDs *[]string `json:"ids,omitempty"`
}

Ids represents a ids.

type ImpactAlertNotificationSettingsV1 

type ImpactAlertNotificationSettingsV1 struct {
	DeployableObjectsAlertEnabled            bool `json:"deployableObjectsAlertEnabled"`
	DeployableObjectsConfirmationCodeEnabled bool `json:"deployableObjectsConfirmationCodeEnabled"`
	ScopeableObjectsAlertEnabled             bool `json:"scopeableObjectsAlertEnabled"`
	ScopeableObjectsConfirmationCodeEnabled  bool `json:"scopeableObjectsConfirmationCodeEnabled"`
}

ImpactAlertNotificationSettingsV1 represents a impact alert notification settings v1.

type InstallPackage 

type InstallPackage struct {
	Devices          *[]int          `json:"devices,omitempty"`
	GroupID          *string         `json:"groupId,omitempty"`
	InstallAsManaged *bool           `json:"installAsManaged,omitempty"`
	Manifest         PackageManifest `json:"manifest"`
}

InstallPackage Either devices or groupId must be provided.

type InternalRecipient 

type InternalRecipient struct {
	AccountID string `json:"accountId"`
	// Allowed values: see the InternalRecipientFrequency constants.
	Frequency *string `json:"frequency,omitempty"`
}

InternalRecipient represents a internal recipient.

type InternalRecipientFrequency 

type InternalRecipientFrequency = string

InternalRecipientFrequency is the set of values accepted by InternalRecipient.Frequency. 

const (
	InternalRecipientFrequencyDaily InternalRecipientFrequency = "DAILY"
)

InternalRecipientFrequency values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func InternalRecipientFrequencyValues 

func InternalRecipientFrequencyValues() []InternalRecipientFrequency

InternalRecipientFrequencyValues returns every value the Jamf API accepts for InternalRecipientFrequency, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type InventoryInformation 

type InventoryInformation struct {
	// Number of managed computers in inventory.
	ManagedComputers int `json:"managedComputers"`
	// Number of managed devices in inventory.
	ManagedDevices int `json:"managedDevices"`
	// Number of unmanaged computers in inventory.
	UnmanagedComputers int `json:"unmanagedComputers"`
	// Number of unmanaged devices in inventory.
	UnmanagedDevices int `json:"unmanagedDevices"`
}

InventoryInformation Jamf Pro Inventory statistics object. Aggregates managed/unmanaged devices and computers counters.

type InventoryListMobileDevice 

type InventoryListMobileDevice struct {
	ActivationLockEnabled bool `json:"activationLockEnabled"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	AirPlayPassword     string `json:"airPlayPassword"`
	AppAnalyticsEnabled bool   `json:"appAnalyticsEnabled"`
	AppleCareID         string `json:"appleCareId"`
	// The enrollment type reported by Apple.
	// Allowed values: see the InventoryListMobileDeviceAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	AvailableSpaceMb    int    `json:"availableSpaceMb"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration bool `json:"awaitingConfiguration"`
	// - NON_GENUINE: The battery isn't a genuine Apple battery. - NORMAL: The battery is operating
	// normally. - SERVICE_RECOMMENDED: The system recommends battery service. - UNKNOWN: The system
	// couldn't determine battery health information. - UNSUPPORTED: The device doesn't support battery
	// health reporting.
	// Allowed values: see the InventoryListMobileDeviceBatteryHealth constants.
	BatteryHealth                               string                    `json:"batteryHealth"`
	BatteryLevel                                int                       `json:"batteryLevel"`
	BlockEncryptionCapable                      bool                      `json:"blockEncryptionCapable"`
	BluetoothLowEnergyCapable                   bool                      `json:"bluetoothLowEnergyCapable"`
	BluetoothMacAddress                         string                    `json:"bluetoothMacAddress"`
	Building                                    string                    `json:"building"`
	CapacityMb                                  int                       `json:"capacityMb"`
	CarrierSettingsVersion                      string                    `json:"carrierSettingsVersion"`
	CellularTechnology                          string                    `json:"cellularTechnology"`
	CloudBackupEnabled                          bool                      `json:"cloudBackupEnabled"`
	CurrentCarrierNetwork                       string                    `json:"currentCarrierNetwork"`
	CurrentMobileCountryCode                    string                    `json:"currentMobileCountryCode"`
	CurrentMobileNetworkCode                    string                    `json:"currentMobileNetworkCode"`
	DataProtection                              bool                      `json:"dataProtection"`
	DataRoamingEnabled                          bool                      `json:"dataRoamingEnabled"`
	DeclarativeDeviceManagementEnabled          bool                      `json:"declarativeDeviceManagementEnabled"`
	Department                                  string                    `json:"department"`
	DeviceID                                    string                    `json:"deviceId"`
	DeviceLocatorServiceEnabled                 bool                      `json:"deviceLocatorServiceEnabled"`
	DeviceOwnershipType                         string                    `json:"deviceOwnershipType"`
	DevicePhoneNumber                           string                    `json:"devicePhoneNumber"`
	DiagnosticAndUsageReportingEnabled          bool                      `json:"diagnosticAndUsageReportingEnabled"`
	DisplayName                                 string                    `json:"displayName"`
	DoNotDisturbEnabled                         bool                      `json:"doNotDisturbEnabled"`
	Eid                                         string                    `json:"eid"`
	EmailAddress                                string                    `json:"emailAddress"`
	EnrollmentSessionTokenValid                 bool                      `json:"enrollmentSessionTokenValid"`
	ExchangeDeviceID                            string                    `json:"exchangeDeviceId"`
	ExtensionAttributeValueList                 []ExtensionAttributeValue `json:"extensionAttributeValueList"`
	FileEncryptionCapable                       bool                      `json:"fileEncryptionCapable"`
	FullName                                    string                    `json:"fullName"`
	HardwareEncryptionSupported                 bool                      `json:"hardwareEncryptionSupported"`
	HomeCarrierNetwork                          string                    `json:"homeCarrierNetwork"`
	HomeMobileCountryCode                       string                    `json:"homeMobileCountryCode"`
	HomeMobileNetworkCode                       string                    `json:"homeMobileNetworkCode"`
	Iccid                                       string                    `json:"iccid"`
	Imei                                        string                    `json:"imei"`
	Imei2                                       string                    `json:"imei2"`
	IPAddress                                   string                    `json:"ipAddress"`
	ItunesStoreAccountActive                    bool                      `json:"itunesStoreAccountActive"`
	JailbreakStatus                             string                    `json:"jailbreakStatus"`
	JamfParentPairings                          int                       `json:"jamfParentPairings"`
	Languages                                   string                    `json:"languages"`
	LastBackupDate                              *time.Time                `json:"lastBackupDate,omitempty"`
	LastCloudBackupDate                         *time.Time                `json:"lastCloudBackupDate,omitempty"`
	LastContactDate                             *time.Time                `json:"lastContactDate,omitempty"`
	LastEnrolledDate                            *time.Time                `json:"lastEnrolledDate,omitempty"`
	LastInventoryUpdateDate                     *time.Time                `json:"lastInventoryUpdateDate,omitempty"`
	LastLoggedInUsernameMDM                     *string                   `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp            *time.Time                `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService             *string                   `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp    *time.Time                `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	LeaseExpirationDate                         *time.Time                `json:"leaseExpirationDate,omitempty"`
	LifeExpectancyYears                         int                       `json:"lifeExpectancyYears"`
	Locales                                     string                    `json:"locales"`
	LocationServicesForSelfServiceMobileEnabled bool                      `json:"locationServicesForSelfServiceMobileEnabled"`
	// Whether Lockdown Mode is enabled.
	LockdownModeEnabled                    bool       `json:"lockdownModeEnabled"`
	LostModeEnabled                        bool       `json:"lostModeEnabled"`
	LostModeEnabledDate                    *time.Time `json:"lostModeEnabledDate,omitempty"`
	Managed                                bool       `json:"managed"`
	ManagementID                           string     `json:"managementId"`
	MDMProfileExpirationDate               *time.Time `json:"mdmProfileExpirationDate,omitempty"`
	Meid                                   string     `json:"meid"`
	MobileDeviceID                         string     `json:"mobileDeviceId"`
	Model                                  string     `json:"model"`
	ModelIdentifier                        string     `json:"modelIdentifier"`
	ModelNumber                            string     `json:"modelNumber"`
	ModemFirmwareVersion                   string     `json:"modemFirmwareVersion"`
	OsBuild                                string     `json:"osBuild"`
	OsRapidSecurityResponse                string     `json:"osRapidSecurityResponse"`
	OsSupplementalBuildVersion             string     `json:"osSupplementalBuildVersion"`
	OsVersion                              string     `json:"osVersion"`
	PairedDevices                          int        `json:"pairedDevices"`
	PasscodeCompliant                      bool       `json:"passcodeCompliant"`
	PasscodeCompliantWithProfile           bool       `json:"passcodeCompliantWithProfile"`
	PasscodeLockGracePeriodEnforcedSeconds int        `json:"passcodeLockGracePeriodEnforcedSeconds"`
	PasscodePresent                        bool       `json:"passcodePresent"`
	// **Deprecated as of 11.25.** This field always returns false.
	PersonalDeviceProfileCurrent bool       `json:"personalDeviceProfileCurrent"`
	PersonalHotspotEnabled       bool       `json:"personalHotspotEnabled"`
	PoDate                       *time.Time `json:"poDate,omitempty"`
	PoNumber                     string     `json:"poNumber"`
	Position                     string     `json:"position"`
	PreferredVoiceNumber         string     `json:"preferredVoiceNumber"`
	PurchasePrice                string     `json:"purchasePrice"`
	PurchasedOrLeased            bool       `json:"purchasedOrLeased"`
	PurchasingAccount            string     `json:"purchasingAccount"`
	PurchasingContact            string     `json:"purchasingContact"`
	QuotaSize                    int        `json:"quotaSize"`
	ResidentUsers                int        `json:"residentUsers"`
	// Whether Return to Service is enabled.
	ReturnToServiceEnabled bool       `json:"returnToServiceEnabled"`
	Roaming                bool       `json:"roaming"`
	Room                   string     `json:"room"`
	SerialNumber           string     `json:"serialNumber"`
	SharedIpad             bool       `json:"sharedIpad"`
	Supervised             bool       `json:"supervised"`
	Tethered               bool       `json:"tethered"`
	TimeZone               string     `json:"timeZone"`
	UDID                   string     `json:"udid"`
	UsedSpacePercentage    int        `json:"usedSpacePercentage"`
	UserPhoneNumber        string     `json:"userPhoneNumber"`
	Username               string     `json:"username"`
	Vendor                 string     `json:"vendor"`
	VoiceRoamingEnabled    string     `json:"voiceRoamingEnabled"`
	WarrantyExpirationDate *time.Time `json:"warrantyExpirationDate,omitempty"`
	WifiMacAddress         string     `json:"wifiMacAddress"`
}

InventoryListMobileDevice represents a inventory list mobile device.

type InventoryListMobileDeviceAppleEnrollmentType 

type InventoryListMobileDeviceAppleEnrollmentType = string

InventoryListMobileDeviceAppleEnrollmentType is the set of values accepted by InventoryListMobileDevice.AppleEnrollmentType. 

const (
	InventoryListMobileDeviceAppleEnrollmentTypeNone       InventoryListMobileDeviceAppleEnrollmentType = "none"
	InventoryListMobileDeviceAppleEnrollmentTypeSupervised InventoryListMobileDeviceAppleEnrollmentType = "supervised"
	InventoryListMobileDeviceAppleEnrollmentTypeDevice     InventoryListMobileDeviceAppleEnrollmentType = "device"
	InventoryListMobileDeviceAppleEnrollmentTypeUser       InventoryListMobileDeviceAppleEnrollmentType = "user"
	InventoryListMobileDeviceAppleEnrollmentTypeUnknown    InventoryListMobileDeviceAppleEnrollmentType = "unknown"
)

InventoryListMobileDeviceAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func InventoryListMobileDeviceAppleEnrollmentTypeValues 

func InventoryListMobileDeviceAppleEnrollmentTypeValues() []InventoryListMobileDeviceAppleEnrollmentType

InventoryListMobileDeviceAppleEnrollmentTypeValues returns every value the Jamf API accepts for InventoryListMobileDeviceAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type InventoryListMobileDeviceBatteryHealth 

type InventoryListMobileDeviceBatteryHealth = string

InventoryListMobileDeviceBatteryHealth is the set of values accepted by InventoryListMobileDevice.BatteryHealth. 

const (
	InventoryListMobileDeviceBatteryHealthNonGenuine         InventoryListMobileDeviceBatteryHealth = "NON_GENUINE"
	InventoryListMobileDeviceBatteryHealthNormal             InventoryListMobileDeviceBatteryHealth = "NORMAL"
	InventoryListMobileDeviceBatteryHealthServiceRecommended InventoryListMobileDeviceBatteryHealth = "SERVICE_RECOMMENDED"
	InventoryListMobileDeviceBatteryHealthUnknown            InventoryListMobileDeviceBatteryHealth = "UNKNOWN"
	InventoryListMobileDeviceBatteryHealthUnsupported        InventoryListMobileDeviceBatteryHealth = "UNSUPPORTED"
)

InventoryListMobileDeviceBatteryHealth values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func InventoryListMobileDeviceBatteryHealthValues 

func InventoryListMobileDeviceBatteryHealthValues() []InventoryListMobileDeviceBatteryHealth

InventoryListMobileDeviceBatteryHealthValues returns every value the Jamf API accepts for InventoryListMobileDeviceBatteryHealth, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type InventoryListMobileDeviceSearchResults 

type InventoryListMobileDeviceSearchResults struct {
	Results    []InventoryListMobileDevice `json:"results"`
	TotalCount int                         `json:"totalCount"`
}

InventoryListMobileDeviceSearchResults represents a inventory list mobile device search results.

type InventoryPreloadCsvValidationError 

type InventoryPreloadCsvValidationError struct {
	Errors []InventoryPreloadCsvValidationErrorCause `json:"errors"`
	// HTTP status of the response.
	HttpStatus int `json:"httpStatus"`
}

InventoryPreloadCsvValidationError represents a inventory preload csv validation error.

type InventoryPreloadCsvValidationErrorCause 

type InventoryPreloadCsvValidationErrorCause struct {
	// Error-specific code that can be used to identify localization string, etc.
	Code string `json:"code"`
	// A general description of error for troubleshooting/debugging. Generally this text should not be
	// displayed to a user; instead refer to errorCode and it's localized text.
	Description string `json:"description"`
	DeviceType  string `json:"deviceType"`
	// Name of the field that caused the error.
	Field     string `json:"field"`
	FieldSize int    `json:"fieldSize"`
	// id of object with error. Optional.
	ID           *string `json:"id,omitempty"`
	Line         int     `json:"line"`
	SerialNumber string  `json:"serialNumber"`
	Value        string  `json:"value"`
}

InventoryPreloadCsvValidationErrorCause represents a inventory preload csv validation error cause.

type InventoryPreloadCsvValidationSuccess 

type InventoryPreloadCsvValidationSuccess struct {
	RecordCount int `json:"recordCount"`
}

InventoryPreloadCsvValidationSuccess represents a inventory preload csv validation success.

type InventoryPreloadExtensionAttribute 

type InventoryPreloadExtensionAttribute struct {
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
}

InventoryPreloadExtensionAttribute represents a inventory preload extension attribute.

type InventoryPreloadExtensionAttributeColumn 

type InventoryPreloadExtensionAttributeColumn struct {
	FullName string `json:"fullName"`
	Name     string `json:"name"`
}

InventoryPreloadExtensionAttributeColumn represents a inventory preload extension attribute column.

type InventoryPreloadExtensionAttributeColumnResult 

type InventoryPreloadExtensionAttributeColumnResult struct {
	Results    []InventoryPreloadExtensionAttributeColumn `json:"results"`
	TotalCount int                                        `json:"totalCount"`
}

InventoryPreloadExtensionAttributeColumnResult represents a inventory preload extension attribute column result.

type InventoryPreloadRecordSearchResultsV2 

type InventoryPreloadRecordSearchResultsV2 struct {
	Results    []InventoryPreloadRecordV2 `json:"results"`
	TotalCount int                        `json:"totalCount"`
}

InventoryPreloadRecordSearchResultsV2 represents a inventory preload record search results v2.

type InventoryPreloadRecordV2 

type InventoryPreloadRecordV2 struct {
	AppleCareID *string `json:"appleCareId,omitempty"`
	AssetTag    *string `json:"assetTag,omitempty"`
	BarCode1    *string `json:"barCode1,omitempty"`
	BarCode2    *string `json:"barCode2,omitempty"`
	Building    *string `json:"building,omitempty"`
	Department  *string `json:"department,omitempty"`
	// Allowed values: see the InventoryPreloadRecordV2DeviceType constants.
	DeviceType          string                                `json:"deviceType"`
	EmailAddress        *string                               `json:"emailAddress,omitempty"`
	ExtensionAttributes *[]InventoryPreloadExtensionAttribute `json:"extensionAttributes,omitempty"`
	FullName            *string                               `json:"fullName,omitempty"`
	ID                  *string                               `json:"id,omitempty"`
	LeaseExpiration     *string                               `json:"leaseExpiration,omitempty"`
	LifeExpectancy      *string                               `json:"lifeExpectancy,omitempty"`
	PhoneNumber         *string                               `json:"phoneNumber,omitempty"`
	PoDate              *string                               `json:"poDate,omitempty"`
	PoNumber            *string                               `json:"poNumber,omitempty"`
	Position            *string                               `json:"position,omitempty"`
	PurchasePrice       *string                               `json:"purchasePrice,omitempty"`
	PurchasingAccount   *string                               `json:"purchasingAccount,omitempty"`
	PurchasingContact   *string                               `json:"purchasingContact,omitempty"`
	Room                *string                               `json:"room,omitempty"`
	SerialNumber        string                                `json:"serialNumber"`
	Username            *string                               `json:"username,omitempty"`
	Vendor              *string                               `json:"vendor,omitempty"`
	WarrantyExpiration  *string                               `json:"warrantyExpiration,omitempty"`
}

InventoryPreloadRecordV2 represents a inventory preload record v2.

type InventoryPreloadRecordV2DeviceType 

type InventoryPreloadRecordV2DeviceType = string

InventoryPreloadRecordV2DeviceType is the set of values accepted by InventoryPreloadRecordV2.DeviceType. 

const (
	InventoryPreloadRecordV2DeviceTypeComputer     InventoryPreloadRecordV2DeviceType = "Computer"
	InventoryPreloadRecordV2DeviceTypeMobileDevice InventoryPreloadRecordV2DeviceType = "Mobile Device"
	InventoryPreloadRecordV2DeviceTypeUnknown      InventoryPreloadRecordV2DeviceType = "Unknown"
)

InventoryPreloadRecordV2DeviceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func InventoryPreloadRecordV2DeviceTypeValues 

func InventoryPreloadRecordV2DeviceTypeValues() []InventoryPreloadRecordV2DeviceType

InventoryPreloadRecordV2DeviceTypeValues returns every value the Jamf API accepts for InventoryPreloadRecordV2DeviceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type IosBrandingConfiguration 

type IosBrandingConfiguration struct {
	BrandingName              string  `json:"brandingName"`
	BrandingNameColorCode     string  `json:"brandingNameColorCode"`
	HeaderBackgroundColorCode string  `json:"headerBackgroundColorCode"`
	IconID                    *int    `json:"iconId,omitempty"`
	ID                        *string `json:"id,omitempty"`
	MenuIconColorCode         string  `json:"menuIconColorCode"`
	StatusBarTextColor        string  `json:"statusBarTextColor"`
}

IosBrandingConfiguration represents a ios branding configuration.

type IosBrandingSearchResults 

type IosBrandingSearchResults struct {
	Results    []IosBrandingConfiguration `json:"results"`
	TotalCount int                        `json:"totalCount"`
}

IosBrandingSearchResults represents a ios branding search results.

type JamfApplicationResponse 

type JamfApplicationResponse struct {
	Artifacts         []JamfPackageResponse `json:"artifacts"`
	DisplayName       string                `json:"displayName"`
	ReleaseHistoryURL string                `json:"releaseHistoryUrl"`
}

JamfApplicationResponse represents a jamf application response.

type JamfPackageResponse 

type JamfPackageResponse struct {
	Created  string `json:"created"`
	Filename string `json:"filename"`
	ID       string `json:"id"`
	URL      string `json:"url"`
	Version  string `json:"version"`
}

JamfPackageResponse represents a jamf package response.

type JamfProInformationV2 

type JamfProInformationV2 struct {
	// **Deprecated as of 11.25.** This field always returns false.
	ByodEnabled             bool `json:"byodEnabled"`
	CloudDeploymentsEnabled bool `json:"cloudDeploymentsEnabled"`
	DepAccountEnabled       bool `json:"depAccountEnabled"`
	PatchEnabled            bool `json:"patchEnabled"`
	SmtpEnabled             bool `json:"smtpEnabled"`
	SsoSamlEnabled          bool `json:"ssoSamlEnabled"`
	UserMigrationEnabled    bool `json:"userMigrationEnabled"`
	VppTokenEnabled         bool `json:"vppTokenEnabled"`
}

JamfProInformationV2 represents a jamf pro information v2.

type JamfProServerURL 

type JamfProServerURL struct {
	URL string `json:"url"`
}

JamfProServerURL represents a jamf pro server u r l.

type JamfProVersion 

type JamfProVersion struct {
	Version string `json:"version"`
}

JamfProVersion represents a jamf pro version.

type JamfProtectPlan 

type JamfProtectPlan struct {
	Description      string `json:"description"`
	ID               string `json:"id"`
	Name             string `json:"name"`
	ProfileID        int    `json:"profileId"`
	ProfileName      string `json:"profileName"`
	ProfileVersion   int    `json:"profileVersion"`
	ScopeDescription string `json:"scopeDescription"`
	SiteID           string `json:"siteId"`
	UUID             string `json:"uuid"`
}

JamfProtectPlan represents a jamf protect plan.

type LanguageCode 

type LanguageCode struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

LanguageCode represents a language code.

type LapsAccountManagementHistory 

type LapsAccountManagementHistory struct {
	EventTime *time.Time `json:"eventTime,omitempty"`
	// Allowed values: see the LapsAccountManagementHistoryEventType constants.
	EventType string `json:"eventType"`
	// Allowed values: see the LapsAccountManagementHistoryUserSource constants.
	UserSource string  `json:"userSource"`
	Username   string  `json:"username"`
	ViewedBy   *string `json:"viewedBy,omitempty"`
}

LapsAccountManagementHistory represents a laps account management history.

type LapsAccountManagementHistoryEventType 

type LapsAccountManagementHistoryEventType = string

LapsAccountManagementHistoryEventType is the set of values accepted by LapsAccountManagementHistory.EventType. 

const (
	LapsAccountManagementHistoryEventTypePending   LapsAccountManagementHistoryEventType = "PENDING"
	LapsAccountManagementHistoryEventTypeCompleted LapsAccountManagementHistoryEventType = "COMPLETED"
	LapsAccountManagementHistoryEventTypeViewed    LapsAccountManagementHistoryEventType = "VIEWED"
	LapsAccountManagementHistoryEventTypeError     LapsAccountManagementHistoryEventType = "ERROR"
	LapsAccountManagementHistoryEventTypeInvalid   LapsAccountManagementHistoryEventType = "INVALID"
)

LapsAccountManagementHistoryEventType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func LapsAccountManagementHistoryEventTypeValues 

func LapsAccountManagementHistoryEventTypeValues() []LapsAccountManagementHistoryEventType

LapsAccountManagementHistoryEventTypeValues returns every value the Jamf API accepts for LapsAccountManagementHistoryEventType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type LapsAccountManagementHistoryResponse 

type LapsAccountManagementHistoryResponse struct {
	Results    []LapsAccountManagementHistory `json:"results"`
	TotalCount int                            `json:"totalCount"`
}

LapsAccountManagementHistoryResponse represents a laps account management history response.

type LapsAccountManagementHistoryUserSource 

type LapsAccountManagementHistoryUserSource = string

LapsAccountManagementHistoryUserSource is the set of values accepted by LapsAccountManagementHistory.UserSource. 

const (
	LapsAccountManagementHistoryUserSourceMDM LapsAccountManagementHistoryUserSource = "MDM"
	LapsAccountManagementHistoryUserSourceJmf LapsAccountManagementHistoryUserSource = "JMF"
)

LapsAccountManagementHistoryUserSource values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func LapsAccountManagementHistoryUserSourceValues 

func LapsAccountManagementHistoryUserSourceValues() []LapsAccountManagementHistoryUserSource

LapsAccountManagementHistoryUserSourceValues returns every value the Jamf API accepts for LapsAccountManagementHistoryUserSource, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type LapsAuditV2 

type LapsAuditV2 struct {
	DateSeen *time.Time `json:"dateSeen,omitempty"`
	ViewedBy *string    `json:"viewedBy,omitempty"`
}

LapsAuditV2 represents a laps audit v2.

type LapsHistory 

type LapsHistory struct {
	CreatedDate    *time.Time `json:"createdDate,omitempty"`
	DateLastSeen   *time.Time `json:"dateLastSeen,omitempty"`
	ExpirationTime *time.Time `json:"expirationTime,omitempty"`
	// Allowed values: see the LapsHistoryRotationStatus constants.
	RotationStatus string `json:"rotationStatus"`
}

LapsHistory represents a laps history.

type LapsHistoryResponse 

type LapsHistoryResponse struct {
	Results    []LapsHistory `json:"results"`
	TotalCount int           `json:"totalCount"`
}

LapsHistoryResponse represents a laps history response.

type LapsHistoryRotationStatus 

type LapsHistoryRotationStatus = string

LapsHistoryRotationStatus is the set of values accepted by LapsHistory.RotationStatus. 

const (
	LapsHistoryRotationStatusPending   LapsHistoryRotationStatus = "PENDING"
	LapsHistoryRotationStatusCompleted LapsHistoryRotationStatus = "COMPLETED"
	LapsHistoryRotationStatusViewed    LapsHistoryRotationStatus = "VIEWED"
	LapsHistoryRotationStatusError     LapsHistoryRotationStatus = "ERROR"
	LapsHistoryRotationStatusInvalid   LapsHistoryRotationStatus = "INVALID"
)

LapsHistoryRotationStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func LapsHistoryRotationStatusValues 

func LapsHistoryRotationStatusValues() []LapsHistoryRotationStatus

LapsHistoryRotationStatusValues returns every value the Jamf API accepts for LapsHistoryRotationStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type LapsPasswordAndAuditsV2 

type LapsPasswordAndAuditsV2 struct {
	Audits         []LapsAuditV2 `json:"audits"`
	DateLastSeen   *time.Time    `json:"dateLastSeen,omitempty"`
	ExpirationTime *time.Time    `json:"expirationTime,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
}

LapsPasswordAndAuditsV2 represents a laps password and audits v2.

type LapsPasswordAuditsResultsV2 

type LapsPasswordAuditsResultsV2 struct {
	Results    []LapsPasswordAndAuditsV2 `json:"results"`
	TotalCount int                       `json:"totalCount"`
}

LapsPasswordAuditsResultsV2 represents a laps password audits results v2.

type LapsPasswordResponseV2 

type LapsPasswordResponseV2 struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
}

LapsPasswordResponseV2 represents a laps password response v2.

type LapsPendingRotation 

type LapsPendingRotation struct {
	CreatedDate *time.Time  `json:"createdDate,omitempty"`
	LapsUser    *LapsUserV2 `json:"lapsUser,omitempty"`
}

LapsPendingRotation represents a laps pending rotation.

type LapsPendingRotationResponse 

type LapsPendingRotationResponse struct {
	Results    []LapsPendingRotation `json:"results"`
	TotalCount int                   `json:"totalCount"`
}

LapsPendingRotationResponse represents a laps pending rotation response.

type LapsSettingsRequestV2 

type LapsSettingsRequestV2 struct {
	// When enabled, all appropriate computers will have the SetAutoAdminPassword command sent to them
	// automatically.
	AutoDeployEnabled bool `json:"autoDeployEnabled"`
	// When enabled, all appropriate computers will automatically have their password expired and rotated
	// after the configured autoRotateExpirationTime.
	AutoRotateEnabled bool `json:"autoRotateEnabled"`
	// The amount of time in seconds that the local admin password will be rotated automatically if it is
	// never viewed.
	AutoRotateExpirationTime int `json:"autoRotateExpirationTime"`
	// The amount of time in seconds that the local admin password will be rotated after viewing.
	PasswordRotationTime int `json:"passwordRotationTime"`
}

LapsSettingsRequestV2 represents a laps settings request v2.

type LapsSettingsResponseV2 

type LapsSettingsResponseV2 struct {
	// When enabled, all appropriate computers will have the SetAutoAdminPassword command sent to them
	// automatically.
	AutoDeployEnabled bool `json:"autoDeployEnabled"`
	// When enabled, all appropriate computers will automatically have their password expired and rotated
	// after the configured autoRotateExpirationTime.
	AutoRotateEnabled bool `json:"autoRotateEnabled"`
	// The amount of time in seconds that the local admin password will be rotated automatically if it is
	// never viewed.
	AutoRotateExpirationTime int `json:"autoRotateExpirationTime"`
	// The amount of time in seconds that the local admin password will be rotated after viewing.
	PasswordRotationTime int `json:"passwordRotationTime"`
}

LapsSettingsResponseV2 represents a laps settings response v2.

type LapsUserPasswordRequestV2 

type LapsUserPasswordRequestV2 struct {
	LapsUserPasswordList *[]LapsUserPasswordV2 `json:"lapsUserPasswordList,omitempty"`
}

LapsUserPasswordRequestV2 represents a laps user password request v2.

type LapsUserPasswordResponseV2 

type LapsUserPasswordResponseV2 struct {
	LapsUserPasswordList []LapsUserPasswordV2 `json:"lapsUserPasswordList"`
}

LapsUserPasswordResponseV2 represents a laps user password response v2.

type LapsUserPasswordV2 

type LapsUserPasswordV2 struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password *string `json:"password,omitempty"`
	Username *string `json:"username,omitempty"`
}

LapsUserPasswordV2 represents a laps user password v2.

type LapsUserResultsV2 

type LapsUserResultsV2 struct {
	Results    []LapsUserV2 `json:"results"`
	TotalCount int          `json:"totalCount"`
}

LapsUserResultsV2 represents a laps user results v2.

type LapsUserV2 

type LapsUserV2 struct {
	ClientManagementID string `json:"clientManagementId"`
	Guid               string `json:"guid"`
	// Allowed values: see the LapsUserV2UserSource constants.
	UserSource string `json:"userSource"`
	Username   string `json:"username"`
}

LapsUserV2 represents a laps user v2.

type LapsUserV2UserSource 

type LapsUserV2UserSource = string

LapsUserV2UserSource is the set of values accepted by LapsUserV2.UserSource. 

const (
	LapsUserV2UserSourceMDM LapsUserV2UserSource = "MDM"
	LapsUserV2UserSourceJmf LapsUserV2UserSource = "JMF"
)

LapsUserV2UserSource values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func LapsUserV2UserSourceValues 

func LapsUserV2UserSourceValues() []LapsUserV2UserSource

LapsUserV2UserSourceValues returns every value the Jamf API accepts for LapsUserV2UserSource, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type LastLoginResponse 

type LastLoginResponse struct {
	// Timestamp of the last login (ISO 8601 format).
	LastLogin time.Time `json:"lastLogin"`
}

LastLoginResponse represents a last login response.

type LdapConfigurationRequest 

type LdapConfigurationRequest struct {
	// A Cloud Identity Provider information for request.
	CloudIDPCommon CloudIDPCommonRequest `json:"cloudIdPCommon"`
	// Mappings configurations request for Ldap Cloud Identity Provider configuration.
	Mappings *CloudLdapMappingsRequest `json:"mappings,omitempty"`
	// A Cloud Identity Provider LDAP server configuration for requests.
	Server CloudLdapServerRequest `json:"server"`
}

LdapConfigurationRequest A Cloud Identity Provider LDAP configuration for requests.

type LdapConfigurationResponse 

type LdapConfigurationResponse struct {
	// A Cloud Identity Provider information.
	CloudIDPCommon *CloudIDPCommon `json:"cloudIdPCommon,omitempty"`
	// Mappings configuration response for Ldap Cloud Identity Provider configuration.
	Mappings *CloudLdapMappingsResponse `json:"mappings,omitempty"`
	// A Cloud Identity Provider LDAP server configuration for responses.
	Server *CloudLdapServerResponse `json:"server,omitempty"`
}

LdapConfigurationResponse A Cloud Identity Provider LDAP configuration for responses.

type LdapConfigurationUpdate 

type LdapConfigurationUpdate struct {
	// A Cloud Identity Provider information.
	CloudIDPCommon CloudIDPCommon `json:"cloudIdPCommon"`
	// Mappings configurations request for Ldap Cloud Identity Provider configuration.
	Mappings *CloudLdapMappingsRequest `json:"mappings,omitempty"`
	// A Cloud Identity Provider LDAP server configuration for updates.
	Server CloudLdapServerUpdate `json:"server"`
}

LdapConfigurationUpdate A Cloud Identity Provider LDAP configuration for updates.

type LdapGroup 

type LdapGroup struct {
	DistinguishedName string `json:"distinguishedName"`
	ID                string `json:"id"`
	LdapServerID      int    `json:"ldapServerId"`
	Name              string `json:"name"`
	UUID              string `json:"uuid"`
}

LdapGroup An LDAP group.

type LdapGroupSearchResults 

type LdapGroupSearchResults struct {
	Results    []LdapGroup `json:"results"`
	TotalCount int         `json:"totalCount"`
}

LdapGroupSearchResults represents a ldap group search results.

type LdapServer 

type LdapServer struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

LdapServer An LDAP Server.

type LinkedConnectProfile 

type LinkedConnectProfile struct {
	// Determines how the server will behave regarding application updates and installs on the devices that
	// have the configuration profile installed. * `PATCH_UPDATES` - Server handles initial installation of
	// the application and any patch updates. * `MINOR_AND_PATCH_UPDATES` - Server handles initial
	// installation of the application and any patch and minor updates. * `INITIAL_INSTALLATION_ONLY` -
	// Server only handles initial installation of the application. Updates will have to be done manually.
	// * `NONE` - Server does not handle any installations or updates for the application. Version is
	// ignored for this type.
	// Allowed values: see the LinkedConnectProfileAutoDeploymentType constants.
	AutoDeploymentType *string `json:"autoDeploymentType,omitempty"`
	ProfileID          *int    `json:"profileId"`
	ProfileName        *string `json:"profileName,omitempty"`
	ScopeDescription   *string `json:"scopeDescription,omitempty"`
	SiteID             *string `json:"siteId,omitempty"`
	UUID               *string `json:"uuid,omitempty"`
	// Must be a valid Jamf Connect version 2.3.0 or higher. Versions are listed here
	// `https://www.jamf.com/resources/product-documentation/jamf-connect-administrators-guide/`.
	Version *string `json:"version,omitempty"`
}

LinkedConnectProfile represents a linked connect profile.

type LinkedConnectProfileAutoDeploymentType 

type LinkedConnectProfileAutoDeploymentType = string

LinkedConnectProfileAutoDeploymentType is the set of values accepted by LinkedConnectProfile.AutoDeploymentType. 

const (
	LinkedConnectProfileAutoDeploymentTypePatchUpdates            LinkedConnectProfileAutoDeploymentType = "PATCH_UPDATES"
	LinkedConnectProfileAutoDeploymentTypeMinorAndPatchUpdates    LinkedConnectProfileAutoDeploymentType = "MINOR_AND_PATCH_UPDATES"
	LinkedConnectProfileAutoDeploymentTypeInitialInstallationOnly LinkedConnectProfileAutoDeploymentType = "INITIAL_INSTALLATION_ONLY"
	LinkedConnectProfileAutoDeploymentTypeNone                    LinkedConnectProfileAutoDeploymentType = "NONE"
)

LinkedConnectProfileAutoDeploymentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func LinkedConnectProfileAutoDeploymentTypeValues 

func LinkedConnectProfileAutoDeploymentTypeValues() []LinkedConnectProfileAutoDeploymentType

LinkedConnectProfileAutoDeploymentTypeValues returns every value the Jamf API accepts for LinkedConnectProfileAutoDeploymentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type LinkedConnectProfileSearchResults 

type LinkedConnectProfileSearchResults struct {
	Results    []LinkedConnectProfile `json:"results"`
	TotalCount int                    `json:"totalCount"`
}

LinkedConnectProfileSearchResults represents a linked connect profile search results.

type Locale 

type Locale struct {
	Description string `json:"description"`
	Identifier  string `json:"identifier"`
}

Locale represents a locale.

type LocationInformationV2 

type LocationInformationV2 struct {
	BuildingID   string `json:"buildingId"`
	DepartmentID string `json:"departmentId"`
	Email        string `json:"email"`
	ID           string `json:"id"`
	Phone        string `json:"phone"`
	Position     string `json:"position"`
	Realname     string `json:"realname"`
	Room         string `json:"room"`
	Username     string `json:"username"`
	VersionLock  int    `json:"versionLock"`
}

LocationInformationV2 represents a location information v2.

type LocationInformationV3 

type LocationInformationV3 struct {
	BuildingID   string `json:"buildingId"`
	DepartmentID string `json:"departmentId"`
	Email        string `json:"email"`
	ID           string `json:"id"`
	Phone        string `json:"phone"`
	Position     string `json:"position"`
	Realname     string `json:"realname"`
	Room         string `json:"room"`
	Username     string `json:"username"`
	VersionLock  int    `json:"versionLock"`
}

LocationInformationV3 represents a location information v3.

type LocationV2 

type LocationV2 struct {
	BuildingID   *string `json:"buildingId,omitempty"`
	DepartmentID *string `json:"departmentId,omitempty"`
	EmailAddress *string `json:"emailAddress,omitempty"`
	PhoneNumber  *string `json:"phoneNumber,omitempty"`
	Position     *string `json:"position,omitempty"`
	RealName     *string `json:"realName,omitempty"`
	Room         *string `json:"room,omitempty"`
	Username     *string `json:"username,omitempty"`
}

LocationV2 represents a location v2.

type LogFlushingTaskV1 

type LogFlushingTaskV1 struct {
	// The unique identifier of the log flushing task.
	ID *string `json:"id,omitempty"`
	// The qualifier of the retention policy.
	Qualifier string `json:"qualifier"`
	// The period beyond which data will be flushed.
	RetentionPeriod int `json:"retentionPeriod"`
	// The unit of the retention period (eg: DAY, WEEK, MONTH, YEAR).
	RetentionPeriodUnit string `json:"retentionPeriodUnit"`
	// The state of the task (eg: RUNNING, SUCCESS, FAILED, CANCELLED).
	State *string `json:"state,omitempty"`
}

LogFlushingTaskV1 represents a log flushing task v1.

type LogFlushingV1 

type LogFlushingV1 struct {
	HourOfDay         int                 `json:"hourOfDay"`
	RetentionPolicies []RetentionPolicyV1 `json:"retentionPolicies"`
}

LogFlushingV1 represents a log flushing v1.

type LoginContent 

type LoginContent struct {
	ActionText              string `json:"actionText"`
	DisclaimerHeading       string `json:"disclaimerHeading"`
	DisclaimerMainText      string `json:"disclaimerMainText"`
	FedRampInstance         bool   `json:"fedRampInstance"`
	HighComplianceInstance  bool   `json:"highComplianceInstance"`
	IncludeCustomDisclaimer bool   `json:"includeCustomDisclaimer"`
	RampInstance            bool   `json:"rampInstance"`
}

LoginContent represents a login content.

type LoginContentPut 

type LoginContentPut struct {
	ActionText              *string `json:"actionText,omitempty"`
	DisclaimerHeading       *string `json:"disclaimerHeading,omitempty"`
	DisclaimerMainText      *string `json:"disclaimerMainText,omitempty"`
	IncludeCustomDisclaimer bool    `json:"includeCustomDisclaimer"`
}

LoginContentPut represents a login content put.

type M2mTenantIDInfo 

type M2mTenantIDInfo struct {
	// The M2M-sourced tenant ID.
	TenantID *string `json:"tenantId,omitempty"`
}

M2mTenantIDInfo represents a m2m tenant i d info.

type MDMClientType 

type MDMClientType = string

MDMClientType represents a m d m client type value. 

const (
	MDMClientTypeMobileDevice     MDMClientType = "MOBILE_DEVICE"
	MDMClientTypeTv               MDMClientType = "TV"
	MDMClientTypeVisionPro        MDMClientType = "VISION_PRO"
	MDMClientTypeWatch            MDMClientType = "WATCH"
	MDMClientTypeComputer         MDMClientType = "COMPUTER"
	MDMClientTypeComputerUser     MDMClientType = "COMPUTER_USER"
	MDMClientTypeMobileDeviceUser MDMClientType = "MOBILE_DEVICE_USER"
	MDMClientTypeUnknown          MDMClientType = "UNKNOWN"
)

MDMClientType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MDMClientTypeValues 

func MDMClientTypeValues() []MDMClientType

MDMClientTypeValues returns every value the Jamf API accepts for MDMClientType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MDMCommand 

type MDMCommand struct {
	Client        *MDMCommandClient `json:"client,omitempty"`
	CommandError  *MDMCommandError  `json:"commandError,omitempty"`
	CommandState  *MDMCommandState  `json:"commandState,omitempty"`
	CommandType   *MDMCommandType   `json:"commandType,omitempty"`
	DateCompleted *time.Time        `json:"dateCompleted,omitempty"`
	DateSent      *time.Time        `json:"dateSent,omitempty"`
	ProfileID     int               `json:"profileId"`
	UUID          string            `json:"uuid"`
}

MDMCommand represents a m d m command.

type MDMCommandClient 

type MDMCommandClient struct {
	ClientType   *MDMClientType `json:"clientType,omitempty"`
	ManagementID string         `json:"managementId"`
}

MDMCommandClient represents a m d m command client.

type MDMCommandError 

type MDMCommandError struct {
	ErrorCode                 int    `json:"errorCode"`
	ErrorDomain               string `json:"errorDomain"`
	ErrorEnglishDescription   string `json:"errorEnglishDescription"`
	ErrorLocalizedDescription string `json:"errorLocalizedDescription"`
}

MDMCommandError represents a m d m command error.

type MDMCommandResults 

type MDMCommandResults struct {
	Results    []MDMCommand `json:"results"`
	TotalCount int          `json:"totalCount"`
}

MDMCommandResults represents a m d m command results.

type MDMCommandState 

type MDMCommandState = string

MDMCommandState represents a m d m command state value. 

const (
	MDMCommandStatePending            MDMCommandState = "PENDING"
	MDMCommandStateAcknowledged       MDMCommandState = "ACKNOWLEDGED"
	MDMCommandStateNotNow             MDMCommandState = "NOT_NOW"
	MDMCommandStateError              MDMCommandState = "ERROR"
	MDMCommandStateCommandFormatError MDMCommandState = "COMMAND_FORMAT_ERROR"
)

MDMCommandState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MDMCommandStateValues 

func MDMCommandStateValues() []MDMCommandState

MDMCommandStateValues returns every value the Jamf API accepts for MDMCommandState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MDMCommandType 

type MDMCommandType = string

MDMCommandType represents a m d m command type value. 

const (
	MDMCommandTypeApplyRedemptionCode          MDMCommandType = "APPLY_REDEMPTION_CODE"
	MDMCommandTypeCancelEnhancedLogCollection  MDMCommandType = "CANCEL_ENHANCED_LOG_COLLECTION"
	MDMCommandTypeCertificateList              MDMCommandType = "CERTIFICATE_LIST"
	MDMCommandTypeClearPasscode                MDMCommandType = "CLEAR_PASSCODE"
	MDMCommandTypeClearRestrictionsPassword    MDMCommandType = "CLEAR_RESTRICTIONS_PASSWORD"
	MDMCommandTypeDeclarativeManagement        MDMCommandType = "DECLARATIVE_MANAGEMENT"
	MDMCommandTypeDeleteUser                   MDMCommandType = "DELETE_USER"
	MDMCommandTypeDeviceInformation            MDMCommandType = "DEVICE_INFORMATION"
	MDMCommandTypeDeviceLocation               MDMCommandType = "DEVICE_LOCATION"
	MDMCommandTypeDeviceLock                   MDMCommandType = "DEVICE_LOCK"
	MDMCommandTypeDisableLostMode              MDMCommandType = "DISABLE_LOST_MODE"
	MDMCommandTypeDisableRemoteDesktop         MDMCommandType = "DISABLE_REMOTE_DESKTOP"
	MDMCommandTypeEnableLostMode               MDMCommandType = "ENABLE_LOST_MODE"
	MDMCommandTypeEnableRemoteDesktop          MDMCommandType = "ENABLE_REMOTE_DESKTOP"
	MDMCommandTypeEraseDevice                  MDMCommandType = "ERASE_DEVICE"
	MDMCommandTypeInstalledApplicationList     MDMCommandType = "INSTALLED_APPLICATION_LIST"
	MDMCommandTypeLogOutUser                   MDMCommandType = "LOG_OUT_USER"
	MDMCommandTypeManagedApplicationList       MDMCommandType = "MANAGED_APPLICATION_LIST"
	MDMCommandTypeManagedMediaList             MDMCommandType = "MANAGED_MEDIA_LIST"
	MDMCommandTypeRefreshCellularPlans         MDMCommandType = "REFRESH_CELLULAR_PLANS"
	MDMCommandTypePlayLostModeSound            MDMCommandType = "PLAY_LOST_MODE_SOUND"
	MDMCommandTypeProfileList                  MDMCommandType = "PROFILE_LIST"
	MDMCommandTypeProvisioningProfileList      MDMCommandType = "PROVISIONING_PROFILE_LIST"
	MDMCommandTypeRestartDevice                MDMCommandType = "RESTART_DEVICE"
	MDMCommandTypeRequestMirroring             MDMCommandType = "REQUEST_MIRRORING"
	MDMCommandTypeSecurityInfo                 MDMCommandType = "SECURITY_INFO"
	MDMCommandTypeSettings                     MDMCommandType = "SETTINGS"
	MDMCommandTypeSetAutoAdminPassword         MDMCommandType = "SET_AUTO_ADMIN_PASSWORD"
	MDMCommandTypeSetRecoveryLock              MDMCommandType = "SET_RECOVERY_LOCK"
	MDMCommandTypeShutDownDevice               MDMCommandType = "SHUT_DOWN_DEVICE"
	MDMCommandTypeStopMirroring                MDMCommandType = "STOP_MIRRORING"
	MDMCommandTypeTriggerEnhancedLogCollection MDMCommandType = "TRIGGER_ENHANCED_LOG_COLLECTION"
	MDMCommandTypeUnlockUserAccount            MDMCommandType = "UNLOCK_USER_ACCOUNT"
	MDMCommandTypeValidateApplications         MDMCommandType = "VALIDATE_APPLICATIONS"
	MDMCommandTypeVerifyRecoveryLock           MDMCommandType = "VERIFY_RECOVERY_LOCK"
)

MDMCommandType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MDMCommandTypeValues 

func MDMCommandTypeValues() []MDMCommandType

MDMCommandTypeValues returns every value the Jamf API accepts for MDMCommandType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MDMRenewalError 

type MDMRenewalError struct {
	// The client management ID associated with this error.
	ClientManagementID string `json:"clientManagementId"`
	// Timestamp when the error occurred (ISO 8601 format).
	ErrorTimeStamp *time.Time `json:"errorTimeStamp,omitempty"`
	// Number of times this error has occurred.
	FailureCount int `json:"failureCount"`
	// Unique identifier for the MDM renewal error.
	MDMRenewalErrorID string `json:"mdmRenewalErrorId"`
	// Type of MDM renewal error.
	MDMRenewalErrorType MDMRenewalErrorType `json:"mdmRenewalErrorType"`
}

MDMRenewalError represents a m d m renewal error.

type MDMRenewalErrorStrategiesResponse 

type MDMRenewalErrorStrategiesResponse struct {
	Error *MDMRenewalError `json:"error,omitempty"`
	// List of renewal strategies associated with this error.
	Strategies []MDMRenewalStrategy `json:"strategies"`
}

MDMRenewalErrorStrategiesResponse represents a m d m renewal error strategies response.

type MDMRenewalErrorType 

type MDMRenewalErrorType = string

MDMRenewalErrorType represents a m d m renewal error type value. 

const (
	MDMRenewalErrorTypeServerError  MDMRenewalErrorType = "SERVER_ERROR"
	MDMRenewalErrorTypeCheckInError MDMRenewalErrorType = "CHECK_IN_ERROR"
	MDMRenewalErrorTypeOther        MDMRenewalErrorType = "OTHER"
)

MDMRenewalErrorType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MDMRenewalErrorTypeValues 

func MDMRenewalErrorTypeValues() []MDMRenewalErrorType

MDMRenewalErrorTypeValues returns every value the Jamf API accepts for MDMRenewalErrorType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MDMRenewalStrategy 

type MDMRenewalStrategy struct {
	// Unique identifier for the renewal strategy.
	ID string `json:"id"`
	// URL for MDM renewal check-in.
	MDMRenewalCheckInURL string `json:"mdmRenewalCheckInUrl"`
	// The MDM renewal error ID this strategy is associated with.
	MDMRenewalErrorID string `json:"mdmRenewalErrorId"`
	// URL for MDM renewal server.
	MDMRenewalServerURL string `json:"mdmRenewalServerUrl"`
	// Type of MDM renewal strategy.
	MDMRenewalStrategyType MDMRenewalStrategyType `json:"mdmRenewalStrategyType"`
	// Timestamp when this renewal strategy was created (ISO 8601 format).
	StrategyTimeStamp *time.Time `json:"strategyTimeStamp,omitempty"`
}

MDMRenewalStrategy represents a m d m renewal strategy.

type MDMRenewalStrategyType 

type MDMRenewalStrategyType = string

MDMRenewalStrategyType represents a m d m renewal strategy type value. 

const (
	MDMRenewalStrategyTypeReturnNoCheckInInvitation                           MDMRenewalStrategyType = "RETURN_NO_CHECK_IN_INVITATION"
	MDMRenewalStrategyTypeReturnCheckInInvitationFromMDMInvitationTable       MDMRenewalStrategyType = "RETURN_CHECK_IN_INVITATION_FROM_MDM_INVITATION_TABLE"
	MDMRenewalStrategyTypeReturnCheckInInvitationFromEnrollmentUsageTable     MDMRenewalStrategyType = "RETURN_CHECK_IN_INVITATION_FROM_ENROLLMENT_USAGE_TABLE"
	MDMRenewalStrategyTypeReturnCheckInInvitationFromMDMProfilePrototypeTable MDMRenewalStrategyType = "RETURN_CHECK_IN_INVITATION_FROM_MDM_PROFILE_PROTOTYPE_TABLE"
	MDMRenewalStrategyTypeJssURLOverride                                      MDMRenewalStrategyType = "JSS_URL_OVERRIDE"
	MDMRenewalStrategyTypePayloadIdentifier                                   MDMRenewalStrategyType = "PAYLOAD_IDENTIFIER"
)

MDMRenewalStrategyType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MDMRenewalStrategyTypeValues 

func MDMRenewalStrategyTypeValues() []MDMRenewalStrategyType

MDMRenewalStrategyTypeValues returns every value the Jamf API accepts for MDMRenewalStrategyType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MacOsBrandingConfiguration 

type MacOsBrandingConfiguration struct {
	ApplicationName       *string `json:"applicationName,omitempty"`
	BrandingHeaderImageID *int    `json:"brandingHeaderImageId,omitempty"`
	BrandingName          *string `json:"brandingName,omitempty"`
	BrandingNameSecondary *string `json:"brandingNameSecondary,omitempty"`
	HomeHeading           *string `json:"homeHeading,omitempty"`
	HomeSubheading        *string `json:"homeSubheading,omitempty"`
	IconID                *int    `json:"iconId,omitempty"`
	ID                    *string `json:"id,omitempty"`
}

MacOsBrandingConfiguration represents a mac os branding configuration.

type MacOsBrandingSearchResults 

type MacOsBrandingSearchResults struct {
	Results    []MacOsBrandingConfiguration `json:"results"`
	TotalCount int                          `json:"totalCount"`
}

MacOsBrandingSearchResults represents a mac os branding search results.

type MacOsManagedSoftwareUpdate 

type MacOsManagedSoftwareUpdate struct {
	// ApplyMajorUpdate setting is available only when updating to the latest version based on device
	// eligibility. If no value is provided, the calculated latest version will only include minor version
	// updates. If a value is provided, the calculated latest version will include minor and major version
	// updates.
	ApplyMajorUpdate *bool     `json:"applyMajorUpdate,omitempty"`
	DeviceIds        *[]string `json:"deviceIds,omitempty"`
	// If not set, forceRestart will default to false. Can only be true if using the DownloadAndInstall
	// install action and the devices the command is sent to are on macOs 11 or higher. If true, the
	// DownloadAndInstall action is performed, a restart will be forced. MaxDeferral will be ignored if
	// defined.
	ForceRestart *bool   `json:"forceRestart,omitempty"`
	GroupID      *string `json:"groupId,omitempty"`
	// Allow users to defer the update the provided number of times before macOS forces the update. If a
	// value is provided, the Software Update will use the InstallLater install action.
	MaxDeferrals *int `json:"maxDeferrals,omitempty"`
	// Priority can only be configured on macOS 12.3 and above, for minor updates only. Any version below
	// 12.3 is always Low and cannot be changed until prerequisites are met. When qualified, if not
	// explicitly set, priority will default to High.
	// Allowed values: see the MacOsManagedSoftwareUpdatePriority constants.
	Priority *string `json:"priority,omitempty"`
	// If no value is provided, the skipVersionVerification will default to false. If a value is provided,
	// the specified version will be forced to complete DownloadAndInstall install action.
	SkipVersionVerification *bool `json:"skipVersionVerification,omitempty"`
	// MaxDeferral is ignored if using the DownloadOnly install action.
	// Allowed values: see the MacOsManagedSoftwareUpdateUpdateAction constants.
	UpdateAction *string `json:"updateAction,omitempty"`
	// If no value is provided, the version will default to latest version based on device eligibility.
	Version *string `json:"version,omitempty"`
}

MacOsManagedSoftwareUpdate represents a mac os managed software update.

type MacOsManagedSoftwareUpdatePriority 

type MacOsManagedSoftwareUpdatePriority = string

MacOsManagedSoftwareUpdatePriority is the set of values accepted by MacOsManagedSoftwareUpdate.Priority. 

const (
	MacOsManagedSoftwareUpdatePriorityHigh MacOsManagedSoftwareUpdatePriority = "HIGH"
	MacOsManagedSoftwareUpdatePriorityLow  MacOsManagedSoftwareUpdatePriority = "LOW"
)

MacOsManagedSoftwareUpdatePriority values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MacOsManagedSoftwareUpdatePriorityValues 

func MacOsManagedSoftwareUpdatePriorityValues() []MacOsManagedSoftwareUpdatePriority

MacOsManagedSoftwareUpdatePriorityValues returns every value the Jamf API accepts for MacOsManagedSoftwareUpdatePriority, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MacOsManagedSoftwareUpdateResponse 

type MacOsManagedSoftwareUpdateResponse struct {
	Errors              []ApiErrorCause `json:"errors"`
	ProcessManagerUuids []string        `json:"processManagerUuids"`
}

MacOsManagedSoftwareUpdateResponse represents a mac os managed software update response.

type MacOsManagedSoftwareUpdateUpdateAction 

type MacOsManagedSoftwareUpdateUpdateAction = string

MacOsManagedSoftwareUpdateUpdateAction is the set of values accepted by MacOsManagedSoftwareUpdate.UpdateAction. 

const (
	MacOsManagedSoftwareUpdateUpdateActionDownloadAndInstall MacOsManagedSoftwareUpdateUpdateAction = "DOWNLOAD_AND_INSTALL"
	MacOsManagedSoftwareUpdateUpdateActionDownloadOnly       MacOsManagedSoftwareUpdateUpdateAction = "DOWNLOAD_ONLY"
)

MacOsManagedSoftwareUpdateUpdateAction values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MacOsManagedSoftwareUpdateUpdateActionValues 

func MacOsManagedSoftwareUpdateUpdateActionValues() []MacOsManagedSoftwareUpdateUpdateAction

MacOsManagedSoftwareUpdateUpdateActionValues returns every value the Jamf API accepts for MacOsManagedSoftwareUpdateUpdateAction, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdatePlan 

type ManagedSoftwareUpdatePlan struct {
	// Optional. Indicates the build version to update to. Only available when the version type is set to
	// custom version.
	BuildVersion *string     `json:"buildVersion,omitempty"`
	Device       *PlanDevice `json:"device,omitempty"`
	// Optional. Indicates the local date and time of the device to force update by.
	ForceInstallLocalDateTime *string `json:"forceInstallLocalDateTime,omitempty"`
	// Not applicable to all managed software update plans.
	MaxDeferrals int    `json:"maxDeferrals"`
	PlanUUID     string `json:"planUuid"`
	// The id of the recipe that was used to generate the plan.
	RecipeID string `json:"recipeId"`
	// Optional. Indicates the specific version to update to. Only available when the version type is set
	// to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.
	SpecificVersion string      `json:"specificVersion"`
	Status          *PlanStatus `json:"status,omitempty"`
	// Allowed values: see the ManagedSoftwareUpdatePlanUpdateAction constants.
	UpdateAction string `json:"updateAction"`
	// Allowed values: see the ManagedSoftwareUpdatePlanVersionType constants.
	VersionType string `json:"versionType"`
}

ManagedSoftwareUpdatePlan represents a managed software update plan.

type ManagedSoftwareUpdatePlanEventStore 

type ManagedSoftwareUpdatePlanEventStore struct {
	Events string `json:"events"`
}

ManagedSoftwareUpdatePlanEventStore represents a managed software update plan event store.

type ManagedSoftwareUpdatePlanGroupPost 

type ManagedSoftwareUpdatePlanGroupPost struct {
	Config PlanConfigurationPost `json:"config"`
	Group  PlanGroupPost         `json:"group"`
}

ManagedSoftwareUpdatePlanGroupPost represents a managed software update plan group post.

type ManagedSoftwareUpdatePlanPost 

type ManagedSoftwareUpdatePlanPost struct {
	Config  PlanConfigurationPost `json:"config"`
	Devices []PlanDevicePost      `json:"devices"`
}

ManagedSoftwareUpdatePlanPost represents a managed software update plan post.

type ManagedSoftwareUpdatePlanPostResponse 

type ManagedSoftwareUpdatePlanPostResponse struct {
	Plans []PlanDeviceResponse `json:"plans"`
}

ManagedSoftwareUpdatePlanPostResponse represents a managed software update plan post response.

type ManagedSoftwareUpdatePlanToggle 

type ManagedSoftwareUpdatePlanToggle struct {
	CustomVersionEnabled         *bool `json:"customVersionEnabled,omitempty"`
	DssEnabled                   *bool `json:"dssEnabled,omitempty"`
	ForceInstallLocalDateEnabled *bool `json:"forceInstallLocalDateEnabled,omitempty"`
	RecipeEnabled                *bool `json:"recipeEnabled,omitempty"`
	Toggle                       bool  `json:"toggle"`
}

ManagedSoftwareUpdatePlanToggle represents a managed software update plan toggle.

type ManagedSoftwareUpdatePlanToggleStatus 

type ManagedSoftwareUpdatePlanToggleStatus struct {
	// Duration in seconds between the start time and end time. "Now" is used when end time is null. Null
	// if state is NEVER_RAN.
	ElapsedTime *float64 `json:"elapsedTime"`
	// The local server time when the toggle was completed. Null if state is NEVER_RAN.
	EndTime *string `json:"endTime,omitempty"`
	// Troubleshooting - The exit message of the toggle job if it encounters an exception while running.
	// Nominal return is an empty string.
	ExitMessage string `json:"exitMessage"`
	// Troubleshooting - The exit status code from the toggle processing job. "Unknown" will return when
	// the toggle is running.
	// Allowed values: see the ManagedSoftwareUpdatePlanToggleStatusExitState constants.
	ExitState string `json:"exitState"`
	// Pretty print of total, processed, and percentage complete.
	FormattedPercentComplete string `json:"formattedPercentComplete"`
	// The percentage between total and completed records.
	PercentComplete float64 `json:"percentComplete"`
	// The total number of records that have been deleted.
	ProcessedRecords int64 `json:"processedRecords"`
	// The local server time when the toggle was initiated. Null if state is NEVER_RAN.
	StartTime *string `json:"startTime,omitempty"`
	// The current state of the toggle.
	// Allowed values: see the ManagedSoftwareUpdatePlanToggleStatusState constants.
	State string `json:"state"`
	// The total number of records that will be deleted.
	TotalRecords int64 `json:"totalRecords"`
}

ManagedSoftwareUpdatePlanToggleStatus represents a managed software update plan toggle status.

type ManagedSoftwareUpdatePlanToggleStatusExitState 

type ManagedSoftwareUpdatePlanToggleStatusExitState = string

ManagedSoftwareUpdatePlanToggleStatusExitState is the set of values accepted by ManagedSoftwareUpdatePlanToggleStatus.ExitState. 

const (
	ManagedSoftwareUpdatePlanToggleStatusExitStateUnknown   ManagedSoftwareUpdatePlanToggleStatusExitState = "UNKNOWN"
	ManagedSoftwareUpdatePlanToggleStatusExitStateExecuting ManagedSoftwareUpdatePlanToggleStatusExitState = "EXECUTING"
	ManagedSoftwareUpdatePlanToggleStatusExitStateCompleted ManagedSoftwareUpdatePlanToggleStatusExitState = "COMPLETED"
	ManagedSoftwareUpdatePlanToggleStatusExitStateNoop      ManagedSoftwareUpdatePlanToggleStatusExitState = "NOOP"
	ManagedSoftwareUpdatePlanToggleStatusExitStateFailed    ManagedSoftwareUpdatePlanToggleStatusExitState = "FAILED"
	ManagedSoftwareUpdatePlanToggleStatusExitStateStopped   ManagedSoftwareUpdatePlanToggleStatusExitState = "STOPPED"
)

ManagedSoftwareUpdatePlanToggleStatusExitState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ManagedSoftwareUpdatePlanToggleStatusExitStateValues 

func ManagedSoftwareUpdatePlanToggleStatusExitStateValues() []ManagedSoftwareUpdatePlanToggleStatusExitState

ManagedSoftwareUpdatePlanToggleStatusExitStateValues returns every value the Jamf API accepts for ManagedSoftwareUpdatePlanToggleStatusExitState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdatePlanToggleStatusState 

type ManagedSoftwareUpdatePlanToggleStatusState = string

ManagedSoftwareUpdatePlanToggleStatusState is the set of values accepted by ManagedSoftwareUpdatePlanToggleStatus.State. 

const (
	ManagedSoftwareUpdatePlanToggleStatusStateNotRunning ManagedSoftwareUpdatePlanToggleStatusState = "NOT_RUNNING"
	ManagedSoftwareUpdatePlanToggleStatusStateRunning    ManagedSoftwareUpdatePlanToggleStatusState = "RUNNING"
	ManagedSoftwareUpdatePlanToggleStatusStateNeverRan   ManagedSoftwareUpdatePlanToggleStatusState = "NEVER_RAN"
)

ManagedSoftwareUpdatePlanToggleStatusState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ManagedSoftwareUpdatePlanToggleStatusStateValues 

func ManagedSoftwareUpdatePlanToggleStatusStateValues() []ManagedSoftwareUpdatePlanToggleStatusState

ManagedSoftwareUpdatePlanToggleStatusStateValues returns every value the Jamf API accepts for ManagedSoftwareUpdatePlanToggleStatusState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdatePlanToggleStatusWrapper 

type ManagedSoftwareUpdatePlanToggleStatusWrapper struct {
	ToggleOff *ManagedSoftwareUpdatePlanToggleStatus `json:"toggleOff,omitempty"`
	ToggleOn  *ManagedSoftwareUpdatePlanToggleStatus `json:"toggleOn,omitempty"`
}

ManagedSoftwareUpdatePlanToggleStatusWrapper represents a managed software update plan toggle status wrapper.

type ManagedSoftwareUpdatePlanUpdateAction 

type ManagedSoftwareUpdatePlanUpdateAction = string

ManagedSoftwareUpdatePlanUpdateAction is the set of values accepted by ManagedSoftwareUpdatePlan.UpdateAction. 

const (
	ManagedSoftwareUpdatePlanUpdateActionDownloadOnly                 ManagedSoftwareUpdatePlanUpdateAction = "DOWNLOAD_ONLY"
	ManagedSoftwareUpdatePlanUpdateActionDownloadInstall              ManagedSoftwareUpdatePlanUpdateAction = "DOWNLOAD_INSTALL"
	ManagedSoftwareUpdatePlanUpdateActionDownloadInstallAllowDeferral ManagedSoftwareUpdatePlanUpdateAction = "DOWNLOAD_INSTALL_ALLOW_DEFERRAL"
	ManagedSoftwareUpdatePlanUpdateActionDownloadInstallRestart       ManagedSoftwareUpdatePlanUpdateAction = "DOWNLOAD_INSTALL_RESTART"
	ManagedSoftwareUpdatePlanUpdateActionDownloadInstallSchedule      ManagedSoftwareUpdatePlanUpdateAction = "DOWNLOAD_INSTALL_SCHEDULE"
	ManagedSoftwareUpdatePlanUpdateActionUnknown                      ManagedSoftwareUpdatePlanUpdateAction = "UNKNOWN"
)

ManagedSoftwareUpdatePlanUpdateAction values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ManagedSoftwareUpdatePlanUpdateActionValues 

func ManagedSoftwareUpdatePlanUpdateActionValues() []ManagedSoftwareUpdatePlanUpdateAction

ManagedSoftwareUpdatePlanUpdateActionValues returns every value the Jamf API accepts for ManagedSoftwareUpdatePlanUpdateAction, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdatePlanVersionType 

type ManagedSoftwareUpdatePlanVersionType = string

ManagedSoftwareUpdatePlanVersionType is the set of values accepted by ManagedSoftwareUpdatePlan.VersionType. 

const (
	ManagedSoftwareUpdatePlanVersionTypeLatestMajor     ManagedSoftwareUpdatePlanVersionType = "LATEST_MAJOR"
	ManagedSoftwareUpdatePlanVersionTypeLatestMinor     ManagedSoftwareUpdatePlanVersionType = "LATEST_MINOR"
	ManagedSoftwareUpdatePlanVersionTypeLatestAny       ManagedSoftwareUpdatePlanVersionType = "LATEST_ANY"
	ManagedSoftwareUpdatePlanVersionTypeSpecificVersion ManagedSoftwareUpdatePlanVersionType = "SPECIFIC_VERSION"
	ManagedSoftwareUpdatePlanVersionTypeCustomVersion   ManagedSoftwareUpdatePlanVersionType = "CUSTOM_VERSION"
	ManagedSoftwareUpdatePlanVersionTypeUnknown         ManagedSoftwareUpdatePlanVersionType = "UNKNOWN"
)

ManagedSoftwareUpdatePlanVersionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ManagedSoftwareUpdatePlanVersionTypeValues 

func ManagedSoftwareUpdatePlanVersionTypeValues() []ManagedSoftwareUpdatePlanVersionType

ManagedSoftwareUpdatePlanVersionTypeValues returns every value the Jamf API accepts for ManagedSoftwareUpdatePlanVersionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdatePlans 

type ManagedSoftwareUpdatePlans struct {
	Results    []ManagedSoftwareUpdatePlan `json:"results"`
	TotalCount int                         `json:"totalCount"`
}

ManagedSoftwareUpdatePlans represents a managed software update plans.

type ManagedSoftwareUpdateStatus 

type ManagedSoftwareUpdateStatus struct {
	Created *time.Time `json:"created,omitempty"`
	// not applicable to all managed software update statuses.
	DeferralsRemaining      int                                `json:"deferralsRemaining"`
	Device                  *ManagedSoftwareUpdateStatusDevice `json:"device,omitempty"`
	DownloadPercentComplete float64                            `json:"downloadPercentComplete"`
	Downloaded              bool                               `json:"downloaded"`
	// not applicable to all managed software update statuses.
	MaxDeferrals int `json:"maxDeferrals"`
	// not applicable to all managed software update statuses.
	NextScheduledInstall *time.Time `json:"nextScheduledInstall,omitempty"`
	OsUpdatesStatusID    string     `json:"osUpdatesStatusId"`
	// not applicable to all managed software update statuses.
	PastNotifications []time.Time `json:"pastNotifications"`
	ProductKey        string      `json:"productKey"`
	// Allowed values: see the ManagedSoftwareUpdateStatusStatus constants.
	Status  string     `json:"status"`
	Updated *time.Time `json:"updated,omitempty"`
}

ManagedSoftwareUpdateStatus represents a managed software update status.

type ManagedSoftwareUpdateStatusDevice 

type ManagedSoftwareUpdateStatusDevice struct {
	DeviceID string `json:"deviceId"`
	Href     string `json:"href"`
	// Allowed values: see the ManagedSoftwareUpdateStatusDeviceObjectType constants.
	ObjectType string `json:"objectType"`
}

ManagedSoftwareUpdateStatusDevice represents a managed software update status device.

type ManagedSoftwareUpdateStatusDeviceObjectType 

type ManagedSoftwareUpdateStatusDeviceObjectType = string

ManagedSoftwareUpdateStatusDeviceObjectType is the set of values accepted by ManagedSoftwareUpdateStatusDevice.ObjectType. 

const (
	ManagedSoftwareUpdateStatusDeviceObjectTypeComputer     ManagedSoftwareUpdateStatusDeviceObjectType = "COMPUTER"
	ManagedSoftwareUpdateStatusDeviceObjectTypeMobileDevice ManagedSoftwareUpdateStatusDeviceObjectType = "MOBILE_DEVICE"
	ManagedSoftwareUpdateStatusDeviceObjectTypeAppleTv      ManagedSoftwareUpdateStatusDeviceObjectType = "APPLE_TV"
)

ManagedSoftwareUpdateStatusDeviceObjectType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ManagedSoftwareUpdateStatusDeviceObjectTypeValues 

func ManagedSoftwareUpdateStatusDeviceObjectTypeValues() []ManagedSoftwareUpdateStatusDeviceObjectType

ManagedSoftwareUpdateStatusDeviceObjectTypeValues returns every value the Jamf API accepts for ManagedSoftwareUpdateStatusDeviceObjectType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdateStatusStatus 

type ManagedSoftwareUpdateStatusStatus = string

ManagedSoftwareUpdateStatusStatus is the set of values accepted by ManagedSoftwareUpdateStatus.Status. 

const (
	ManagedSoftwareUpdateStatusStatusDownloading                 ManagedSoftwareUpdateStatusStatus = "DOWNLOADING"
	ManagedSoftwareUpdateStatusStatusIdle                        ManagedSoftwareUpdateStatusStatus = "IDLE"
	ManagedSoftwareUpdateStatusStatusInstalling                  ManagedSoftwareUpdateStatusStatus = "INSTALLING"
	ManagedSoftwareUpdateStatusStatusInstalled                   ManagedSoftwareUpdateStatusStatus = "INSTALLED"
	ManagedSoftwareUpdateStatusStatusError                       ManagedSoftwareUpdateStatusStatus = "ERROR"
	ManagedSoftwareUpdateStatusStatusDownloadFailed              ManagedSoftwareUpdateStatusStatus = "DOWNLOAD_FAILED"
	ManagedSoftwareUpdateStatusStatusDownloadRequiresComputer    ManagedSoftwareUpdateStatusStatus = "DOWNLOAD_REQUIRES_COMPUTER"
	ManagedSoftwareUpdateStatusStatusDownloadInsufficientSpace   ManagedSoftwareUpdateStatusStatus = "DOWNLOAD_INSUFFICIENT_SPACE"
	ManagedSoftwareUpdateStatusStatusDownloadInsufficientPower   ManagedSoftwareUpdateStatusStatus = "DOWNLOAD_INSUFFICIENT_POWER"
	ManagedSoftwareUpdateStatusStatusDownloadInsufficientNetwork ManagedSoftwareUpdateStatusStatus = "DOWNLOAD_INSUFFICIENT_NETWORK"
	ManagedSoftwareUpdateStatusStatusInstallInsufficientSpace    ManagedSoftwareUpdateStatusStatus = "INSTALL_INSUFFICIENT_SPACE"
	ManagedSoftwareUpdateStatusStatusInstallInsufficientPower    ManagedSoftwareUpdateStatusStatus = "INSTALL_INSUFFICIENT_POWER"
	ManagedSoftwareUpdateStatusStatusInstallPhoneCallInProgress  ManagedSoftwareUpdateStatusStatus = "INSTALL_PHONE_CALL_IN_PROGRESS"
	ManagedSoftwareUpdateStatusStatusInstallFailed               ManagedSoftwareUpdateStatusStatus = "INSTALL_FAILED"
	ManagedSoftwareUpdateStatusStatusUnknown                     ManagedSoftwareUpdateStatusStatus = "UNKNOWN"
)

ManagedSoftwareUpdateStatusStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ManagedSoftwareUpdateStatusStatusValues 

func ManagedSoftwareUpdateStatusStatusValues() []ManagedSoftwareUpdateStatusStatus

ManagedSoftwareUpdateStatusStatusValues returns every value the Jamf API accepts for ManagedSoftwareUpdateStatusStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ManagedSoftwareUpdateStatuses 

type ManagedSoftwareUpdateStatuses struct {
	Results    []ManagedSoftwareUpdateStatus `json:"results"`
	TotalCount int                           `json:"totalCount"`
}

ManagedSoftwareUpdateStatuses represents a managed software update statuses.

type Markdown 

type Markdown struct {
	Markdown *string `json:"markdown,omitempty"`
}

Markdown represents a markdown.

type MembershipMappings 

type MembershipMappings struct {
	GroupMembershipMapping string `json:"groupMembershipMapping"`
}

MembershipMappings Cloud Identity Provider user group membership mappings configuration.

type MembershipTestSearchRequest 

type MembershipTestSearchRequest struct {
	Groupname string `json:"groupname"`
	Username  string `json:"username"`
}

MembershipTestSearchRequest represents a membership test search request.

type MembershipTestSearchResponse 

type MembershipTestSearchResponse struct {
	IsMember       bool   `json:"isMember"`
	IsMemberByUUID bool   `json:"isMemberByUuid"`
	Username       string `json:"username"`
}

MembershipTestSearchResponse represents a membership test search response.

type MemcachedEndpoints 

type MemcachedEndpoints struct {
	Enabled                 *bool   `json:"enabled,omitempty"`
	HostName                *string `json:"hostName,omitempty"`
	ID                      *string `json:"id,omitempty"`
	JssCacheConfigurationID *int    `json:"jssCacheConfigurationId,omitempty"`
	Name                    *string `json:"name,omitempty"`
	Port                    *int    `json:"port,omitempty"`
}

MemcachedEndpoints represents a memcached endpoints.

type MobileDeviceApplication 

type MobileDeviceApplication struct {
	Identifier   string `json:"identifier"`
	Name         string `json:"name"`
	ShortVersion string `json:"shortVersion"`
	Version      string `json:"version"`
}

MobileDeviceApplication represents a mobile device application.

type MobileDeviceApplicationInventoryDetail 

type MobileDeviceApplicationInventoryDetail struct {
	AppClip          bool   `json:"appClip"`
	BundleSize       string `json:"bundleSize"`
	DynamicSize      string `json:"dynamicSize"`
	Identifier       string `json:"identifier"`
	ManagementStatus string `json:"managementStatus"`
	Name             string `json:"name"`
	ShortVersion     string `json:"shortVersion"`
	ValidationStatus bool   `json:"validationStatus"`
	Version          string `json:"version"`
}

MobileDeviceApplicationInventoryDetail represents a mobile device application inventory detail.

type MobileDeviceAttachmentV2 

type MobileDeviceAttachmentV2 struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

MobileDeviceAttachmentV2 represents a mobile device attachment v2.

type MobileDeviceCertificate 

type MobileDeviceCertificate struct {
	CommonName     string     `json:"commonName"`
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`
	Identity       bool       `json:"identity"`
}

MobileDeviceCertificate represents a mobile device certificate.

type MobileDeviceCertificateV2 

type MobileDeviceCertificateV2 struct {
	// Allowed values: see the MobileDeviceCertificateV2CertificateStatus constants.
	CertificateStatus   string     `json:"certificateStatus"`
	CommonName          string     `json:"commonName"`
	ExpirationDateEpoch *time.Time `json:"expirationDateEpoch,omitempty"`
	Identity            bool       `json:"identity"`
	IssuedDateEpoch     string     `json:"issuedDateEpoch"`
	// Allowed values: see the MobileDeviceCertificateV2LifecycleStatus constants.
	LifecycleStatus string `json:"lifecycleStatus"`
	SerialNumber    string `json:"serialNumber"`
	Sha1Fingerprint string `json:"sha1Fingerprint"`
	SubjectName     string `json:"subjectName"`
}

MobileDeviceCertificateV2 represents a mobile device certificate v2.

type MobileDeviceCertificateV2CertificateStatus 

type MobileDeviceCertificateV2CertificateStatus = string

MobileDeviceCertificateV2CertificateStatus is the set of values accepted by MobileDeviceCertificateV2.CertificateStatus. 

const (
	MobileDeviceCertificateV2CertificateStatusExpiring      MobileDeviceCertificateV2CertificateStatus = "EXPIRING"
	MobileDeviceCertificateV2CertificateStatusExpired       MobileDeviceCertificateV2CertificateStatus = "EXPIRED"
	MobileDeviceCertificateV2CertificateStatusRevoked       MobileDeviceCertificateV2CertificateStatus = "REVOKED"
	MobileDeviceCertificateV2CertificateStatusPendingRevoke MobileDeviceCertificateV2CertificateStatus = "PENDING_REVOKE"
	MobileDeviceCertificateV2CertificateStatusIssued        MobileDeviceCertificateV2CertificateStatus = "ISSUED"
)

MobileDeviceCertificateV2CertificateStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceCertificateV2CertificateStatusValues 

func MobileDeviceCertificateV2CertificateStatusValues() []MobileDeviceCertificateV2CertificateStatus

MobileDeviceCertificateV2CertificateStatusValues returns every value the Jamf API accepts for MobileDeviceCertificateV2CertificateStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceCertificateV2LifecycleStatus 

type MobileDeviceCertificateV2LifecycleStatus = string

MobileDeviceCertificateV2LifecycleStatus is the set of values accepted by MobileDeviceCertificateV2.LifecycleStatus. 

const (
	MobileDeviceCertificateV2LifecycleStatusActive   MobileDeviceCertificateV2LifecycleStatus = "ACTIVE"
	MobileDeviceCertificateV2LifecycleStatusInactive MobileDeviceCertificateV2LifecycleStatus = "INACTIVE"
)

MobileDeviceCertificateV2LifecycleStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceCertificateV2LifecycleStatusValues 

func MobileDeviceCertificateV2LifecycleStatusValues() []MobileDeviceCertificateV2LifecycleStatus

MobileDeviceCertificateV2LifecycleStatusValues returns every value the Jamf API accepts for MobileDeviceCertificateV2LifecycleStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceDetailsGetV2 

type MobileDeviceDetailsGetV2 struct {
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceDetailsGetV2AppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool   `json:"awaitingConfiguration"`
	BluetoothMacAddress                string `json:"bluetoothMacAddress"`
	DeclarativeDeviceManagementEnabled bool   `json:"declarativeDeviceManagementEnabled"`
	DeviceOwnershipLevel               string `json:"deviceOwnershipLevel"`
	// Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the
	// Mobile Device Name to the ‘name’ value each time the device checks in.
	EnforceName                 bool                         `json:"enforceName"`
	EnrollmentMethod            string                       `json:"enrollmentMethod"`
	EnrollmentSessionTokenValid bool                         `json:"enrollmentSessionTokenValid"`
	ExtensionAttributes         []ExtensionAttributeV2       `json:"extensionAttributes"`
	Groups                      []MobileDeviceInventoryGroup `json:"groups"`
	ID                          string                       `json:"id"`
	InitialEntryTimestamp       *time.Time                   `json:"initialEntryTimestamp,omitempty"`
	// will be populated if the type is ios or visionos.
	Ios                           *DetailsV2  `json:"ios,omitempty"`
	IPAddress                     string      `json:"ipAddress"`
	LastContactTimestamp          *time.Time  `json:"lastContactTimestamp,omitempty"`
	LastEnrollmentTimestamp       *time.Time  `json:"lastEnrollmentTimestamp,omitempty"`
	LastInventoryUpdateTimestamp  *time.Time  `json:"lastInventoryUpdateTimestamp,omitempty"`
	Location                      *LocationV2 `json:"location,omitempty"`
	Managed                       bool        `json:"managed"`
	ManagementID                  string      `json:"managementId"`
	MDMProfileExpirationTimestamp *time.Time  `json:"mdmProfileExpirationTimestamp,omitempty"`
	// Mobile device name.
	Name    string `json:"name"`
	OsBuild string `json:"osBuild"`
	// Collected for iOS 16 and iPadOS 16.1 or later.
	OsRapidSecurityResponse string `json:"osRapidSecurityResponse"`
	// Collected for iOS 16 and iPadOS 16.1 or later.
	OsSupplementalBuildVersion string      `json:"osSupplementalBuildVersion"`
	OsVersion                  string      `json:"osVersion"`
	SerialNumber               string      `json:"serialNumber"`
	Site                       *V1SiteBase `json:"site,omitempty"`
	SoftwareUpdateDeviceID     string      `json:"softwareUpdateDeviceId"`
	TimeZone                   string      `json:"timeZone"`
	// will be populated if the type is appleTv.
	Tvos *TvOsDetails `json:"tvos,omitempty"`
	// Based on the value of this either iOS, tvOS, watch or visionOS objects will be populated.
	// Allowed values: see the MobileDeviceDetailsGetV2Type constants.
	Type string `json:"type"`
	UDID string `json:"udid"`
	// will be populated if the type is ios or visionos.
	Visionos *DetailsV2 `json:"visionos,omitempty"`
	// will be populated if the type is watchos.
	Watchos        *WatchOsDetailsV2 `json:"watchos,omitempty"`
	WifiMacAddress string            `json:"wifiMacAddress"`
}

MobileDeviceDetailsGetV2 represents a mobile device details get v2.

type MobileDeviceDetailsGetV2AppleEnrollmentType 

type MobileDeviceDetailsGetV2AppleEnrollmentType = string

MobileDeviceDetailsGetV2AppleEnrollmentType is the set of values accepted by MobileDeviceDetailsGetV2.AppleEnrollmentType. 

const (
	MobileDeviceDetailsGetV2AppleEnrollmentTypeNone       MobileDeviceDetailsGetV2AppleEnrollmentType = "none"
	MobileDeviceDetailsGetV2AppleEnrollmentTypeSupervised MobileDeviceDetailsGetV2AppleEnrollmentType = "supervised"
	MobileDeviceDetailsGetV2AppleEnrollmentTypeDevice     MobileDeviceDetailsGetV2AppleEnrollmentType = "device"
	MobileDeviceDetailsGetV2AppleEnrollmentTypeUser       MobileDeviceDetailsGetV2AppleEnrollmentType = "user"
	MobileDeviceDetailsGetV2AppleEnrollmentTypeUnknown    MobileDeviceDetailsGetV2AppleEnrollmentType = "unknown"
)

MobileDeviceDetailsGetV2AppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceDetailsGetV2AppleEnrollmentTypeValues 

func MobileDeviceDetailsGetV2AppleEnrollmentTypeValues() []MobileDeviceDetailsGetV2AppleEnrollmentType

MobileDeviceDetailsGetV2AppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceDetailsGetV2AppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceDetailsGetV2Type 

type MobileDeviceDetailsGetV2Type = string

MobileDeviceDetailsGetV2Type is the set of values accepted by MobileDeviceDetailsGetV2.Type. 

const (
	MobileDeviceDetailsGetV2TypeIos      MobileDeviceDetailsGetV2Type = "ios"
	MobileDeviceDetailsGetV2TypeTvos     MobileDeviceDetailsGetV2Type = "tvos"
	MobileDeviceDetailsGetV2TypeWatchos  MobileDeviceDetailsGetV2Type = "watchos"
	MobileDeviceDetailsGetV2TypeVisionos MobileDeviceDetailsGetV2Type = "visionos"
	MobileDeviceDetailsGetV2TypeUnknown  MobileDeviceDetailsGetV2Type = "unknown"
)

MobileDeviceDetailsGetV2Type values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceDetailsGetV2TypeValues 

func MobileDeviceDetailsGetV2TypeValues() []MobileDeviceDetailsGetV2Type

MobileDeviceDetailsGetV2TypeValues returns every value the Jamf API accepts for MobileDeviceDetailsGetV2Type, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceDetailsV2 

type MobileDeviceDetailsV2 struct {
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceDetailsV2AppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool   `json:"awaitingConfiguration"`
	BluetoothMacAddress                string `json:"bluetoothMacAddress"`
	DeclarativeDeviceManagementEnabled bool   `json:"declarativeDeviceManagementEnabled"`
	DeviceOwnershipLevel               string `json:"deviceOwnershipLevel"`
	// Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the
	// Mobile Device Name to the ‘name’ value each time the device checks in.
	EnforceName                 bool                   `json:"enforceName"`
	EnrollmentMethod            string                 `json:"enrollmentMethod"`
	EnrollmentSessionTokenValid bool                   `json:"enrollmentSessionTokenValid"`
	ExtensionAttributes         []ExtensionAttributeV2 `json:"extensionAttributes"`
	ID                          string                 `json:"id"`
	InitialEntryTimestamp       *time.Time             `json:"initialEntryTimestamp,omitempty"`
	// will be populated if the type is ios or visionos.
	Ios                           *DetailsV2  `json:"ios,omitempty"`
	IPAddress                     string      `json:"ipAddress"`
	LastContactTimestamp          *time.Time  `json:"lastContactTimestamp,omitempty"`
	LastEnrollmentTimestamp       *time.Time  `json:"lastEnrollmentTimestamp,omitempty"`
	LastInventoryUpdateTimestamp  *time.Time  `json:"lastInventoryUpdateTimestamp,omitempty"`
	Location                      *LocationV2 `json:"location,omitempty"`
	Managed                       bool        `json:"managed"`
	MDMProfileExpirationTimestamp *time.Time  `json:"mdmProfileExpirationTimestamp,omitempty"`
	// Mobile device name.
	Name    string `json:"name"`
	OsBuild string `json:"osBuild"`
	// Collected for iOS 16 and iPadOS 16.1 or later.
	OsRapidSecurityResponse string `json:"osRapidSecurityResponse"`
	// Collected for iOS 16 and iPadOS 16.1 or later.
	OsSupplementalBuildVersion string      `json:"osSupplementalBuildVersion"`
	OsVersion                  string      `json:"osVersion"`
	SerialNumber               string      `json:"serialNumber"`
	Site                       *V1SiteBase `json:"site,omitempty"`
	SoftwareUpdateDeviceID     string      `json:"softwareUpdateDeviceId"`
	TimeZone                   string      `json:"timeZone"`
	// will be populated if the type is appleTv.
	Tvos *TvOsDetails `json:"tvos,omitempty"`
	// Based on the value of this either iOS, tvOS, watch or visionOS objects will be populated.
	// Allowed values: see the MobileDeviceDetailsV2Type constants.
	Type string `json:"type"`
	UDID string `json:"udid"`
	// will be populated if the type is ios or visionos.
	Visionos *DetailsV2 `json:"visionos,omitempty"`
	// will be populated if the type is watchos.
	Watchos        *WatchOsDetailsV2 `json:"watchos,omitempty"`
	WifiMacAddress string            `json:"wifiMacAddress"`
}

MobileDeviceDetailsV2 represents a mobile device details v2.

type MobileDeviceDetailsV2AppleEnrollmentType 

type MobileDeviceDetailsV2AppleEnrollmentType = string

MobileDeviceDetailsV2AppleEnrollmentType is the set of values accepted by MobileDeviceDetailsV2.AppleEnrollmentType. 

const (
	MobileDeviceDetailsV2AppleEnrollmentTypeNone       MobileDeviceDetailsV2AppleEnrollmentType = "none"
	MobileDeviceDetailsV2AppleEnrollmentTypeSupervised MobileDeviceDetailsV2AppleEnrollmentType = "supervised"
	MobileDeviceDetailsV2AppleEnrollmentTypeDevice     MobileDeviceDetailsV2AppleEnrollmentType = "device"
	MobileDeviceDetailsV2AppleEnrollmentTypeUser       MobileDeviceDetailsV2AppleEnrollmentType = "user"
	MobileDeviceDetailsV2AppleEnrollmentTypeUnknown    MobileDeviceDetailsV2AppleEnrollmentType = "unknown"
)

MobileDeviceDetailsV2AppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceDetailsV2AppleEnrollmentTypeValues 

func MobileDeviceDetailsV2AppleEnrollmentTypeValues() []MobileDeviceDetailsV2AppleEnrollmentType

MobileDeviceDetailsV2AppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceDetailsV2AppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceDetailsV2Type 

type MobileDeviceDetailsV2Type = string

MobileDeviceDetailsV2Type is the set of values accepted by MobileDeviceDetailsV2.Type. 

const (
	MobileDeviceDetailsV2TypeIos      MobileDeviceDetailsV2Type = "ios"
	MobileDeviceDetailsV2TypeTvos     MobileDeviceDetailsV2Type = "tvos"
	MobileDeviceDetailsV2TypeWatchos  MobileDeviceDetailsV2Type = "watchos"
	MobileDeviceDetailsV2TypeVisionos MobileDeviceDetailsV2Type = "visionos"
	MobileDeviceDetailsV2TypeUnknown  MobileDeviceDetailsV2Type = "unknown"
)

MobileDeviceDetailsV2Type values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceDetailsV2TypeValues 

func MobileDeviceDetailsV2TypeValues() []MobileDeviceDetailsV2Type

MobileDeviceDetailsV2TypeValues returns every value the Jamf API accepts for MobileDeviceDetailsV2Type, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceEbook 

type MobileDeviceEbook struct {
	Author  string `json:"author"`
	Title   string `json:"title"`
	Version string `json:"version"`
}

MobileDeviceEbook represents a mobile device ebook.

type MobileDeviceEbookInventoryDetail 

type MobileDeviceEbookInventoryDetail struct {
	Author          string `json:"author"`
	Kind            string `json:"kind"`
	ManagementState string `json:"managementState"`
	Title           string `json:"title"`
	Version         string `json:"version"`
}

MobileDeviceEbookInventoryDetail represents a mobile device ebook inventory detail.

type MobileDeviceExtensionAttribute 

type MobileDeviceExtensionAttribute struct {
	ExtensionAttributeCollectionAllowed bool   `json:"extensionAttributeCollectionAllowed"`
	ID                                  string `json:"id"`
	InventoryDisplay                    string `json:"inventoryDisplay"`
	Name                                string `json:"name"`
	// Allowed values: see the MobileDeviceExtensionAttributeType constants.
	Type  string   `json:"type"`
	Value []string `json:"value"`
}

MobileDeviceExtensionAttribute represents a mobile device extension attribute.

type MobileDeviceExtensionAttributeResults 

type MobileDeviceExtensionAttributeResults struct {
	ExtensionAttributes []MobileDeviceExtensionAttributeResultsExtensionAttributesItem `json:"extensionAttributes"`
}

MobileDeviceExtensionAttributeResults represents a mobile device extension attribute results.

type MobileDeviceExtensionAttributeResultsExtensionAttributesItem 

type MobileDeviceExtensionAttributeResultsExtensionAttributesItem struct {
	Name string `json:"name"`
}

MobileDeviceExtensionAttributeResultsExtensionAttributesItem represents a mobile device extension attribute results extension attributes item.

type MobileDeviceExtensionAttributeSearchResults 

type MobileDeviceExtensionAttributeSearchResults struct {
	Results    []MobileDeviceExtensionAttributes `json:"results"`
	TotalCount int                               `json:"totalCount"`
}

MobileDeviceExtensionAttributeSearchResults represents a mobile device extension attribute search results.

type MobileDeviceExtensionAttributeType 

type MobileDeviceExtensionAttributeType = string

MobileDeviceExtensionAttributeType is the set of values accepted by MobileDeviceExtensionAttribute.Type. 

const (
	MobileDeviceExtensionAttributeTypeString  MobileDeviceExtensionAttributeType = "STRING"
	MobileDeviceExtensionAttributeTypeInteger MobileDeviceExtensionAttributeType = "INTEGER"
	MobileDeviceExtensionAttributeTypeDate    MobileDeviceExtensionAttributeType = "DATE"
)

MobileDeviceExtensionAttributeType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceExtensionAttributeTypeValues 

func MobileDeviceExtensionAttributeTypeValues() []MobileDeviceExtensionAttributeType

MobileDeviceExtensionAttributeTypeValues returns every value the Jamf API accepts for MobileDeviceExtensionAttributeType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceExtensionAttributes 

type MobileDeviceExtensionAttributes struct {
	// Type of data being collected.
	// Allowed values: see the MobileDeviceExtensionAttributesDataType constants.
	DataType string `json:"dataType"`
	// Description for the extension attribute.
	Description *string `json:"description,omitempty"`
	// Unique Id for Mobile Device Extension Attribute.
	ID *string `json:"id,omitempty"`
	// Extension attributes collect inventory data by using an input type.The type of the Input used to
	// populate the extension attribute.
	// Allowed values: see the MobileDeviceExtensionAttributesInputType constants.
	InputType string `json:"inputType"`
	// Category in which to display the extension attribute in Jamf Pro.
	// Allowed values: see the MobileDeviceExtensionAttributesInventoryDisplayType constants.
	InventoryDisplayType string `json:"inventoryDisplayType"`
	// Directory Service attribute use to populate the extension attribute. Required when inputType is
	// "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING".
	LdapAttributeMapping *string `json:"ldapAttributeMapping,omitempty"`
	// Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by
	// default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value
	// cannot be modified during edit operation. Possible values are: false true.
	LdapExtensionAttributeAllowed *bool `json:"ldapExtensionAttributeAllowed,omitempty"`
	// Display name for the extension attribute.
	Name string `json:"name"`
	// When added with list of choices while creating mobile device extension attributes these Pop-up menu
	// can be displayed in inventory information. User can choose a value from the pop-up menu list when
	// enrolling a mobile device any time using Jamf Pro. Provide popupMenuChoices only when inputType is
	// 'POPUP'.
	PopupMenuChoices *[]string `json:"popupMenuChoices,omitempty"`
}

MobileDeviceExtensionAttributes represents a mobile device extension attributes.

type MobileDeviceExtensionAttributesDataType 

type MobileDeviceExtensionAttributesDataType = string

MobileDeviceExtensionAttributesDataType is the set of values accepted by MobileDeviceExtensionAttributes.DataType. 

const (
	MobileDeviceExtensionAttributesDataTypeInteger MobileDeviceExtensionAttributesDataType = "INTEGER"
	MobileDeviceExtensionAttributesDataTypeString  MobileDeviceExtensionAttributesDataType = "STRING"
	MobileDeviceExtensionAttributesDataTypeDate    MobileDeviceExtensionAttributesDataType = "DATE"
)

MobileDeviceExtensionAttributesDataType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceExtensionAttributesDataTypeValues 

func MobileDeviceExtensionAttributesDataTypeValues() []MobileDeviceExtensionAttributesDataType

MobileDeviceExtensionAttributesDataTypeValues returns every value the Jamf API accepts for MobileDeviceExtensionAttributesDataType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceExtensionAttributesInputType 

type MobileDeviceExtensionAttributesInputType = string

MobileDeviceExtensionAttributesInputType is the set of values accepted by MobileDeviceExtensionAttributes.InputType. 

const (
	MobileDeviceExtensionAttributesInputTypeText                             MobileDeviceExtensionAttributesInputType = "TEXT"
	MobileDeviceExtensionAttributesInputTypePopup                            MobileDeviceExtensionAttributesInputType = "POPUP"
	MobileDeviceExtensionAttributesInputTypeDirectoryServiceAttributeMapping MobileDeviceExtensionAttributesInputType = "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"
)

MobileDeviceExtensionAttributesInputType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceExtensionAttributesInputTypeValues 

func MobileDeviceExtensionAttributesInputTypeValues() []MobileDeviceExtensionAttributesInputType

MobileDeviceExtensionAttributesInputTypeValues returns every value the Jamf API accepts for MobileDeviceExtensionAttributesInputType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceExtensionAttributesInventoryDisplayType 

type MobileDeviceExtensionAttributesInventoryDisplayType = string

MobileDeviceExtensionAttributesInventoryDisplayType is the set of values accepted by MobileDeviceExtensionAttributes.InventoryDisplayType. 

const (
	MobileDeviceExtensionAttributesInventoryDisplayTypeGeneral             MobileDeviceExtensionAttributesInventoryDisplayType = "GENERAL"
	MobileDeviceExtensionAttributesInventoryDisplayTypeHardware            MobileDeviceExtensionAttributesInventoryDisplayType = "HARDWARE"
	MobileDeviceExtensionAttributesInventoryDisplayTypeUserAndLocation     MobileDeviceExtensionAttributesInventoryDisplayType = "USER_AND_LOCATION"
	MobileDeviceExtensionAttributesInventoryDisplayTypePurchasing          MobileDeviceExtensionAttributesInventoryDisplayType = "PURCHASING"
	MobileDeviceExtensionAttributesInventoryDisplayTypeExtensionAttributes MobileDeviceExtensionAttributesInventoryDisplayType = "EXTENSION_ATTRIBUTES"
)

MobileDeviceExtensionAttributesInventoryDisplayType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceExtensionAttributesInventoryDisplayTypeValues 

func MobileDeviceExtensionAttributesInventoryDisplayTypeValues() []MobileDeviceExtensionAttributesInventoryDisplayType

MobileDeviceExtensionAttributesInventoryDisplayTypeValues returns every value the Jamf API accepts for MobileDeviceExtensionAttributesInventoryDisplayType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceGeneral 

type MobileDeviceGeneral struct {
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceGeneralAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool `json:"awaitingConfiguration"`
	DeclarativeDeviceManagementEnabled bool `json:"declarativeDeviceManagementEnabled"`
	// The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method
	// was removed as of 11.25.
	// Allowed values: see the MobileDeviceGeneralDeviceOwnershipType constants.
	DeviceOwnershipType         string                           `json:"deviceOwnershipType"`
	DisplayName                 string                           `json:"displayName"`
	EnrollmentMethodPrestage    *EnrollmentMethodPrestage        `json:"enrollmentMethodPrestage,omitempty"`
	EnrollmentSessionTokenValid bool                             `json:"enrollmentSessionTokenValid"`
	ExtensionAttributes         []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	IPAddress                   string                           `json:"ipAddress"`
	// The date and time of the most recent device contact via MDM or DDM channels.
	LastContactDate                          *time.Time `json:"lastContactDate,omitempty"`
	LastEnrolledDate                         *time.Time `json:"lastEnrolledDate,omitempty"`
	LastInventoryUpdateDate                  *time.Time `json:"lastInventoryUpdateDate,omitempty"`
	LastLoggedInUsernameMDM                  *string    `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp         *time.Time `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService          *string    `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp *time.Time `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	Managed                                  bool       `json:"managed"`
	ManagementID                             string     `json:"managementId"`
	MDMProfileExpirationDate                 *time.Time `json:"mdmProfileExpirationDate,omitempty"`
	OsBuild                                  string     `json:"osBuild"`
	OsRapidSecurityResponse                  string     `json:"osRapidSecurityResponse"`
	OsSupplementalBuildVersion               string     `json:"osSupplementalBuildVersion"`
	OsVersion                                string     `json:"osVersion"`
	SiteID                                   string     `json:"siteId"`
	SoftwareUpdateDeviceID                   string     `json:"softwareUpdateDeviceId"`
	Supervised                               bool       `json:"supervised"`
	// IANA time zone database name.
	TimeZone string `json:"timeZone"`
	UDID     string `json:"udid"`
}

MobileDeviceGeneral represents a mobile device general.

type MobileDeviceGeneralAppleEnrollmentType 

type MobileDeviceGeneralAppleEnrollmentType = string

MobileDeviceGeneralAppleEnrollmentType is the set of values accepted by MobileDeviceGeneral.AppleEnrollmentType. 

const (
	MobileDeviceGeneralAppleEnrollmentTypeNone       MobileDeviceGeneralAppleEnrollmentType = "none"
	MobileDeviceGeneralAppleEnrollmentTypeSupervised MobileDeviceGeneralAppleEnrollmentType = "supervised"
	MobileDeviceGeneralAppleEnrollmentTypeDevice     MobileDeviceGeneralAppleEnrollmentType = "device"
	MobileDeviceGeneralAppleEnrollmentTypeUser       MobileDeviceGeneralAppleEnrollmentType = "user"
	MobileDeviceGeneralAppleEnrollmentTypeUnknown    MobileDeviceGeneralAppleEnrollmentType = "unknown"
)

MobileDeviceGeneralAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceGeneralAppleEnrollmentTypeValues 

func MobileDeviceGeneralAppleEnrollmentTypeValues() []MobileDeviceGeneralAppleEnrollmentType

MobileDeviceGeneralAppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceGeneralAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceGeneralDeviceOwnershipType 

type MobileDeviceGeneralDeviceOwnershipType = string

MobileDeviceGeneralDeviceOwnershipType is the set of values accepted by MobileDeviceGeneral.DeviceOwnershipType. 

const (
	MobileDeviceGeneralDeviceOwnershipTypeInstitutional                 MobileDeviceGeneralDeviceOwnershipType = "Institutional"
	MobileDeviceGeneralDeviceOwnershipTypeUserEnrollment                MobileDeviceGeneralDeviceOwnershipType = "UserEnrollment"
	MobileDeviceGeneralDeviceOwnershipTypeAccountDrivenUserEnrollment   MobileDeviceGeneralDeviceOwnershipType = "AccountDrivenUserEnrollment"
	MobileDeviceGeneralDeviceOwnershipTypeAccountDrivenDeviceEnrollment MobileDeviceGeneralDeviceOwnershipType = "AccountDrivenDeviceEnrollment"
)

MobileDeviceGeneralDeviceOwnershipType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceGeneralDeviceOwnershipTypeValues 

func MobileDeviceGeneralDeviceOwnershipTypeValues() []MobileDeviceGeneralDeviceOwnershipType

MobileDeviceGeneralDeviceOwnershipTypeValues returns every value the Jamf API accepts for MobileDeviceGeneralDeviceOwnershipType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceGroup 

type MobileDeviceGroup struct {
	Description  string `json:"description"`
	ID           int    `json:"id"`
	IsSmartGroup bool   `json:"isSmartGroup"`
	Name         string `json:"name"`
}

MobileDeviceGroup represents a mobile device group.

type MobileDeviceHardware 

type MobileDeviceHardware struct {
	AvailableSpaceMb int `json:"availableSpaceMb"`
	// - NON_GENUINE: The battery isn’t a genuine Apple battery. - NORMAL: The battery is operating
	// normally. - SERVICE_RECOMMENDED: The system recommends battery service. - UNKNOWN: The system
	// couldn’t determine battery health information. - UNSUPPORTED: The device doesn’t support battery
	// health reporting.
	// Allowed values: see the MobileDeviceHardwareBatteryHealth constants.
	BatteryHealth             string                           `json:"batteryHealth"`
	BatteryLevel              int                              `json:"batteryLevel"`
	BluetoothLowEnergyCapable bool                             `json:"bluetoothLowEnergyCapable"`
	BluetoothMacAddress       string                           `json:"bluetoothMacAddress"`
	CapacityMb                int                              `json:"capacityMb"`
	DeviceID                  string                           `json:"deviceId"`
	ExtensionAttributes       []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	Model                     string                           `json:"model"`
	ModelIdentifier           string                           `json:"modelIdentifier"`
	ModelNumber               string                           `json:"modelNumber"`
	ModemFirmwareVersion      string                           `json:"modemFirmwareVersion"`
	SerialNumber              string                           `json:"serialNumber"`
	// System health status for device components. Reported for iOS devices.
	SystemHealth        *MobileDeviceSystemHealth `json:"systemHealth,omitempty"`
	UsedSpacePercentage int                       `json:"usedSpacePercentage"`
	WifiMacAddress      string                    `json:"wifiMacAddress"`
}

MobileDeviceHardware represents a mobile device hardware.

type MobileDeviceHardwareBatteryHealth 

type MobileDeviceHardwareBatteryHealth = string

MobileDeviceHardwareBatteryHealth is the set of values accepted by MobileDeviceHardware.BatteryHealth. 

const (
	MobileDeviceHardwareBatteryHealthNonGenuine         MobileDeviceHardwareBatteryHealth = "NON_GENUINE"
	MobileDeviceHardwareBatteryHealthNormal             MobileDeviceHardwareBatteryHealth = "NORMAL"
	MobileDeviceHardwareBatteryHealthServiceRecommended MobileDeviceHardwareBatteryHealth = "SERVICE_RECOMMENDED"
	MobileDeviceHardwareBatteryHealthUnknown            MobileDeviceHardwareBatteryHealth = "UNKNOWN"
	MobileDeviceHardwareBatteryHealthUnsupported        MobileDeviceHardwareBatteryHealth = "UNSUPPORTED"
)

MobileDeviceHardwareBatteryHealth values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceHardwareBatteryHealthValues 

func MobileDeviceHardwareBatteryHealthValues() []MobileDeviceHardwareBatteryHealth

MobileDeviceHardwareBatteryHealthValues returns every value the Jamf API accepts for MobileDeviceHardwareBatteryHealth, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceInventory 

type MobileDeviceInventory struct {
	Applications []MobileDeviceApplicationInventoryDetail `json:"applications"`
	Certificates []MobileDeviceCertificate                `json:"certificates"`
	// Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.
	DeviceType          string                           `json:"deviceType"`
	ExtensionAttributes []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	Groups              []MobileDeviceInventoryGroup     `json:"groups"`
	Hardware            *MobileDeviceHardware            `json:"hardware,omitempty"`
	MobileDeviceID      string                           `json:"mobileDeviceId"`
	Profiles            []MobileDeviceProfile            `json:"profiles"`
	UserAndLocation     *MobileDeviceUserAndLocation     `json:"userAndLocation,omitempty"`
}

MobileDeviceInventory represents a mobile device inventory.

type MobileDeviceInventoryGroup 

type MobileDeviceInventoryGroup struct {
	GroupDescription string `json:"groupDescription"`
	GroupID          string `json:"groupId"`
	GroupName        string `json:"groupName"`
	Smart            bool   `json:"smart"`
}

MobileDeviceInventoryGroup represents a mobile device inventory group.

type MobileDeviceInventorySearchResults 

type MobileDeviceInventorySearchResults struct {
	Results    []MobileDeviceResponse `json:"results"`
	TotalCount int                    `json:"totalCount"`
}

MobileDeviceInventorySearchResults represents a mobile device inventory search results.

type MobileDeviceIosGeneral 

type MobileDeviceIosGeneral struct {
	AppAnalyticsEnabled bool `json:"appAnalyticsEnabled"`
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceIosGeneralAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool `json:"awaitingConfiguration"`
	CloudBackupEnabled                 bool `json:"cloudBackupEnabled"`
	DeclarativeDeviceManagementEnabled bool `json:"declarativeDeviceManagementEnabled"`
	DeviceLocatorServiceEnabled        bool `json:"deviceLocatorServiceEnabled"`
	// The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method
	// was removed as of 11.25.
	// Allowed values: see the MobileDeviceIosGeneralDeviceOwnershipType constants.
	DeviceOwnershipType                string                           `json:"deviceOwnershipType"`
	DiagnosticAndUsageReportingEnabled bool                             `json:"diagnosticAndUsageReportingEnabled"`
	DisplayName                        string                           `json:"displayName"`
	DoNotDisturbEnabled                bool                             `json:"doNotDisturbEnabled"`
	EnrollmentMethodPrestage           *EnrollmentMethodPrestage        `json:"enrollmentMethodPrestage,omitempty"`
	EnrollmentSessionTokenValid        bool                             `json:"enrollmentSessionTokenValid"`
	ExchangeDeviceID                   string                           `json:"exchangeDeviceId"`
	ExtensionAttributes                []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	IPAddress                          string                           `json:"ipAddress"`
	ItunesStoreAccountActive           bool                             `json:"itunesStoreAccountActive"`
	LastBackupDate                     *time.Time                       `json:"lastBackupDate,omitempty"`
	LastCloudBackupDate                *time.Time                       `json:"lastCloudBackupDate,omitempty"`
	// The date and time of the most recent device contact via MDM or DDM channels.
	LastContactDate                             *time.Time `json:"lastContactDate,omitempty"`
	LastEnrolledDate                            *time.Time `json:"lastEnrolledDate,omitempty"`
	LastInventoryUpdateDate                     *time.Time `json:"lastInventoryUpdateDate,omitempty"`
	LastLoggedInUsernameMDM                     *string    `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp            *time.Time `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService             *string    `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp    *time.Time `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	LocationServicesForSelfServiceMobileEnabled bool       `json:"locationServicesForSelfServiceMobileEnabled"`
	Managed                                     bool       `json:"managed"`
	ManagementID                                string     `json:"managementId"`
	MaximumSharediPadUsersStored                int        `json:"maximumSharediPadUsersStored"`
	MDMProfileExpirationDate                    *time.Time `json:"mdmProfileExpirationDate,omitempty"`
	OsBuild                                     string     `json:"osBuild"`
	OsRapidSecurityResponse                     string     `json:"osRapidSecurityResponse"`
	OsSupplementalBuildVersion                  string     `json:"osSupplementalBuildVersion"`
	OsVersion                                   string     `json:"osVersion"`
	QuotaSize                                   int        `json:"quotaSize"`
	ResidentUsers                               int        `json:"residentUsers"`
	// Whether Return to Service is enabled.
	ReturnToServiceEnabled  bool   `json:"returnToServiceEnabled"`
	SharedIpad              bool   `json:"sharedIpad"`
	SiteID                  string `json:"siteId"`
	SoftwareUpdateDeviceID  string `json:"softwareUpdateDeviceId"`
	Supervised              bool   `json:"supervised"`
	SyncedToComputer        int    `json:"syncedToComputer"`
	TemporarySessionOnly    bool   `json:"temporarySessionOnly"`
	TemporarySessionTimeout int    `json:"temporarySessionTimeout"`
	Tethered                bool   `json:"tethered"`
	// IANA time zone database name.
	TimeZone           string `json:"timeZone"`
	UDID               string `json:"udid"`
	UserSessionTimeout int    `json:"userSessionTimeout"`
}

MobileDeviceIosGeneral represents a mobile device ios general.

type MobileDeviceIosGeneralAppleEnrollmentType 

type MobileDeviceIosGeneralAppleEnrollmentType = string

MobileDeviceIosGeneralAppleEnrollmentType is the set of values accepted by MobileDeviceIosGeneral.AppleEnrollmentType. 

const (
	MobileDeviceIosGeneralAppleEnrollmentTypeNone       MobileDeviceIosGeneralAppleEnrollmentType = "none"
	MobileDeviceIosGeneralAppleEnrollmentTypeSupervised MobileDeviceIosGeneralAppleEnrollmentType = "supervised"
	MobileDeviceIosGeneralAppleEnrollmentTypeDevice     MobileDeviceIosGeneralAppleEnrollmentType = "device"
	MobileDeviceIosGeneralAppleEnrollmentTypeUser       MobileDeviceIosGeneralAppleEnrollmentType = "user"
	MobileDeviceIosGeneralAppleEnrollmentTypeUnknown    MobileDeviceIosGeneralAppleEnrollmentType = "unknown"
)

MobileDeviceIosGeneralAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceIosGeneralAppleEnrollmentTypeValues 

func MobileDeviceIosGeneralAppleEnrollmentTypeValues() []MobileDeviceIosGeneralAppleEnrollmentType

MobileDeviceIosGeneralAppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceIosGeneralAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceIosGeneralDeviceOwnershipType 

type MobileDeviceIosGeneralDeviceOwnershipType = string

MobileDeviceIosGeneralDeviceOwnershipType is the set of values accepted by MobileDeviceIosGeneral.DeviceOwnershipType. 

const (
	MobileDeviceIosGeneralDeviceOwnershipTypeInstitutional                 MobileDeviceIosGeneralDeviceOwnershipType = "Institutional"
	MobileDeviceIosGeneralDeviceOwnershipTypeUserEnrollment                MobileDeviceIosGeneralDeviceOwnershipType = "UserEnrollment"
	MobileDeviceIosGeneralDeviceOwnershipTypeAccountDrivenUserEnrollment   MobileDeviceIosGeneralDeviceOwnershipType = "AccountDrivenUserEnrollment"
	MobileDeviceIosGeneralDeviceOwnershipTypeAccountDrivenDeviceEnrollment MobileDeviceIosGeneralDeviceOwnershipType = "AccountDrivenDeviceEnrollment"
)

MobileDeviceIosGeneralDeviceOwnershipType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceIosGeneralDeviceOwnershipTypeValues 

func MobileDeviceIosGeneralDeviceOwnershipTypeValues() []MobileDeviceIosGeneralDeviceOwnershipType

MobileDeviceIosGeneralDeviceOwnershipTypeValues returns every value the Jamf API accepts for MobileDeviceIosGeneralDeviceOwnershipType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceIosInventory 

type MobileDeviceIosInventory struct {
	Applications []MobileDeviceApplicationInventoryDetail `json:"applications"`
	Certificates []MobileDeviceCertificate                `json:"certificates"`
	// Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.
	DeviceType          string                             `json:"deviceType"`
	Ebooks              []MobileDeviceEbookInventoryDetail `json:"ebooks"`
	ExtensionAttributes []MobileDeviceExtensionAttribute   `json:"extensionAttributes"`
	General             *MobileDeviceIosGeneral            `json:"general,omitempty"`
	Groups              []MobileDeviceInventoryGroup       `json:"groups"`
	Hardware            *MobileDeviceHardware              `json:"hardware,omitempty"`
	MobileDeviceID      string                             `json:"mobileDeviceId"`
	// This section only avaiable for Ios type.
	Network              *MobileDeviceNetwork               `json:"network,omitempty"`
	Profiles             []MobileDeviceProfile              `json:"profiles"`
	ProvisioningProfiles []MobileDeviceProvisioningProfiles `json:"provisioningProfiles"`
	Purchasing           *MobileDevicePurchasing            `json:"purchasing,omitempty"`
	// This section only available for Ios type.
	Security             *MobileDeviceSecurity              `json:"security,omitempty"`
	ServiceSubscriptions []MobileDeviceServiceSubscriptions `json:"serviceSubscriptions"`
	SharedUsers          []MobileDeviceSharedUser           `json:"sharedUsers"`
	UserAndLocation      *MobileDeviceUserAndLocation       `json:"userAndLocation,omitempty"`
	UserProfiles         []MobileDeviceUserProfile          `json:"userProfiles"`
}

MobileDeviceIosInventory represents a mobile device ios inventory.

type MobileDeviceLostModeLocation 

type MobileDeviceLostModeLocation struct {
	LastLocationUpdate                       *time.Time `json:"lastLocationUpdate,omitempty"`
	LostModeLocationAltitudeMeters           float64    `json:"lostModeLocationAltitudeMeters"`
	LostModeLocationCourseDegrees            float64    `json:"lostModeLocationCourseDegrees"`
	LostModeLocationHorizontalAccuracyMeters float64    `json:"lostModeLocationHorizontalAccuracyMeters"`
	LostModeLocationSpeedMetersPerSecond     float64    `json:"lostModeLocationSpeedMetersPerSecond"`
	LostModeLocationTimestamp                string     `json:"lostModeLocationTimestamp"`
	LostModeLocationVerticalAccuracyMeters   float64    `json:"lostModeLocationVerticalAccuracyMeters"`
}

MobileDeviceLostModeLocation represents a mobile device lost mode location.

type MobileDeviceMDMCapableUser 

type MobileDeviceMDMCapableUser struct {
	ManagementID  string `json:"managementId"`
	UserShortName string `json:"userShortName"`
}

MobileDeviceMDMCapableUser represents a mobile device m d m capable user.

type MobileDeviceNetwork 

type MobileDeviceNetwork struct {
	CarrierSettingsVersion   string `json:"carrierSettingsVersion"`
	CellularTechnology       string `json:"cellularTechnology"`
	CurrentCarrierNetwork    string `json:"currentCarrierNetwork"`
	CurrentMobileCountryCode string `json:"currentMobileCountryCode"`
	CurrentMobileNetworkCode string `json:"currentMobileNetworkCode"`
	DataRoamingEnabled       bool   `json:"dataRoamingEnabled"`
	// EID or "embedded identity document" is a number associated with the eSIM on a device.
	Eid                    string `json:"eid"`
	HomeCarrierNetwork     string `json:"homeCarrierNetwork"`
	HomeMobileCountryCode  string `json:"homeMobileCountryCode"`
	HomeMobileNetworkCode  string `json:"homeMobileNetworkCode"`
	Iccid                  string `json:"iccid"`
	Imei                   string `json:"imei"`
	Meid                   string `json:"meid"`
	PersonalHotspotEnabled bool   `json:"personalHotspotEnabled"`
	PhoneNumber            string `json:"phoneNumber"`
	PreferredVoiceNumber   string `json:"preferredVoiceNumber"`
	Roaming                bool   `json:"roaming"`
	VoiceRoamingEnabled    bool   `json:"voiceRoamingEnabled"`
}

MobileDeviceNetwork This section only avaiable for Ios type.

type MobileDevicePrestageNameV3 

type MobileDevicePrestageNameV3 struct {
	DeviceName *string `json:"deviceName,omitempty"`
	ID         *string `json:"id,omitempty"`
	Used       *bool   `json:"used,omitempty"`
}

MobileDevicePrestageNameV3 represents a mobile device prestage name v3.

type MobileDevicePrestageNamesV3 

type MobileDevicePrestageNamesV3 struct {
	AssignNamesUsing       *string                       `json:"assignNamesUsing,omitempty"`
	DeviceNamePrefix       *string                       `json:"deviceNamePrefix,omitempty"`
	DeviceNameSuffix       *string                       `json:"deviceNameSuffix,omitempty"`
	DeviceNamingConfigured *bool                         `json:"deviceNamingConfigured,omitempty"`
	ManageNames            *bool                         `json:"manageNames,omitempty"`
	PrestageDeviceNames    *[]MobileDevicePrestageNameV3 `json:"prestageDeviceNames,omitempty"`
	SingleDeviceName       *string                       `json:"singleDeviceName,omitempty"`
}

MobileDevicePrestageNamesV3 represents a mobile device prestage names v3.

type MobileDevicePrestageSearchResultsV3 

type MobileDevicePrestageSearchResultsV3 struct {
	Results    []GetMobileDevicePrestageV3 `json:"results"`
	TotalCount int                         `json:"totalCount"`
}

MobileDevicePrestageSearchResultsV3 represents a mobile device prestage search results v3.

type MobileDevicePrestageV3 

type MobileDevicePrestageV3 struct {
	AllowPairing bool `json:"allowPairing"`
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                  *[]string `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt                string    `json:"authenticationPrompt"`
	AutoAdvanceSetup                    bool      `json:"autoAdvanceSetup"`
	ConfigureDeviceBeforeSetupAssistant bool      `json:"configureDeviceBeforeSetupAssistant"`
	DefaultPrestage                     bool      `json:"defaultPrestage"`
	Department                          string    `json:"department"`
	DeviceEnrollmentProgramInstanceID   string    `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                         string    `json:"displayName"`
	// If true, the device does not use the profile when it restores a backup. Default is false. Available
	// in iOS 26 and later, and visionOS 26 and later; otherwise ignored by devices.
	DoNotUseProfileFromBackup       *bool   `json:"doNotUseProfileFromBackup,omitempty"`
	EnableDeviceBasedActivationLock bool    `json:"enableDeviceBasedActivationLock"`
	EnforceTemporarySessionTimeout  *bool   `json:"enforceTemporarySessionTimeout,omitempty"`
	EnforceUserSessionTimeout       *bool   `json:"enforceUserSessionTimeout,omitempty"`
	EnrollmentCustomizationID       *string `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                string  `json:"enrollmentSiteId"`
	// Controls whether apps are installed during the enrollment process.
	InstallAppsDuringEnrollment     *bool                        `json:"installAppsDuringEnrollment,omitempty"`
	KeepExistingLocationInformation bool                         `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership      bool                         `json:"keepExistingSiteMembership"`
	Language                        *string                      `json:"language,omitempty"`
	LocationInformation             LocationInformationV3        `json:"locationInformation"`
	Mandatory                       bool                         `json:"mandatory"`
	MaximumSharedAccounts           int                          `json:"maximumSharedAccounts"`
	MDMRemovable                    bool                         `json:"mdmRemovable"`
	MinimumOsSpecificVersionIos     *string                      `json:"minimumOsSpecificVersionIos,omitempty"`
	MinimumOsSpecificVersionIpad    *string                      `json:"minimumOsSpecificVersionIpad,omitempty"`
	MultiUser                       bool                         `json:"multiUser"`
	Names                           *MobileDevicePrestageNamesV3 `json:"names,omitempty"`
	// Controls whether managed apps are preserved during Return to Service operations.
	PreserveManagedApps *bool `json:"preserveManagedApps,omitempty"`
	// Allowed values: see the MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos constants.
	PrestageMinimumOsTargetVersionTypeIos *string `json:"prestageMinimumOsTargetVersionTypeIos,omitempty"`
	// Allowed values: see the MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad constants.
	PrestageMinimumOsTargetVersionTypeIpad *string                         `json:"prestageMinimumOsTargetVersionTypeIpad,omitempty"`
	PreventActivationLock                  bool                            `json:"preventActivationLock"`
	PurchasingInformation                  PrestagePurchasingInformationV3 `json:"purchasingInformation"`
	Region                                 *string                         `json:"region,omitempty"`
	RequireAuthentication                  bool                            `json:"requireAuthentication"`
	RtsConfigProfileID                     *string                         `json:"rtsConfigProfileId,omitempty"`
	RtsEnabled                             *bool                           `json:"rtsEnabled,omitempty"`
	SendTimezone                           bool                            `json:"sendTimezone"`
	SkipSetupItems                         *map[string]bool                `json:"skipSetupItems,omitempty"`
	StorageQuotaSizeMegabytes              int                             `json:"storageQuotaSizeMegabytes"`
	Supervised                             bool                            `json:"supervised"`
	SupportEmailAddress                    string                          `json:"supportEmailAddress"`
	SupportPhoneNumber                     string                          `json:"supportPhoneNumber"`
	TemporarySessionOnly                   *bool                           `json:"temporarySessionOnly,omitempty"`
	TemporarySessionTimeout                *int                            `json:"temporarySessionTimeout,omitempty"`
	Timezone                               string                          `json:"timezone"`
	UseStorageQuotaSize                    bool                            `json:"useStorageQuotaSize"`
	UserSessionTimeout                     *int                            `json:"userSessionTimeout,omitempty"`
}

MobileDevicePrestageV3 represents a mobile device prestage v3.

type MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos 

type MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = string

MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos is the set of values accepted by MobileDevicePrestageV3.PrestageMinimumOsTargetVersionTypeIos. 

const (
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosNoEnforcement               MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "NO_ENFORCEMENT"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestVersion      MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_VERSION"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestMajorVersion MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestMinorVersion MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_MINOR_VERSION"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsSpecificVersion    MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_SPECIFIC_VERSION"
)

MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues 

func MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues() []MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos

MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues returns every value the Jamf API accepts for MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad 

type MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = string

MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad is the set of values accepted by MobileDevicePrestageV3.PrestageMinimumOsTargetVersionTypeIpad. 

const (
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadNoEnforcement               MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "NO_ENFORCEMENT"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestVersion      MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_VERSION"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestMajorVersion MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestMinorVersion MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_MINOR_VERSION"
	MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsSpecificVersion    MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_SPECIFIC_VERSION"
)

MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues 

func MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues() []MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad

MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues returns every value the Jamf API accepts for MobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceProfile 

type MobileDeviceProfile struct {
	DisplayName   string     `json:"displayName"`
	Identifier    string     `json:"identifier"`
	LastInstalled *time.Time `json:"lastInstalled,omitempty"`
	Removable     bool       `json:"removable"`
	UUID          string     `json:"uuid"`
	Version       string     `json:"version"`
}

MobileDeviceProfile represents a mobile device profile.

type MobileDeviceProvisioningProfiles 

type MobileDeviceProvisioningProfiles struct {
	DisplayName    string     `json:"displayName"`
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`
	UUID           string     `json:"uuid"`
}

MobileDeviceProvisioningProfiles represents a mobile device provisioning profiles.

type MobileDevicePurchasing 

type MobileDevicePurchasing struct {
	AppleCareID         string                           `json:"appleCareId"`
	ExtensionAttributes []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	LeaseExpiresDate    *time.Time                       `json:"leaseExpiresDate,omitempty"`
	Leased              bool                             `json:"leased"`
	LifeExpectancy      int                              `json:"lifeExpectancy"`
	PoDate              *time.Time                       `json:"poDate,omitempty"`
	PoNumber            string                           `json:"poNumber"`
	PurchasePrice       string                           `json:"purchasePrice"`
	Purchased           bool                             `json:"purchased"`
	PurchasingAccount   string                           `json:"purchasingAccount"`
	PurchasingContact   string                           `json:"purchasingContact"`
	Vendor              string                           `json:"vendor"`
	WarrantyExpiresDate *time.Time                       `json:"warrantyExpiresDate,omitempty"`
}

MobileDevicePurchasing represents a mobile device purchasing.

type MobileDeviceResponse 

type MobileDeviceResponse struct {
	// Allowed values: see the MobileDeviceResponseDeviceType constants.
	DeviceType string                         `json:"deviceType"`
	IOS        *MobileDeviceIosInventory      `json:"-"`
	TvOS       *MobileDeviceTvOsInventory     `json:"-"`
	VisionOS   *MobileDeviceVisionOsInventory `json:"-"`
	WatchOS    *MobileDeviceWatchOsInventory  `json:"-"`
}

MobileDeviceResponse is a polymorphic response keyed by deviceType. Exactly one variant pointer is populated after unmarshaling.

func (MobileDeviceResponse) MarshalJSON 

func (m MobileDeviceResponse) MarshalJSON() ([]byte, error)

MarshalJSON emits the active variant's JSON. If the matching variant pointer is nil, emits a minimal object carrying only the discriminator.

func (*MobileDeviceResponse) UnmarshalJSON 

func (m *MobileDeviceResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON dispatches the payload to the variant matching the deviceType discriminator. Unknown values leave the variant pointers nil but preserve the discriminator string.

type MobileDeviceResponseDeviceType 

type MobileDeviceResponseDeviceType = string

MobileDeviceResponseDeviceType is the set of values accepted by MobileDeviceResponse.DeviceType. 

const (
	MobileDeviceResponseDeviceTypeIOS      MobileDeviceResponseDeviceType = "iOS"
	MobileDeviceResponseDeviceTypeTvOS     MobileDeviceResponseDeviceType = "tvOS"
	MobileDeviceResponseDeviceTypeVisionOS MobileDeviceResponseDeviceType = "visionOS"
	MobileDeviceResponseDeviceTypeWatchOS  MobileDeviceResponseDeviceType = "watchOS"
)

MobileDeviceResponseDeviceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceResponseDeviceTypeValues 

func MobileDeviceResponseDeviceTypeValues() []MobileDeviceResponseDeviceType

MobileDeviceResponseDeviceTypeValues returns every value the Jamf API accepts for MobileDeviceResponseDeviceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceSearchResultsV2 

type MobileDeviceSearchResultsV2 struct {
	Results    []MobileDeviceV2 `json:"results"`
	TotalCount int              `json:"totalCount"`
}

MobileDeviceSearchResultsV2 represents a mobile device search results v2.

type MobileDeviceSection 

type MobileDeviceSection = string

MobileDeviceSection represents a mobile device section value. 

const (
	MobileDeviceSectionGeneral              MobileDeviceSection = "GENERAL"
	MobileDeviceSectionHardware             MobileDeviceSection = "HARDWARE"
	MobileDeviceSectionUserAndLocation      MobileDeviceSection = "USER_AND_LOCATION"
	MobileDeviceSectionPurchasing           MobileDeviceSection = "PURCHASING"
	MobileDeviceSectionSecurity             MobileDeviceSection = "SECURITY"
	MobileDeviceSectionApplications         MobileDeviceSection = "APPLICATIONS"
	MobileDeviceSectionEbooks               MobileDeviceSection = "EBOOKS"
	MobileDeviceSectionNetwork              MobileDeviceSection = "NETWORK"
	MobileDeviceSectionServiceSubscriptions MobileDeviceSection = "SERVICE_SUBSCRIPTIONS"
	MobileDeviceSectionCertificates         MobileDeviceSection = "CERTIFICATES"
	MobileDeviceSectionProfiles             MobileDeviceSection = "PROFILES"
	MobileDeviceSectionUserProfiles         MobileDeviceSection = "USER_PROFILES"
	MobileDeviceSectionProvisioningProfiles MobileDeviceSection = "PROVISIONING_PROFILES"
	MobileDeviceSectionSharedUsers          MobileDeviceSection = "SHARED_USERS"
	MobileDeviceSectionGroups               MobileDeviceSection = "GROUPS"
	MobileDeviceSectionExtensionAttributes  MobileDeviceSection = "EXTENSION_ATTRIBUTES"
)

MobileDeviceSection values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceSectionValues 

func MobileDeviceSectionValues() []MobileDeviceSection

MobileDeviceSectionValues returns every value the Jamf API accepts for MobileDeviceSection, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceSecurity 

type MobileDeviceSecurity struct {
	ActivationLockEnabled bool `json:"activationLockEnabled"`
	// Allowed values: see the MobileDeviceSecurityAttestationStatus constants.
	AttestationStatus           string `json:"attestationStatus"`
	BlockLevelEncryptionCapable bool   `json:"blockLevelEncryptionCapable"`
	// Indicates the bootstrap token escrow status for the device.
	// Allowed values: see the MobileDeviceSecurityBootstrapTokenEscrowed constants.
	BootstrapTokenEscrowed        string     `json:"bootstrapTokenEscrowed"`
	DataProtected                 bool       `json:"dataProtected"`
	FileLevelEncryptionCapable    bool       `json:"fileLevelEncryptionCapable"`
	HardwareEncryption            int        `json:"hardwareEncryption"`
	JailBreakDetected             bool       `json:"jailBreakDetected"`
	LastAttestationAttemptDate    *time.Time `json:"lastAttestationAttemptDate,omitempty"`
	LastSuccessfulAttestationDate *time.Time `json:"lastSuccessfulAttestationDate,omitempty"`
	// Whether Lockdown Mode is enabled.
	LockdownModeEnabled                    bool                          `json:"lockdownModeEnabled"`
	LostModeEnabled                        bool                          `json:"lostModeEnabled"`
	LostModeFootnote                       string                        `json:"lostModeFootnote"`
	LostModeLocation                       *MobileDeviceLostModeLocation `json:"lostModeLocation,omitempty"`
	LostModeMessage                        string                        `json:"lostModeMessage"`
	LostModePersistent                     bool                          `json:"lostModePersistent"`
	LostModePhoneNumber                    string                        `json:"lostModePhoneNumber"`
	PasscodeCompliant                      bool                          `json:"passcodeCompliant"`
	PasscodeCompliantWithProfile           bool                          `json:"passcodeCompliantWithProfile"`
	PasscodeLockGracePeriodEnforcedSeconds int                           `json:"passcodeLockGracePeriodEnforcedSeconds"`
	PasscodePresent                        bool                          `json:"passcodePresent"`
	// **Deprecated as of 11.25.** This field always returns false.
	PersonalDeviceProfileCurrent bool `json:"personalDeviceProfileCurrent"`
}

MobileDeviceSecurity This section only available for Ios type.

type MobileDeviceSecurityAttestationStatus 

type MobileDeviceSecurityAttestationStatus = string

MobileDeviceSecurityAttestationStatus is the set of values accepted by MobileDeviceSecurity.AttestationStatus. 

const (
	MobileDeviceSecurityAttestationStatusPending                     MobileDeviceSecurityAttestationStatus = "PENDING"
	MobileDeviceSecurityAttestationStatusSuccess                     MobileDeviceSecurityAttestationStatus = "SUCCESS"
	MobileDeviceSecurityAttestationStatusCertificateInvalid          MobileDeviceSecurityAttestationStatus = "CERTIFICATE_INVALID"
	MobileDeviceSecurityAttestationStatusDevicePropertiesMismatch    MobileDeviceSecurityAttestationStatus = "DEVICE_PROPERTIES_MISMATCH"
	MobileDeviceSecurityAttestationStatusMdaUnsupportedDueToHardware MobileDeviceSecurityAttestationStatus = "MDA_UNSUPPORTED_DUE_TO_HARDWARE"
	MobileDeviceSecurityAttestationStatusMdaUnsupportedDueToSoftware MobileDeviceSecurityAttestationStatus = "MDA_UNSUPPORTED_DUE_TO_SOFTWARE"
)

MobileDeviceSecurityAttestationStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceSecurityAttestationStatusValues 

func MobileDeviceSecurityAttestationStatusValues() []MobileDeviceSecurityAttestationStatus

MobileDeviceSecurityAttestationStatusValues returns every value the Jamf API accepts for MobileDeviceSecurityAttestationStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceSecurityBootstrapTokenEscrowed 

type MobileDeviceSecurityBootstrapTokenEscrowed = string

MobileDeviceSecurityBootstrapTokenEscrowed is the set of values accepted by MobileDeviceSecurity.BootstrapTokenEscrowed. 

const (
	MobileDeviceSecurityBootstrapTokenEscrowedEscrowed     MobileDeviceSecurityBootstrapTokenEscrowed = "ESCROWED"
	MobileDeviceSecurityBootstrapTokenEscrowedNotEscrowed  MobileDeviceSecurityBootstrapTokenEscrowed = "NOT_ESCROWED"
	MobileDeviceSecurityBootstrapTokenEscrowedNotSupported MobileDeviceSecurityBootstrapTokenEscrowed = "NOT_SUPPORTED"
)

MobileDeviceSecurityBootstrapTokenEscrowed values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceSecurityBootstrapTokenEscrowedValues 

func MobileDeviceSecurityBootstrapTokenEscrowedValues() []MobileDeviceSecurityBootstrapTokenEscrowed

MobileDeviceSecurityBootstrapTokenEscrowedValues returns every value the Jamf API accepts for MobileDeviceSecurityBootstrapTokenEscrowed, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceServiceSubscriptions 

type MobileDeviceServiceSubscriptions struct {
	CarrierSettingsVersion   string `json:"carrierSettingsVersion"`
	CurrentCarrierNetwork    string `json:"currentCarrierNetwork"`
	CurrentMobileCountryCode string `json:"currentMobileCountryCode"`
	CurrentMobileNetworkCode string `json:"currentMobileNetworkCode"`
	DataPreferred            bool   `json:"dataPreferred"`
	Eid                      string `json:"eid"`
	Iccid                    string `json:"iccid"`
	Imei                     string `json:"imei"`
	Label                    string `json:"label"`
	// The unique identifier for this subscription.
	LabelID     string `json:"labelId"`
	Meid        string `json:"meid"`
	PhoneNumber string `json:"phoneNumber"`
	Roaming     bool   `json:"roaming"`
	// The description of the slot that contains the SIM representing this subscription.
	Slot                     string `json:"slot"`
	SubscriberCarrierNetwork string `json:"subscriberCarrierNetwork"`
	VoicePreferred           bool   `json:"voicePreferred"`
}

MobileDeviceServiceSubscriptions represents a mobile device service subscriptions.

type MobileDeviceSharedUser 

type MobileDeviceSharedUser struct {
	DataToSync     bool   `json:"dataToSync"`
	LoggedIn       bool   `json:"loggedIn"`
	ManagedAppleID string `json:"managedAppleId"`
}

MobileDeviceSharedUser represents a mobile device shared user.

type MobileDeviceSmartGroupCriteriaV2 

type MobileDeviceSmartGroupCriteriaV2 struct {
	// Whether this criterion should be ANDed or ORed with the previous criterion. Must be exactly "and" or
	// "or" (case-insensitive).
	// Allowed values: see the MobileDeviceSmartGroupCriteriaV2AndOr constants.
	AndOr string `json:"andOr"`
	// Whether to add a closing parenthesis after this criterion.
	ClosingParen *bool `json:"closingParen,omitempty"`
	// The field to search on (e.g., Model, OS Version, etc.).
	Name string `json:"name"`
	// Whether to add an opening parenthesis before this criterion.
	OpeningParen *bool `json:"openingParen,omitempty"`
	// The priority order of this criterion (must start at 0 and increment by 1).
	Priority int `json:"priority"`
	// The type of search to perform (e.g., is, is not, like, etc.).
	SearchType string `json:"searchType"`
	// The value to search for.
	Value string `json:"value"`
}

MobileDeviceSmartGroupCriteriaV2 represents a mobile device smart group criteria v2.

type MobileDeviceSmartGroupCriteriaV2AndOr 

type MobileDeviceSmartGroupCriteriaV2AndOr = string

MobileDeviceSmartGroupCriteriaV2AndOr is the set of values accepted by MobileDeviceSmartGroupCriteriaV2.AndOr. 

const (
	MobileDeviceSmartGroupCriteriaV2AndOrAnd MobileDeviceSmartGroupCriteriaV2AndOr = "and"
	MobileDeviceSmartGroupCriteriaV2AndOrOr  MobileDeviceSmartGroupCriteriaV2AndOr = "or"
)

MobileDeviceSmartGroupCriteriaV2AndOr values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceSmartGroupCriteriaV2AndOrValues 

func MobileDeviceSmartGroupCriteriaV2AndOrValues() []MobileDeviceSmartGroupCriteriaV2AndOr

MobileDeviceSmartGroupCriteriaV2AndOrValues returns every value the Jamf API accepts for MobileDeviceSmartGroupCriteriaV2AndOr, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceSystemHealth 

type MobileDeviceSystemHealth struct {
	Baseband      string `json:"baseband"`
	Camera        string `json:"camera"`
	Display       string `json:"display"`
	FaceID        string `json:"faceId"`
	Nfc           string `json:"nfc"`
	TouchID       string `json:"touchId"`
	UltraWideband string `json:"ultraWideband"`
}

MobileDeviceSystemHealth System health status for device components. Reported for iOS devices.

type MobileDeviceTvOsGeneral 

type MobileDeviceTvOsGeneral struct {
	AirPlayPassword string `json:"airPlayPassword"`
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceTvOsGeneralAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool `json:"awaitingConfiguration"`
	DeclarativeDeviceManagementEnabled bool `json:"declarativeDeviceManagementEnabled"`
	// The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method
	// was removed as of 11.25.
	// Allowed values: see the MobileDeviceTvOsGeneralDeviceOwnershipType constants.
	DeviceOwnershipType         string                           `json:"deviceOwnershipType"`
	DisplayName                 string                           `json:"displayName"`
	EnrollmentMethodPrestage    *EnrollmentMethodPrestage        `json:"enrollmentMethodPrestage,omitempty"`
	EnrollmentSessionTokenValid bool                             `json:"enrollmentSessionTokenValid"`
	ExtensionAttributes         []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	IPAddress                   string                           `json:"ipAddress"`
	Languages                   string                           `json:"languages"`
	// The date and time of the most recent device contact via MDM or DDM channels.
	LastContactDate                          *time.Time `json:"lastContactDate,omitempty"`
	LastEnrolledDate                         *time.Time `json:"lastEnrolledDate,omitempty"`
	LastInventoryUpdateDate                  *time.Time `json:"lastInventoryUpdateDate,omitempty"`
	LastLoggedInUsernameMDM                  *string    `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp         *time.Time `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService          *string    `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp *time.Time `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	Locales                                  string     `json:"locales"`
	Managed                                  bool       `json:"managed"`
	ManagementID                             string     `json:"managementId"`
	MDMProfileExpirationDate                 *time.Time `json:"mdmProfileExpirationDate,omitempty"`
	OsBuild                                  string     `json:"osBuild"`
	OsRapidSecurityResponse                  string     `json:"osRapidSecurityResponse"`
	OsSupplementalBuildVersion               string     `json:"osSupplementalBuildVersion"`
	OsVersion                                string     `json:"osVersion"`
	SiteID                                   string     `json:"siteId"`
	SoftwareUpdateDeviceID                   string     `json:"softwareUpdateDeviceId"`
	Supervised                               bool       `json:"supervised"`
	// IANA time zone database name.
	TimeZone string `json:"timeZone"`
	UDID     string `json:"udid"`
}

MobileDeviceTvOsGeneral represents a mobile device tv os general.

type MobileDeviceTvOsGeneralAppleEnrollmentType 

type MobileDeviceTvOsGeneralAppleEnrollmentType = string

MobileDeviceTvOsGeneralAppleEnrollmentType is the set of values accepted by MobileDeviceTvOsGeneral.AppleEnrollmentType. 

const (
	MobileDeviceTvOsGeneralAppleEnrollmentTypeNone       MobileDeviceTvOsGeneralAppleEnrollmentType = "none"
	MobileDeviceTvOsGeneralAppleEnrollmentTypeSupervised MobileDeviceTvOsGeneralAppleEnrollmentType = "supervised"
	MobileDeviceTvOsGeneralAppleEnrollmentTypeDevice     MobileDeviceTvOsGeneralAppleEnrollmentType = "device"
	MobileDeviceTvOsGeneralAppleEnrollmentTypeUser       MobileDeviceTvOsGeneralAppleEnrollmentType = "user"
	MobileDeviceTvOsGeneralAppleEnrollmentTypeUnknown    MobileDeviceTvOsGeneralAppleEnrollmentType = "unknown"
)

MobileDeviceTvOsGeneralAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceTvOsGeneralAppleEnrollmentTypeValues 

func MobileDeviceTvOsGeneralAppleEnrollmentTypeValues() []MobileDeviceTvOsGeneralAppleEnrollmentType

MobileDeviceTvOsGeneralAppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceTvOsGeneralAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceTvOsGeneralDeviceOwnershipType 

type MobileDeviceTvOsGeneralDeviceOwnershipType = string

MobileDeviceTvOsGeneralDeviceOwnershipType is the set of values accepted by MobileDeviceTvOsGeneral.DeviceOwnershipType. 

const (
	MobileDeviceTvOsGeneralDeviceOwnershipTypeInstitutional                 MobileDeviceTvOsGeneralDeviceOwnershipType = "Institutional"
	MobileDeviceTvOsGeneralDeviceOwnershipTypeUserEnrollment                MobileDeviceTvOsGeneralDeviceOwnershipType = "UserEnrollment"
	MobileDeviceTvOsGeneralDeviceOwnershipTypeAccountDrivenUserEnrollment   MobileDeviceTvOsGeneralDeviceOwnershipType = "AccountDrivenUserEnrollment"
	MobileDeviceTvOsGeneralDeviceOwnershipTypeAccountDrivenDeviceEnrollment MobileDeviceTvOsGeneralDeviceOwnershipType = "AccountDrivenDeviceEnrollment"
)

MobileDeviceTvOsGeneralDeviceOwnershipType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceTvOsGeneralDeviceOwnershipTypeValues 

func MobileDeviceTvOsGeneralDeviceOwnershipTypeValues() []MobileDeviceTvOsGeneralDeviceOwnershipType

MobileDeviceTvOsGeneralDeviceOwnershipTypeValues returns every value the Jamf API accepts for MobileDeviceTvOsGeneralDeviceOwnershipType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceTvOsInventory 

type MobileDeviceTvOsInventory struct {
	Applications []MobileDeviceApplicationInventoryDetail `json:"applications"`
	Certificates []MobileDeviceCertificate                `json:"certificates"`
	// Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.
	DeviceType          string                           `json:"deviceType"`
	ExtensionAttributes []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	General             *MobileDeviceTvOsGeneral         `json:"general,omitempty"`
	Groups              []MobileDeviceInventoryGroup     `json:"groups"`
	Hardware            *MobileDeviceHardware            `json:"hardware,omitempty"`
	MobileDeviceID      string                           `json:"mobileDeviceId"`
	Profiles            []MobileDeviceProfile            `json:"profiles"`
	Purchasing          *MobileDevicePurchasing          `json:"purchasing,omitempty"`
	UserAndLocation     *MobileDeviceUserAndLocation     `json:"userAndLocation,omitempty"`
	UserProfiles        []MobileDeviceUserProfile        `json:"userProfiles"`
}

MobileDeviceTvOsInventory represents a mobile device tv os inventory.

type MobileDeviceUserAndLocation 

type MobileDeviceUserAndLocation struct {
	Building            string                           `json:"building"`
	BuildingID          string                           `json:"buildingId"`
	Department          string                           `json:"department"`
	DepartmentID        string                           `json:"departmentId"`
	EmailAddress        string                           `json:"emailAddress"`
	ExtensionAttributes []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	PhoneNumber         string                           `json:"phoneNumber"`
	Position            string                           `json:"position"`
	RealName            string                           `json:"realName"`
	Room                string                           `json:"room"`
	Username            string                           `json:"username"`
}

MobileDeviceUserAndLocation represents a mobile device user and location.

type MobileDeviceUserProfile 

type MobileDeviceUserProfile struct {
	DisplayName   string     `json:"displayName"`
	Identifier    string     `json:"identifier"`
	LastInstalled *time.Time `json:"lastInstalled,omitempty"`
	Removable     bool       `json:"removable"`
	Username      string     `json:"username"`
	UUID          string     `json:"uuid"`
	Version       string     `json:"version"`
}

MobileDeviceUserProfile represents a mobile device user profile.

type MobileDeviceV2 

type MobileDeviceV2 struct {
	ID                     string `json:"id"`
	ManagementID           string `json:"managementId"`
	Model                  string `json:"model"`
	ModelIdentifier        string `json:"modelIdentifier"`
	Name                   string `json:"name"`
	PhoneNumber            string `json:"phoneNumber"`
	SerialNumber           string `json:"serialNumber"`
	SoftwareUpdateDeviceID string `json:"softwareUpdateDeviceId"`
	// Allowed values: see the MobileDeviceV2Type constants.
	Type           string `json:"type"`
	UDID           string `json:"udid"`
	Username       string `json:"username"`
	WifiMacAddress string `json:"wifiMacAddress"`
}

MobileDeviceV2 represents a mobile device v2.

type MobileDeviceV2Type 

type MobileDeviceV2Type = string

MobileDeviceV2Type is the set of values accepted by MobileDeviceV2.Type. 

const (
	MobileDeviceV2TypeIos      MobileDeviceV2Type = "ios"
	MobileDeviceV2TypeTvos     MobileDeviceV2Type = "tvos"
	MobileDeviceV2TypeWatchos  MobileDeviceV2Type = "watchos"
	MobileDeviceV2TypeVisionos MobileDeviceV2Type = "visionos"
	MobileDeviceV2TypeUnknown  MobileDeviceV2Type = "unknown"
)

MobileDeviceV2Type values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceV2TypeValues 

func MobileDeviceV2TypeValues() []MobileDeviceV2Type

MobileDeviceV2TypeValues returns every value the Jamf API accepts for MobileDeviceV2Type, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceVisionOsGeneral 

type MobileDeviceVisionOsGeneral struct {
	AppAnalyticsEnabled bool `json:"appAnalyticsEnabled"`
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceVisionOsGeneralAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool `json:"awaitingConfiguration"`
	CloudBackupEnabled                 bool `json:"cloudBackupEnabled"`
	DeclarativeDeviceManagementEnabled bool `json:"declarativeDeviceManagementEnabled"`
	DeviceLocatorServiceEnabled        bool `json:"deviceLocatorServiceEnabled"`
	// The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method
	// was removed as of 11.25.
	// Allowed values: see the MobileDeviceVisionOsGeneralDeviceOwnershipType constants.
	DeviceOwnershipType                string                           `json:"deviceOwnershipType"`
	DiagnosticAndUsageReportingEnabled bool                             `json:"diagnosticAndUsageReportingEnabled"`
	DisplayName                        string                           `json:"displayName"`
	DoNotDisturbEnabled                bool                             `json:"doNotDisturbEnabled"`
	EnrollmentMethodPrestage           *EnrollmentMethodPrestage        `json:"enrollmentMethodPrestage,omitempty"`
	EnrollmentSessionTokenValid        bool                             `json:"enrollmentSessionTokenValid"`
	ExtensionAttributes                []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	IPAddress                          string                           `json:"ipAddress"`
	ItunesStoreAccountActive           bool                             `json:"itunesStoreAccountActive"`
	LastCloudBackupDate                *time.Time                       `json:"lastCloudBackupDate,omitempty"`
	// The date and time of the most recent device contact via MDM or DDM channels.
	LastContactDate                          *time.Time `json:"lastContactDate,omitempty"`
	LastEnrolledDate                         *time.Time `json:"lastEnrolledDate,omitempty"`
	LastInventoryUpdateDate                  *time.Time `json:"lastInventoryUpdateDate,omitempty"`
	LastLoggedInUsernameMDM                  *string    `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp         *time.Time `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService          *string    `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp *time.Time `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	Managed                                  bool       `json:"managed"`
	ManagementID                             string     `json:"managementId"`
	MDMProfileExpirationDate                 *time.Time `json:"mdmProfileExpirationDate,omitempty"`
	OsBuild                                  string     `json:"osBuild"`
	OsRapidSecurityResponse                  string     `json:"osRapidSecurityResponse"`
	OsSupplementalBuildVersion               string     `json:"osSupplementalBuildVersion"`
	OsVersion                                string     `json:"osVersion"`
	SiteID                                   string     `json:"siteId"`
	SoftwareUpdateDeviceID                   string     `json:"softwareUpdateDeviceId"`
	Supervised                               bool       `json:"supervised"`
	// IANA time zone database name.
	TimeZone string `json:"timeZone"`
	UDID     string `json:"udid"`
}

MobileDeviceVisionOsGeneral represents a mobile device vision os general.

type MobileDeviceVisionOsGeneralAppleEnrollmentType 

type MobileDeviceVisionOsGeneralAppleEnrollmentType = string

MobileDeviceVisionOsGeneralAppleEnrollmentType is the set of values accepted by MobileDeviceVisionOsGeneral.AppleEnrollmentType. 

const (
	MobileDeviceVisionOsGeneralAppleEnrollmentTypeNone       MobileDeviceVisionOsGeneralAppleEnrollmentType = "none"
	MobileDeviceVisionOsGeneralAppleEnrollmentTypeSupervised MobileDeviceVisionOsGeneralAppleEnrollmentType = "supervised"
	MobileDeviceVisionOsGeneralAppleEnrollmentTypeDevice     MobileDeviceVisionOsGeneralAppleEnrollmentType = "device"
	MobileDeviceVisionOsGeneralAppleEnrollmentTypeUser       MobileDeviceVisionOsGeneralAppleEnrollmentType = "user"
	MobileDeviceVisionOsGeneralAppleEnrollmentTypeUnknown    MobileDeviceVisionOsGeneralAppleEnrollmentType = "unknown"
)

MobileDeviceVisionOsGeneralAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceVisionOsGeneralAppleEnrollmentTypeValues 

func MobileDeviceVisionOsGeneralAppleEnrollmentTypeValues() []MobileDeviceVisionOsGeneralAppleEnrollmentType

MobileDeviceVisionOsGeneralAppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceVisionOsGeneralAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceVisionOsGeneralDeviceOwnershipType 

type MobileDeviceVisionOsGeneralDeviceOwnershipType = string

MobileDeviceVisionOsGeneralDeviceOwnershipType is the set of values accepted by MobileDeviceVisionOsGeneral.DeviceOwnershipType. 

const (
	MobileDeviceVisionOsGeneralDeviceOwnershipTypeInstitutional                 MobileDeviceVisionOsGeneralDeviceOwnershipType = "Institutional"
	MobileDeviceVisionOsGeneralDeviceOwnershipTypeUserEnrollment                MobileDeviceVisionOsGeneralDeviceOwnershipType = "UserEnrollment"
	MobileDeviceVisionOsGeneralDeviceOwnershipTypeAccountDrivenUserEnrollment   MobileDeviceVisionOsGeneralDeviceOwnershipType = "AccountDrivenUserEnrollment"
	MobileDeviceVisionOsGeneralDeviceOwnershipTypeAccountDrivenDeviceEnrollment MobileDeviceVisionOsGeneralDeviceOwnershipType = "AccountDrivenDeviceEnrollment"
)

MobileDeviceVisionOsGeneralDeviceOwnershipType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceVisionOsGeneralDeviceOwnershipTypeValues 

func MobileDeviceVisionOsGeneralDeviceOwnershipTypeValues() []MobileDeviceVisionOsGeneralDeviceOwnershipType

MobileDeviceVisionOsGeneralDeviceOwnershipTypeValues returns every value the Jamf API accepts for MobileDeviceVisionOsGeneralDeviceOwnershipType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceVisionOsInventory 

type MobileDeviceVisionOsInventory struct {
	Applications []MobileDeviceApplicationInventoryDetail `json:"applications"`
	Certificates []MobileDeviceCertificate                `json:"certificates"`
	// Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.
	DeviceType          string                           `json:"deviceType"`
	ExtensionAttributes []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	General             *MobileDeviceVisionOsGeneral     `json:"general,omitempty"`
	Groups              []MobileDeviceInventoryGroup     `json:"groups"`
	Hardware            *MobileDeviceHardware            `json:"hardware,omitempty"`
	MobileDeviceID      string                           `json:"mobileDeviceId"`
	// This section only avaiable for Ios type.
	Network              *MobileDeviceNetwork                `json:"network,omitempty"`
	Profiles             []MobileDeviceProfile               `json:"profiles"`
	ProvisioningProfiles *[]MobileDeviceProvisioningProfiles `json:"provisioningProfiles,omitempty"`
	Purchasing           *MobileDevicePurchasing             `json:"purchasing,omitempty"`
	// This section only available for Ios type.
	Security        *MobileDeviceSecurity        `json:"security,omitempty"`
	UserAndLocation *MobileDeviceUserAndLocation `json:"userAndLocation,omitempty"`
}

MobileDeviceVisionOsInventory represents a mobile device vision os inventory.

type MobileDeviceWatchOsGeneral 

type MobileDeviceWatchOsGeneral struct {
	AppAnalyticsEnabled bool `json:"appAnalyticsEnabled"`
	// The enrollment type reported by Apple.
	// Allowed values: see the MobileDeviceWatchOsGeneralAppleEnrollmentType constants.
	AppleEnrollmentType string `json:"appleEnrollmentType"`
	AssetTag            string `json:"assetTag"`
	// Whether the device is awaiting configuration.
	AwaitingConfiguration              bool `json:"awaitingConfiguration"`
	DeclarativeDeviceManagementEnabled bool `json:"declarativeDeviceManagementEnabled"`
	DeviceLocatorServiceEnabled        bool `json:"deviceLocatorServiceEnabled"`
	// The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method
	// was removed as of 11.25.
	// Allowed values: see the MobileDeviceWatchOsGeneralDeviceOwnershipType constants.
	DeviceOwnershipType                string                           `json:"deviceOwnershipType"`
	DiagnosticAndUsageReportingEnabled bool                             `json:"diagnosticAndUsageReportingEnabled"`
	DisplayName                        string                           `json:"displayName"`
	DoNotDisturbEnabled                bool                             `json:"doNotDisturbEnabled"`
	EnrollmentMethodPrestage           *EnrollmentMethodPrestage        `json:"enrollmentMethodPrestage,omitempty"`
	EnrollmentSessionTokenValid        bool                             `json:"enrollmentSessionTokenValid"`
	ExtensionAttributes                []MobileDeviceExtensionAttribute `json:"extensionAttributes"`
	IPAddress                          string                           `json:"ipAddress"`
	ItunesStoreAccountActive           bool                             `json:"itunesStoreAccountActive"`
	LastCloudBackupDate                *time.Time                       `json:"lastCloudBackupDate,omitempty"`
	// The date and time of the most recent device contact via MDM or DDM channels.
	LastContactDate                          *time.Time `json:"lastContactDate,omitempty"`
	LastEnrolledDate                         *time.Time `json:"lastEnrolledDate,omitempty"`
	LastInventoryUpdateDate                  *time.Time `json:"lastInventoryUpdateDate,omitempty"`
	LastLoggedInUsernameMDM                  *string    `json:"lastLoggedInUsernameMdm,omitempty"`
	LastLoggedInUsernameMDMTimestamp         *time.Time `json:"lastLoggedInUsernameMdmTimestamp,omitempty"`
	LastLoggedInUsernameSelfService          *string    `json:"lastLoggedInUsernameSelfService,omitempty"`
	LastLoggedInUsernameSelfServiceTimestamp *time.Time `json:"lastLoggedInUsernameSelfServiceTimestamp,omitempty"`
	Managed                                  bool       `json:"managed"`
	ManagementID                             string     `json:"managementId"`
	MDMProfileExpirationDate                 *time.Time `json:"mdmProfileExpirationDate,omitempty"`
	OsBuild                                  string     `json:"osBuild"`
	OsRapidSecurityResponse                  string     `json:"osRapidSecurityResponse"`
	OsSupplementalBuildVersion               string     `json:"osSupplementalBuildVersion"`
	OsVersion                                string     `json:"osVersion"`
	SiteID                                   string     `json:"siteId"`
	SoftwareUpdateDeviceID                   string     `json:"softwareUpdateDeviceId"`
	Supervised                               bool       `json:"supervised"`
	// IANA time zone database name.
	TimeZone string `json:"timeZone"`
	UDID     string `json:"udid"`
}

MobileDeviceWatchOsGeneral represents a mobile device watch os general.

type MobileDeviceWatchOsGeneralAppleEnrollmentType 

type MobileDeviceWatchOsGeneralAppleEnrollmentType = string

MobileDeviceWatchOsGeneralAppleEnrollmentType is the set of values accepted by MobileDeviceWatchOsGeneral.AppleEnrollmentType. 

const (
	MobileDeviceWatchOsGeneralAppleEnrollmentTypeNone       MobileDeviceWatchOsGeneralAppleEnrollmentType = "none"
	MobileDeviceWatchOsGeneralAppleEnrollmentTypeSupervised MobileDeviceWatchOsGeneralAppleEnrollmentType = "supervised"
	MobileDeviceWatchOsGeneralAppleEnrollmentTypeDevice     MobileDeviceWatchOsGeneralAppleEnrollmentType = "device"
	MobileDeviceWatchOsGeneralAppleEnrollmentTypeUser       MobileDeviceWatchOsGeneralAppleEnrollmentType = "user"
	MobileDeviceWatchOsGeneralAppleEnrollmentTypeUnknown    MobileDeviceWatchOsGeneralAppleEnrollmentType = "unknown"
)

MobileDeviceWatchOsGeneralAppleEnrollmentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceWatchOsGeneralAppleEnrollmentTypeValues 

func MobileDeviceWatchOsGeneralAppleEnrollmentTypeValues() []MobileDeviceWatchOsGeneralAppleEnrollmentType

MobileDeviceWatchOsGeneralAppleEnrollmentTypeValues returns every value the Jamf API accepts for MobileDeviceWatchOsGeneralAppleEnrollmentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceWatchOsGeneralDeviceOwnershipType 

type MobileDeviceWatchOsGeneralDeviceOwnershipType = string

MobileDeviceWatchOsGeneralDeviceOwnershipType is the set of values accepted by MobileDeviceWatchOsGeneral.DeviceOwnershipType. 

const (
	MobileDeviceWatchOsGeneralDeviceOwnershipTypeInstitutional                 MobileDeviceWatchOsGeneralDeviceOwnershipType = "Institutional"
	MobileDeviceWatchOsGeneralDeviceOwnershipTypeUserEnrollment                MobileDeviceWatchOsGeneralDeviceOwnershipType = "UserEnrollment"
	MobileDeviceWatchOsGeneralDeviceOwnershipTypeAccountDrivenUserEnrollment   MobileDeviceWatchOsGeneralDeviceOwnershipType = "AccountDrivenUserEnrollment"
	MobileDeviceWatchOsGeneralDeviceOwnershipTypeAccountDrivenDeviceEnrollment MobileDeviceWatchOsGeneralDeviceOwnershipType = "AccountDrivenDeviceEnrollment"
)

MobileDeviceWatchOsGeneralDeviceOwnershipType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func MobileDeviceWatchOsGeneralDeviceOwnershipTypeValues 

func MobileDeviceWatchOsGeneralDeviceOwnershipTypeValues() []MobileDeviceWatchOsGeneralDeviceOwnershipType

MobileDeviceWatchOsGeneralDeviceOwnershipTypeValues returns every value the Jamf API accepts for MobileDeviceWatchOsGeneralDeviceOwnershipType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type MobileDeviceWatchOsInventory 

type MobileDeviceWatchOsInventory struct {
	Applications []MobileDeviceApplicationInventoryDetail `json:"applications"`
	Certificates []MobileDeviceCertificate                `json:"certificates"`
	// Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.
	DeviceType           string                             `json:"deviceType"`
	ExtensionAttributes  []MobileDeviceExtensionAttribute   `json:"extensionAttributes"`
	General              *MobileDeviceWatchOsGeneral        `json:"general,omitempty"`
	Groups               []MobileDeviceInventoryGroup       `json:"groups"`
	Hardware             *MobileDeviceHardware              `json:"hardware,omitempty"`
	MobileDeviceID       string                             `json:"mobileDeviceId"`
	Profiles             []MobileDeviceProfile              `json:"profiles"`
	ProvisioningProfiles []MobileDeviceProvisioningProfiles `json:"provisioningProfiles"`
	// This section only available for Ios type.
	Security        *MobileDeviceSecurity        `json:"security,omitempty"`
	UserAndLocation *MobileDeviceUserAndLocation `json:"userAndLocation,omitempty"`
}

MobileDeviceWatchOsInventory represents a mobile device watch os inventory.

type NetworkV2 

type NetworkV2 struct {
	CarrierSettingsVersion   string `json:"carrierSettingsVersion"`
	CellularTechnology       string `json:"cellularTechnology"`
	CurrentCarrierNetwork    string `json:"currentCarrierNetwork"`
	CurrentMobileCountryCode string `json:"currentMobileCountryCode"`
	CurrentMobileNetworkCode string `json:"currentMobileNetworkCode"`
	DataRoamingEnabled       bool   `json:"dataRoamingEnabled"`
	// EID or "embedded identity document" is a number associated with the eSIM on a device.
	Eid                    string `json:"eid"`
	HomeCarrierNetwork     string `json:"homeCarrierNetwork"`
	HomeMobileCountryCode  string `json:"homeMobileCountryCode"`
	HomeMobileNetworkCode  string `json:"homeMobileNetworkCode"`
	Iccid                  string `json:"iccid"`
	Imei                   string `json:"imei"`
	Meid                   string `json:"meid"`
	PersonalHotspotEnabled bool   `json:"personalHotspotEnabled"`
	PhoneNumber            string `json:"phoneNumber"`
	PreferredVoiceNumber   string `json:"preferredVoiceNumber"`
	Roaming                bool   `json:"roaming"`
	VoiceRoamingEnabled    bool   `json:"voiceRoamingEnabled"`
}

NetworkV2 represents a network v2.

type NotificationType 

type NotificationType = string

NotificationType represents a notification type value. 

const (
	NotificationTypeApnsCertRevoked                                       NotificationType = "APNS_CERT_REVOKED"
	NotificationTypeApnsConnectionFailure                                 NotificationType = "APNS_CONNECTION_FAILURE"
	NotificationTypeAppleSchoolManagerTCNotSigned                         NotificationType = "APPLE_SCHOOL_MANAGER_T_C_NOT_SIGNED"
	NotificationTypeBuiltInCaExpired                                      NotificationType = "BUILT_IN_CA_EXPIRED"
	NotificationTypeBuiltInCaExpiring                                     NotificationType = "BUILT_IN_CA_EXPIRING"
	NotificationTypeBuiltInCaRenewalFailed                                NotificationType = "BUILT_IN_CA_RENEWAL_FAILED"
	NotificationTypeBuiltInCaRenewalSuccess                               NotificationType = "BUILT_IN_CA_RENEWAL_SUCCESS"
	NotificationTypeCloudLdapCertExpired                                  NotificationType = "CLOUD_LDAP_CERT_EXPIRED"
	NotificationTypeCloudLdapCertWillExpire                               NotificationType = "CLOUD_LDAP_CERT_WILL_EXPIRE"
	NotificationTypeDepInstanceExpired                                    NotificationType = "DEP_INSTANCE_EXPIRED"
	NotificationTypeDepInstanceWillExpire                                 NotificationType = "DEP_INSTANCE_WILL_EXPIRE"
	NotificationTypeDeviceEnrollmentProgramTCNotSigned                    NotificationType = "DEVICE_ENROLLMENT_PROGRAM_T_C_NOT_SIGNED"
	NotificationTypeExceededLicenseCount                                  NotificationType = "EXCEEDED_LICENSE_COUNT"
	NotificationTypeFrequentInventoryCollectionPolicy                     NotificationType = "FREQUENT_INVENTORY_COLLECTION_POLICY"
	NotificationTypeGsxCertExpired                                        NotificationType = "GSX_CERT_EXPIRED"
	NotificationTypeGsxCertWillExpire                                     NotificationType = "GSX_CERT_WILL_EXPIRE"
	NotificationTypeHclBindError                                          NotificationType = "HCL_BIND_ERROR"
	NotificationTypeHclError                                              NotificationType = "HCL_ERROR"
	NotificationTypeInsecureLdap                                          NotificationType = "INSECURE_LDAP"
	NotificationTypeInvalidReferencesExtAttr                              NotificationType = "INVALID_REFERENCES_EXT_ATTR"
	NotificationTypeInvalidReferencesPolicies                             NotificationType = "INVALID_REFERENCES_POLICIES"
	NotificationTypeInvalidReferencesScripts                              NotificationType = "INVALID_REFERENCES_SCRIPTS"
	NotificationTypeJamfConnectUpdate                                     NotificationType = "JAMF_CONNECT_UPDATE"
	NotificationTypeJamfProtectUpdate                                     NotificationType = "JAMF_PROTECT_UPDATE"
	NotificationTypeJimError                                              NotificationType = "JIM_ERROR"
	NotificationTypeLdapConnectionCheckThroughJimFailed                   NotificationType = "LDAP_CONNECTION_CHECK_THROUGH_JIM_FAILED"
	NotificationTypeLdapConnectionCheckThroughJimSuccessful               NotificationType = "LDAP_CONNECTION_CHECK_THROUGH_JIM_SUCCESSFUL"
	NotificationTypeMDMExternalSigningCertificateExpired                  NotificationType = "MDM_EXTERNAL_SIGNING_CERTIFICATE_EXPIRED"
	NotificationTypeMDMExternalSigningCertificateExpiring                 NotificationType = "MDM_EXTERNAL_SIGNING_CERTIFICATE_EXPIRING"
	NotificationTypeMDMExternalSigningCertificateExpiringToday            NotificationType = "MDM_EXTERNAL_SIGNING_CERTIFICATE_EXPIRING_TODAY"
	NotificationTypeMiiHeartbeatFailedNotification                        NotificationType = "MII_HEARTBEAT_FAILED_NOTIFICATION"
	NotificationTypeMiiInventoryUploadFailedNotification                  NotificationType = "MII_INVENTORY_UPLOAD_FAILED_NOTIFICATION"
	NotificationTypeMiiUnathorizedResponseNotification                    NotificationType = "MII_UNATHORIZED_RESPONSE_NOTIFICATION"
	NotificationTypePatchExtentionAttribute                               NotificationType = "PATCH_EXTENTION_ATTRIBUTE"
	NotificationTypePatchUpdate                                           NotificationType = "PATCH_UPDATE"
	NotificationTypePolicyManagementAccountPayloadSecurityMultiple        NotificationType = "POLICY_MANAGEMENT_ACCOUNT_PAYLOAD_SECURITY_MULTIPLE"
	NotificationTypePolicyManagementAccountPayloadSecuritySingle          NotificationType = "POLICY_MANAGEMENT_ACCOUNT_PAYLOAD_SECURITY_SINGLE"
	NotificationTypePushCertExpired                                       NotificationType = "PUSH_CERT_EXPIRED"
	NotificationTypePushCertWillExpire                                    NotificationType = "PUSH_CERT_WILL_EXPIRE"
	NotificationTypePushProxyCertExpired                                  NotificationType = "PUSH_PROXY_CERT_EXPIRED"
	NotificationTypeSsoCertExpired                                        NotificationType = "SSO_CERT_EXPIRED"
	NotificationTypeSsoIdpCertExpired                                     NotificationType = "SSO_IDP_CERT_EXPIRED"
	NotificationTypeSsoCertWillExpire                                     NotificationType = "SSO_CERT_WILL_EXPIRE"
	NotificationTypeSsoIdpCertWillExpire                                  NotificationType = "SSO_IDP_CERT_WILL_EXPIRE"
	NotificationTypeTomcatSslCertExpired                                  NotificationType = "TOMCAT_SSL_CERT_EXPIRED"
	NotificationTypeTomcatSslCertWillExpire                               NotificationType = "TOMCAT_SSL_CERT_WILL_EXPIRE"
	NotificationTypeUserInitiatedEnrollmentManagementAccountSecurityIssue NotificationType = "USER_INITIATED_ENROLLMENT_MANAGEMENT_ACCOUNT_SECURITY_ISSUE"
	NotificationTypeUserMaidDuplicateError                                NotificationType = "USER_MAID_DUPLICATE_ERROR"
	NotificationTypeUserMaidMismatchError                                 NotificationType = "USER_MAID_MISMATCH_ERROR"
	NotificationTypeUserMaidRosterDuplicateError                          NotificationType = "USER_MAID_ROSTER_DUPLICATE_ERROR"
	NotificationTypeVppAccountExpired                                     NotificationType = "VPP_ACCOUNT_EXPIRED"
	NotificationTypeVppAccountWillExpire                                  NotificationType = "VPP_ACCOUNT_WILL_EXPIRE"
	NotificationTypeVppTokenRevoked                                       NotificationType = "VPP_TOKEN_REVOKED"
	NotificationTypeDeviceComplianceConnectionError                       NotificationType = "DEVICE_COMPLIANCE_CONNECTION_ERROR"
	NotificationTypeConditionalAccessConnectionError                      NotificationType = "CONDITIONAL_ACCESS_CONNECTION_ERROR"
	NotificationTypeAzureAdMigrationReportGenerated                       NotificationType = "AZURE_AD_MIGRATION_REPORT_GENERATED"
	NotificationTypeBeyondCorpConnectionError                             NotificationType = "BEYOND_CORP_CONNECTION_ERROR"
	NotificationTypeAppInstallersNewAppVersionAvailable                   NotificationType = "APP_INSTALLERS_NEW_APP_VERSION_AVAILABLE"
	NotificationTypeAppInstallersNewAppVersionDeploymentStarted           NotificationType = "APP_INSTALLERS_NEW_APP_VERSION_DEPLOYMENT_STARTED"
	NotificationTypeAppInstallersAppVersionRemoved                        NotificationType = "APP_INSTALLERS_APP_VERSION_REMOVED"
	NotificationTypeAppInstallersAppTitleRemoved                          NotificationType = "APP_INSTALLERS_APP_TITLE_REMOVED"
	NotificationTypeAppInstallersDeploymentInstallationFailed             NotificationType = "APP_INSTALLERS_DEPLOYMENT_INSTALLATION_FAILED"
	NotificationTypeSamlResponseAssertionSigningRequired                  NotificationType = "SAML_RESPONSE_ASSERTION_SIGNING_REQUIRED"
	NotificationTypeDirectoryCacheAwaitingSync                            NotificationType = "DIRECTORY_CACHE_AWAITING_SYNC"
	NotificationTypePssoExternalURLUnavailable                            NotificationType = "PSSO_EXTERNAL_URL_UNAVAILABLE"
)

NotificationType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func NotificationTypeValues 

func NotificationTypeValues() []NotificationType

NotificationTypeValues returns every value the Jamf API accepts for NotificationType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type NotificationV1 

type NotificationV1 struct {
	ID     string            `json:"id"`
	Params map[string]any    `json:"params"`
	Type   *NotificationType `json:"type,omitempty"`
}

NotificationV1 Jamf Pro notification used for important alerts.

type ObjectHistory 

type ObjectHistory struct {
	Date     string  `json:"date"`
	Details  *string `json:"details,omitempty"`
	ID       int     `json:"id"`
	Note     string  `json:"note"`
	Username string  `json:"username"`
}

ObjectHistory represents a object history.

type ObjectHistoryNote 

type ObjectHistoryNote struct {
	Note string `json:"note"`
}

ObjectHistoryNote represents a object history note.

type ObjectHistoryV1 

type ObjectHistoryV1 struct {
	Date     string  `json:"date"`
	Details  *string `json:"details,omitempty"`
	ID       string  `json:"id"`
	Note     string  `json:"note"`
	Username string  `json:"username"`
}

ObjectHistoryV1 represents a object history v1.

type OidcBrokerConfig 

type OidcBrokerConfig struct {
	// A broker configuration carries ADMIN_SSO; an update preserves whatever is already stored rather than
	// replacing it. The other values exist for non-broker IdP configurations.
	// Allowed values: see the OidcBrokerConfigCapabilities constants.
	Capabilities []string `json:"capabilities"`
	// Read this before updating to determine whether an update changes the client authentication method,
	// which requires supplying the new method's credential.
	// Allowed values: see the OidcBrokerConfigClientAuthMethod constants.
	ClientAuthMethod *string `json:"clientAuthMethod,omitempty"`
	ClientID         string  `json:"clientId"`
	// Allowed values: see the OidcBrokerConfigClientType constants.
	ClientType   *string    `json:"clientType,omitempty"`
	CreatedAt    *time.Time `json:"createdAt,omitempty"`
	DiscoveryURL string     `json:"discoveryUrl"`
	Enabled      bool       `json:"enabled"`
	ID           string     `json:"id"`
	// Allowed values: see the OidcBrokerConfigProductUserMapping constants.
	ProductUserMapping   *string    `json:"productUserMapping,omitempty"`
	ProductUsernameClaim string     `json:"productUsernameClaim"`
	RedirectUris         []string   `json:"redirectUris"`
	Scopes               []string   `json:"scopes"`
	UpdatedAt            *time.Time `json:"updatedAt,omitempty"`
}

OidcBrokerConfig The tenant's currently selected OIDC broker IdP configuration. Secret fields (clientSecret, privateKeyJwt) are never included in the response. The three enum-valued fields are always present but may be null — an unrecognized value from a newer authentication service is read as null rather than failing the response.

type OidcBrokerConfigCapabilities 

type OidcBrokerConfigCapabilities = string

OidcBrokerConfigCapabilities is the set of values accepted by OidcBrokerConfig.Capabilities. 

const (
	OidcBrokerConfigCapabilitiesIosSelfServicePlus      OidcBrokerConfigCapabilities = "IOS_SELF_SERVICE_PLUS"
	OidcBrokerConfigCapabilitiesMacSelfServicePlus      OidcBrokerConfigCapabilities = "MAC_SELF_SERVICE_PLUS"
	OidcBrokerConfigCapabilitiesUserInitiatedEnrollment OidcBrokerConfigCapabilities = "USER_INITIATED_ENROLLMENT"
	OidcBrokerConfigCapabilitiesAdminSso                OidcBrokerConfigCapabilities = "ADMIN_SSO"
)

OidcBrokerConfigCapabilities values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcBrokerConfigCapabilitiesValues 

func OidcBrokerConfigCapabilitiesValues() []OidcBrokerConfigCapabilities

OidcBrokerConfigCapabilitiesValues returns every value the Jamf API accepts for OidcBrokerConfigCapabilities, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcBrokerConfigClientAuthMethod 

type OidcBrokerConfigClientAuthMethod = string

OidcBrokerConfigClientAuthMethod is the set of values accepted by OidcBrokerConfig.ClientAuthMethod. 

const (
	OidcBrokerConfigClientAuthMethodClientSecret  OidcBrokerConfigClientAuthMethod = "CLIENT_SECRET"
	OidcBrokerConfigClientAuthMethodPrivateKeyJwt OidcBrokerConfigClientAuthMethod = "PRIVATE_KEY_JWT"
)

OidcBrokerConfigClientAuthMethod values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcBrokerConfigClientAuthMethodValues 

func OidcBrokerConfigClientAuthMethodValues() []OidcBrokerConfigClientAuthMethod

OidcBrokerConfigClientAuthMethodValues returns every value the Jamf API accepts for OidcBrokerConfigClientAuthMethod, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcBrokerConfigClientType 

type OidcBrokerConfigClientType = string

OidcBrokerConfigClientType is the set of values accepted by OidcBrokerConfig.ClientType. 

const (
	OidcBrokerConfigClientTypePublic       OidcBrokerConfigClientType = "PUBLIC"
	OidcBrokerConfigClientTypeConfidential OidcBrokerConfigClientType = "CONFIDENTIAL"
)

OidcBrokerConfigClientType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcBrokerConfigClientTypeValues 

func OidcBrokerConfigClientTypeValues() []OidcBrokerConfigClientType

OidcBrokerConfigClientTypeValues returns every value the Jamf API accepts for OidcBrokerConfigClientType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcBrokerConfigProductUserMapping 

type OidcBrokerConfigProductUserMapping = string

OidcBrokerConfigProductUserMapping is the set of values accepted by OidcBrokerConfig.ProductUserMapping. 

const (
	OidcBrokerConfigProductUserMappingUsername OidcBrokerConfigProductUserMapping = "USERNAME"
	OidcBrokerConfigProductUserMappingEmail    OidcBrokerConfigProductUserMapping = "EMAIL"
)

OidcBrokerConfigProductUserMapping values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcBrokerConfigProductUserMappingValues 

func OidcBrokerConfigProductUserMappingValues() []OidcBrokerConfigProductUserMapping

OidcBrokerConfigProductUserMappingValues returns every value the Jamf API accepts for OidcBrokerConfigProductUserMapping, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcBrokerConfigUpdate 

type OidcBrokerConfigUpdate struct {
	// Selects which credential the authentication service stores and which it clears — the credential
	// belonging to the other method is discarded. Changing this value therefore requires the new method's
	// credential in the same request.
	// Allowed values: see the OidcBrokerConfigUpdateClientAuthMethod constants.
	ClientAuthMethod string `json:"clientAuthMethod"`
	ClientID         string `json:"clientId"`
	// Omit to keep the currently stored secret; supply to rotate it. Required when this request changes
	// clientAuthMethod to CLIENT_SECRET, or when clientAuthMethod is CLIENT_SECRET and no secret is
	// currently stored.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	ClientSecret *string `json:"clientSecret,omitempty"`
	DiscoveryURL string  `json:"discoveryUrl"`
	// Required. The authentication service replaces this value on every update, so omitting it would
	// silently re-enable a disabled configuration.
	Enabled bool `json:"enabled"`
	// Omit to keep the currently stored key; supply to rotate it. Required when this request changes
	// clientAuthMethod to PRIVATE_KEY_JWT, or when clientAuthMethod is PRIVATE_KEY_JWT and no key is
	// currently stored.
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	PrivateKeyJwt *string `json:"privateKeyJwt,omitempty"`
	// Allowed values: see the OidcBrokerConfigUpdateProductUserMapping constants.
	ProductUserMapping   string   `json:"productUserMapping"`
	ProductUsernameClaim *string  `json:"productUsernameClaim,omitempty"`
	Scopes               []string `json:"scopes"`
}

OidcBrokerConfigUpdate Full-replacement update of the tenant's broker IdP configuration. The config to update is the tenant's stored broker selection; it is not part of this body. Every non-secret field is replaced with the value sent here, so all of them must be supplied on every update; only the secret fields are kept when omitted — except when this request changes clientAuthMethod, which requires the new method's credential to be supplied. The clientType (always CONFIDENTIAL) is set by Jamf Pro, and the capabilities and redirect URIs are carried over from the stored configuration unchanged; none of the three can be supplied here.

type OidcBrokerConfigUpdateClientAuthMethod 

type OidcBrokerConfigUpdateClientAuthMethod = string

OidcBrokerConfigUpdateClientAuthMethod is the set of values accepted by OidcBrokerConfigUpdate.ClientAuthMethod. 

const (
	OidcBrokerConfigUpdateClientAuthMethodClientSecret  OidcBrokerConfigUpdateClientAuthMethod = "CLIENT_SECRET"
	OidcBrokerConfigUpdateClientAuthMethodPrivateKeyJwt OidcBrokerConfigUpdateClientAuthMethod = "PRIVATE_KEY_JWT"
)

OidcBrokerConfigUpdateClientAuthMethod values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcBrokerConfigUpdateClientAuthMethodValues 

func OidcBrokerConfigUpdateClientAuthMethodValues() []OidcBrokerConfigUpdateClientAuthMethod

OidcBrokerConfigUpdateClientAuthMethodValues returns every value the Jamf API accepts for OidcBrokerConfigUpdateClientAuthMethod, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcBrokerConfigUpdateProductUserMapping 

type OidcBrokerConfigUpdateProductUserMapping = string

OidcBrokerConfigUpdateProductUserMapping is the set of values accepted by OidcBrokerConfigUpdate.ProductUserMapping. 

const (
	OidcBrokerConfigUpdateProductUserMappingUsername OidcBrokerConfigUpdateProductUserMapping = "USERNAME"
	OidcBrokerConfigUpdateProductUserMappingEmail    OidcBrokerConfigUpdateProductUserMapping = "EMAIL"
)

OidcBrokerConfigUpdateProductUserMapping values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcBrokerConfigUpdateProductUserMappingValues 

func OidcBrokerConfigUpdateProductUserMappingValues() []OidcBrokerConfigUpdateProductUserMapping

OidcBrokerConfigUpdateProductUserMappingValues returns every value the Jamf API accepts for OidcBrokerConfigUpdateProductUserMapping, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcDirectIdpLoginSkipURL 

type OidcDirectIdpLoginSkipURL struct {
	// Direct IdP login URL to skip unified login page.
	URL string `json:"url"`
}

OidcDirectIdpLoginSkipURL represents a oidc direct idp login skip u r l.

type OidcJwksResponse 

type OidcJwksResponse struct {
	Keys []OidcJwksResponseKeysItem `json:"keys"`
}

OidcJwksResponse represents a oidc jwks response.

type OidcJwksResponseKeysItem 

type OidcJwksResponseKeysItem struct {
	Alg string `json:"alg"`
	E   string `json:"e"`
	Iat int    `json:"iat"`
	Kid string `json:"kid"`
	Kty string `json:"kty"`
	N   string `json:"n"`
	Use string `json:"use"`
}

OidcJwksResponseKeysItem represents a oidc jwks response keys item.

type OidcLoginDispatchRequest 

type OidcLoginDispatchRequest struct {
	// User email address.
	EmailAddress string `json:"emailAddress"`
	// Original Url.
	OriginalURL string `json:"originalUrl"`
}

OidcLoginDispatchRequest represents a oidc login dispatch request.

type OidcLoginDispatchResponseV2 

type OidcLoginDispatchResponseV2 struct {
	IdpRedirects []OidcLoginDispatchResponseV2IdpRedirectsItem `json:"idpRedirects"`
}

OidcLoginDispatchResponseV2 represents a oidc login dispatch response v2.

type OidcLoginDispatchResponseV2IdpRedirectsItem 

type OidcLoginDispatchResponseV2IdpRedirectsItem struct {
	IdpName string `json:"idpName"`
	IdpType string `json:"idpType"`
	// Customer-provided icon served by jamf account URL for this connection. Null when no custom icon is
	// configured (Jamf ID connections always return null).
	LogoURL     *string `json:"logoUrl,omitempty"`
	RedirectURL string  `json:"redirectUrl"`
}

OidcLoginDispatchResponseV2IdpRedirectsItem represents a oidc login dispatch response v2 idp redirects item.

type OidcPublicFeaturesResponse 

type OidcPublicFeaturesResponse struct {
	// Indicates whether Jamf ID authentication is enabled for this instance. When true, users can
	// authenticate using Jamf ID credentials. When false, Jamf ID login option is not available.
	JamfIDAuthenticationEnabled bool `json:"jamfIdAuthenticationEnabled"`
}

OidcPublicFeaturesResponse represents a oidc public features response.

type OidcSettings 

type OidcSettings struct {
	JamfIDAuthenticationEnabled *bool `json:"jamfIdAuthenticationEnabled"`
	// Allowed values: see the OidcSettingsUserMapping constants.
	UserMapping string `json:"userMapping"`
	// Allowed values: see the OidcSettingsUsernameAttributeClaimMapping constants.
	UsernameAttributeClaimMapping *string `json:"usernameAttributeClaimMapping"`
}

OidcSettings represents a oidc settings.

type OidcSettingsUserMapping 

type OidcSettingsUserMapping = string

OidcSettingsUserMapping is the set of values accepted by OidcSettings.UserMapping. 

const (
	OidcSettingsUserMappingUsername OidcSettingsUserMapping = "USERNAME"
	OidcSettingsUserMappingEmail    OidcSettingsUserMapping = "EMAIL"
)

OidcSettingsUserMapping values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcSettingsUserMappingValues 

func OidcSettingsUserMappingValues() []OidcSettingsUserMapping

OidcSettingsUserMappingValues returns every value the Jamf API accepts for OidcSettingsUserMapping, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OidcSettingsUsernameAttributeClaimMapping 

type OidcSettingsUsernameAttributeClaimMapping = string

OidcSettingsUsernameAttributeClaimMapping is the set of values accepted by OidcSettings.UsernameAttributeClaimMapping. 

const (
	OidcSettingsUsernameAttributeClaimMappingUsername OidcSettingsUsernameAttributeClaimMapping = "USERNAME"
	OidcSettingsUsernameAttributeClaimMappingEmail    OidcSettingsUsernameAttributeClaimMapping = "EMAIL"
)

OidcSettingsUsernameAttributeClaimMapping values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OidcSettingsUsernameAttributeClaimMappingValues 

func OidcSettingsUsernameAttributeClaimMappingValues() []OidcSettingsUsernameAttributeClaimMapping

OidcSettingsUsernameAttributeClaimMappingValues returns every value the Jamf API accepts for OidcSettingsUsernameAttributeClaimMapping, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OnboardingConfiguration 

type OnboardingConfiguration struct {
	Enabled         bool             `json:"enabled"`
	ID              *string          `json:"id,omitempty"`
	OnboardingItems []OnboardingItem `json:"onboardingItems"`
}

OnboardingConfiguration represents a onboarding configuration.

type OnboardingEligibleItem 

type OnboardingEligibleItem struct {
	ID               string `json:"id"`
	Name             string `json:"name"`
	ScopeDescription string `json:"scopeDescription"`
	SiteDescription  string `json:"siteDescription"`
}

OnboardingEligibleItem represents a onboarding eligible item.

type OnboardingEligibleItemsSearchResult 

type OnboardingEligibleItemsSearchResult struct {
	Results    []OnboardingEligibleItem `json:"results"`
	TotalCount int                      `json:"totalCount"`
}

OnboardingEligibleItemsSearchResult A list of onboarding eligible items.

type OnboardingItem 

type OnboardingItem struct {
	// The id of the Jamf Pro object that should be added to the onboarding workflow for end users. Use
	// this in conjunction with the selfServiceEntityType. For example, if the policy with id 132 should be
	// added to onboarding, then entityId should be 132 and selfServiceEntityType should be OS_X_POLICY.
	EntityID         string  `json:"entityId"`
	EntityName       *string `json:"entityName,omitempty"`
	ID               *string `json:"id,omitempty"`
	Priority         int     `json:"priority"`
	ScopeDescription *string `json:"scopeDescription,omitempty"`
	// Allowed values: see the OnboardingItemSelfServiceEntityType constants.
	SelfServiceEntityType string  `json:"selfServiceEntityType"`
	SiteDescription       *string `json:"siteDescription,omitempty"`
}

OnboardingItem represents a onboarding item.

type OnboardingItemSelfServiceEntityType 

type OnboardingItemSelfServiceEntityType = string

OnboardingItemSelfServiceEntityType is the set of values accepted by OnboardingItem.SelfServiceEntityType. 

const (
	OnboardingItemSelfServiceEntityTypeOsXPolicy        OnboardingItemSelfServiceEntityType = "OS_X_POLICY"
	OnboardingItemSelfServiceEntityTypeOsXConfigProfile OnboardingItemSelfServiceEntityType = "OS_X_CONFIG_PROFILE"
	OnboardingItemSelfServiceEntityTypeOsXMacApp        OnboardingItemSelfServiceEntityType = "OS_X_MAC_APP"
	OnboardingItemSelfServiceEntityTypeOsXAppInstaller  OnboardingItemSelfServiceEntityType = "OS_X_APP_INSTALLER"
	OnboardingItemSelfServiceEntityTypeOsXEbook         OnboardingItemSelfServiceEntityType = "OS_X_EBOOK"
	OnboardingItemSelfServiceEntityTypeOsXPatchPolicy   OnboardingItemSelfServiceEntityType = "OS_X_PATCH_POLICY"
	OnboardingItemSelfServiceEntityTypeUnknown          OnboardingItemSelfServiceEntityType = "UNKNOWN"
)

OnboardingItemSelfServiceEntityType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OnboardingItemSelfServiceEntityTypeValues 

func OnboardingItemSelfServiceEntityTypeValues() []OnboardingItemSelfServiceEntityType

OnboardingItemSelfServiceEntityTypeValues returns every value the Jamf API accepts for OnboardingItemSelfServiceEntityType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type OrganizationName 

type OrganizationName struct {
	// The Organization Name for Jamf Pro.
	OrganizationName string `json:"organizationName"`
}

OrganizationName represents a organization name.

type OriginalMediaSource 

type OriginalMediaSource struct {
	// Hash used to verify integrity of the source package.
	Hash string `json:"hash"`
	// Type of package integrity hash for source package.
	// Allowed values: see the OriginalMediaSourceHashType constants.
	HashType string `json:"hashType"`
	// Source URL for the app.
	URL string `json:"url"`
}

OriginalMediaSource represents a original media source.

type OriginalMediaSourceHashType 

type OriginalMediaSourceHashType = string

OriginalMediaSourceHashType is the set of values accepted by OriginalMediaSource.HashType. 

const (
	OriginalMediaSourceHashTypeMd5    OriginalMediaSourceHashType = "MD5"
	OriginalMediaSourceHashTypeSha256 OriginalMediaSourceHashType = "SHA256"
)

OriginalMediaSourceHashType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func OriginalMediaSourceHashTypeValues 

func OriginalMediaSourceHashTypeValues() []OriginalMediaSourceHashType

OriginalMediaSourceHashTypeValues returns every value the Jamf API accepts for OriginalMediaSourceHashType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type Package 

type Package struct {
	BasePath             *string `json:"basePath,omitempty"`
	CategoryID           string  `json:"categoryId"`
	CloudTransferStatus  *string `json:"cloudTransferStatus,omitempty"`
	FileName             string  `json:"fileName"`
	FillExistingUsers    *bool   `json:"fillExistingUsers,omitempty"`
	FillUserTemplate     bool    `json:"fillUserTemplate"`
	Format               *string `json:"format,omitempty"`
	HashType             *string `json:"hashType,omitempty"`
	HashValue            *string `json:"hashValue,omitempty"`
	ID                   *string `json:"id,omitempty"`
	IgnoreConflicts      *bool   `json:"ignoreConflicts,omitempty"`
	Indexed              *bool   `json:"indexed,omitempty"`
	Info                 *string `json:"info,omitempty"`
	InstallLanguage      *string `json:"installLanguage,omitempty"`
	Manifest             *string `json:"manifest,omitempty"`
	ManifestFileName     *string `json:"manifestFileName,omitempty"`
	Md5                  *string `json:"md5,omitempty"`
	Notes                *string `json:"notes,omitempty"`
	OsInstall            bool    `json:"osInstall"`
	OsInstallerVersion   *string `json:"osInstallerVersion,omitempty"`
	OsRequirements       *string `json:"osRequirements,omitempty"`
	PackageName          string  `json:"packageName"`
	ParentPackageID      *string `json:"parentPackageId,omitempty"`
	Priority             int     `json:"priority"`
	RebootRequired       bool    `json:"rebootRequired"`
	SelfHealNotify       *bool   `json:"selfHealNotify,omitempty"`
	SelfHealingAction    *string `json:"selfHealingAction,omitempty"`
	SerialNumber         *string `json:"serialNumber,omitempty"`
	Sha256               *string `json:"sha256,omitempty"`
	Sha3512              *string `json:"sha3512,omitempty"`
	Size                 *string `json:"size,omitempty"`
	SuppressEula         bool    `json:"suppressEula"`
	SuppressFromDock     bool    `json:"suppressFromDock"`
	SuppressRegistration bool    `json:"suppressRegistration"`
	SuppressUpdates      bool    `json:"suppressUpdates"`
	Swu                  *bool   `json:"swu,omitempty"`
}

Package represents a package.

type PackageManifest 

type PackageManifest struct {
	BundleID         string  `json:"bundleId"`
	BundleVersion    string  `json:"bundleVersion"`
	DisplayImageURL  *string `json:"displayImageUrl,omitempty"`
	FullSizeImageURL *string `json:"fullSizeImageUrl,omitempty"`
	Hash             string  `json:"hash"`
	// Allowed values: see the PackageManifestHashType constants.
	HashType    string  `json:"hashType"`
	SizeInBytes int     `json:"sizeInBytes"`
	Subtitle    *string `json:"subtitle,omitempty"`
	Title       string  `json:"title"`
	URL         string  `json:"url"`
}

PackageManifest represents a package manifest.

type PackageManifestHashType 

type PackageManifestHashType = string

PackageManifestHashType is the set of values accepted by PackageManifest.HashType. 

const (
	PackageManifestHashTypeMd5    PackageManifestHashType = "MD5"
	PackageManifestHashTypeSha256 PackageManifestHashType = "SHA256"
)

PackageManifestHashType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PackageManifestHashTypeValues 

func PackageManifestHashTypeValues() []PackageManifestHashType

PackageManifestHashTypeValues returns every value the Jamf API accepts for PackageManifestHashType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PackagesSearchResults 

type PackagesSearchResults struct {
	Results    []Package `json:"results"`
	TotalCount int       `json:"totalCount"`
}

PackagesSearchResults represents a packages search results.

type PagedUserResults 

type PagedUserResults struct {
	// True if there are more pages after the current page.
	HasNext bool `json:"hasNext"`
	// True if there are pages before the current page.
	HasPrevious bool `json:"hasPrevious"`
	// Current page number (zero-based).
	Page int `json:"page"`
	// Number of results per page.
	PageSize int `json:"pageSize"`
	// List of users in the current page.
	Results []User `json:"results"`
	// Total number of users matching the search criteria.
	TotalCount int64 `json:"totalCount"`
	// Total number of pages available.
	TotalPages int64 `json:"totalPages"`
}

PagedUserResults represents a paged user results.

type ParentApp 

type ParentApp struct {
	AllowClearPasscode            *bool                `json:"allowClearPasscode,omitempty"`
	AllowTemplates                *bool                `json:"allowTemplates,omitempty"`
	DeviceGroupID                 int                  `json:"deviceGroupId"`
	DisassociateOnWipeAndReEnroll *bool                `json:"disassociateOnWipeAndReEnroll,omitempty"`
	IsEnabled                     bool                 `json:"isEnabled"`
	RestrictedTimes               map[string]TimeFrame `json:"restrictedTimes"`
	SafelistedApps                *[]SafelistedApp     `json:"safelistedApps,omitempty"`
	TimezoneID                    string               `json:"timezoneId"`
}

ParentApp represents a parent app. `RestrictedTimes` is keyed by day of week, and the legal keys are `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY` and `SUNDAY`. The spec declares this as a `DayOfWeek` enum schema, but reaches it through a pseudo-property literally named `key` alongside `additionalProperties` — OpenAPI has no way to constrain a map's key type, so that construct is not a real property and no Go field ever carries the type. The enum is therefore never emitted as constants, making this godoc the only place the keys are documented. Sending an unrecognised key is silently dropped rather than rejected, as everywhere else in Pro.

type PatchPolicies 

type PatchPolicies struct {
	Results    []PatchPolicyListView `json:"results"`
	TotalCount int                   `json:"totalCount"`
}

PatchPolicies represents a patch policies.

type PatchPolicyDetail 

type PatchPolicyDetail struct {
	DeploymentMethod             string `json:"deploymentMethod"`
	Downgrade                    bool   `json:"downgrade"`
	Enabled                      bool   `json:"enabled"`
	IconID                       string `json:"iconId"`
	ID                           string `json:"id"`
	InstallButtonText            string `json:"installButtonText"`
	KillAppsDelayMinutes         int    `json:"killAppsDelayMinutes"`
	KillAppsMessage              string `json:"killAppsMessage"`
	Name                         string `json:"name"`
	NotificationHeader           string `json:"notificationHeader"`
	PatchUnknownVersion          bool   `json:"patchUnknownVersion"`
	ReminderEnabled              bool   `json:"reminderEnabled"`
	ReminderFrequency            int    `json:"reminderFrequency"`
	SelfServiceDeadline          int    `json:"selfServiceDeadline"`
	SelfServiceDescription       string `json:"selfServiceDescription"`
	SelfServiceEnforceDeadline   bool   `json:"selfServiceEnforceDeadline"`
	SoftwareTitleConfigurationID string `json:"softwareTitleConfigurationId"`
	SoftwareTitleID              string `json:"softwareTitleId"`
	TargetPatchVersion           string `json:"targetPatchVersion"`
}

PatchPolicyDetail represents a patch policy detail.

type PatchPolicyDetails 

type PatchPolicyDetails struct {
	Results    []PatchPolicyDetail `json:"results"`
	TotalCount int                 `json:"totalCount"`
}

PatchPolicyDetails represents a patch policy details.

type PatchPolicyListView 

type PatchPolicyListView struct {
	Completed                    int    `json:"completed"`
	Deferred                     int    `json:"deferred"`
	Failed                       int    `json:"failed"`
	ID                           string `json:"id"`
	Pending                      int    `json:"pending"`
	PolicyDeploymentMethod       string `json:"policyDeploymentMethod"`
	PolicyEnabled                bool   `json:"policyEnabled"`
	PolicyName                   string `json:"policyName"`
	PolicyTargetVersion          string `json:"policyTargetVersion"`
	SoftwareTitle                string `json:"softwareTitle"`
	SoftwareTitleConfigurationID string `json:"softwareTitleConfigurationId"`
}

PatchPolicyListView represents a patch policy list view.

type PatchPolicyLogDetail 

type PatchPolicyLogDetail struct {
	Actions       []PatchPolicyLogDetailAction `json:"actions"`
	AttemptNumber int                          `json:"attemptNumber"`
	DeviceID      string                       `json:"deviceId"`
	ID            string                       `json:"id"`
}

PatchPolicyLogDetail represents a patch policy log detail.

type PatchPolicyLogDetailAction 

type PatchPolicyLogDetailAction struct {
	Action      string `json:"action"`
	ActionOrder int    `json:"actionOrder"`
	ID          string `json:"id"`
}

PatchPolicyLogDetailAction represents a patch policy log detail action.

type PatchPolicyLogEligibleRetryCount 

type PatchPolicyLogEligibleRetryCount struct {
	Count int `json:"count"`
}

PatchPolicyLogEligibleRetryCount represents a patch policy log eligible retry count.

type PatchPolicyLogRetry 

type PatchPolicyLogRetry struct {
	DeviceIds *[]string `json:"deviceIds,omitempty"`
}

PatchPolicyLogRetry represents a patch policy log retry.

type PatchPolicyLogV2 

type PatchPolicyLogV2 struct {
	AttemptNumber           int        `json:"attemptNumber"`
	DeviceID                string     `json:"deviceId"`
	DeviceName              string     `json:"deviceName"`
	IgnoredForPatchPolicyID string     `json:"ignoredForPatchPolicyId"`
	PatchPolicyID           string     `json:"patchPolicyId"`
	StatusCode              int        `json:"statusCode"`
	StatusDate              *time.Time `json:"statusDate,omitempty"`
	// Allowed values: see the PatchPolicyLogV2StatusEnum constants.
	StatusEnum string `json:"statusEnum"`
}

PatchPolicyLogV2 represents a patch policy log v2.

type PatchPolicyLogV2StatusEnum 

type PatchPolicyLogV2StatusEnum = string

PatchPolicyLogV2StatusEnum is the set of values accepted by PatchPolicyLogV2.StatusEnum. 

const (
	PatchPolicyLogV2StatusEnumUnknown   PatchPolicyLogV2StatusEnum = "UNKNOWN"
	PatchPolicyLogV2StatusEnumPending   PatchPolicyLogV2StatusEnum = "PENDING"
	PatchPolicyLogV2StatusEnumCompleted PatchPolicyLogV2StatusEnum = "COMPLETED"
	PatchPolicyLogV2StatusEnumFailed    PatchPolicyLogV2StatusEnum = "FAILED"
)

PatchPolicyLogV2StatusEnum values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PatchPolicyLogV2StatusEnumValues 

func PatchPolicyLogV2StatusEnumValues() []PatchPolicyLogV2StatusEnum

PatchPolicyLogV2StatusEnumValues returns every value the Jamf API accepts for PatchPolicyLogV2StatusEnum, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PatchPolicyLogs 

type PatchPolicyLogs struct {
	Results    []PatchPolicyLogV2 `json:"results"`
	TotalCount int                `json:"totalCount"`
}

PatchPolicyLogs represents a patch policy logs.

type PatchPolicyV2OnDashboard 

type PatchPolicyV2OnDashboard struct {
	OnDashboard bool `json:"onDashboard"`
}

PatchPolicyV2OnDashboard represents a patch policy v2 on dashboard.

type PatchReportV3 

type PatchReportV3 struct {
	BuildingName           *string    `json:"buildingName,omitempty"`
	ComputerName           *string    `json:"computerName,omitempty"`
	DepartmentName         *string    `json:"departmentName,omitempty"`
	DeviceID               *string    `json:"deviceId,omitempty"`
	LastCheckIn            *time.Time `json:"lastCheckIn,omitempty"`
	OperatingSystemVersion *string    `json:"operatingSystemVersion,omitempty"`
	SiteName               *string    `json:"siteName,omitempty"`
	Username               *string    `json:"username,omitempty"`
	Version                *string    `json:"version,omitempty"`
}

PatchReportV3 represents a patch report v3.

type PatchSoftwareTitleConfiguration 

type PatchSoftwareTitleConfiguration struct {
	CategoryID             string                                               `json:"categoryId"`
	DisplayName            string                                               `json:"displayName"`
	EmailNotifications     bool                                                 `json:"emailNotifications"`
	ExtensionAttributes    []PatchSoftwareTitleConfigurationExtensionAttributes `json:"extensionAttributes"`
	ID                     string                                               `json:"id"`
	JamfOfficial           bool                                                 `json:"jamfOfficial"`
	Packages               []PatchSoftwareTitlePackages                         `json:"packages"`
	PatchSourceEnabled     bool                                                 `json:"patchSourceEnabled"`
	PatchSourceName        string                                               `json:"patchSourceName"`
	SiteID                 string                                               `json:"siteId"`
	SoftwareTitleID        string                                               `json:"softwareTitleId"`
	SoftwareTitleName      string                                               `json:"softwareTitleName"`
	SoftwareTitleNameID    string                                               `json:"softwareTitleNameId"`
	SoftwareTitlePublisher string                                               `json:"softwareTitlePublisher"`
	UiNotifications        bool                                                 `json:"uiNotifications"`
}

PatchSoftwareTitleConfiguration represents a patch software title configuration.

type PatchSoftwareTitleConfigurationBase 

type PatchSoftwareTitleConfigurationBase struct {
	CategoryID             *string                                               `json:"categoryId,omitempty"`
	DisplayName            string                                                `json:"displayName"`
	EmailNotifications     *bool                                                 `json:"emailNotifications,omitempty"`
	ExtensionAttributes    *[]PatchSoftwareTitleConfigurationExtensionAttributes `json:"extensionAttributes,omitempty"`
	JamfOfficial           *bool                                                 `json:"jamfOfficial,omitempty"`
	PatchSourceEnabled     *bool                                                 `json:"patchSourceEnabled,omitempty"`
	PatchSourceName        *string                                               `json:"patchSourceName,omitempty"`
	SiteID                 *string                                               `json:"siteId,omitempty"`
	SoftwareTitleID        string                                                `json:"softwareTitleId"`
	SoftwareTitleName      *string                                               `json:"softwareTitleName,omitempty"`
	SoftwareTitleNameID    *string                                               `json:"softwareTitleNameId,omitempty"`
	SoftwareTitlePublisher *string                                               `json:"softwareTitlePublisher,omitempty"`
	UiNotifications        *bool                                                 `json:"uiNotifications,omitempty"`
}

PatchSoftwareTitleConfigurationBase represents a patch software title configuration base.

type PatchSoftwareTitleConfigurationDefinitionKillApp 

type PatchSoftwareTitleConfigurationDefinitionKillApp struct {
	AppName string `json:"appName"`
}

PatchSoftwareTitleConfigurationDefinitionKillApp represents a patch software title configuration definition kill app.

type PatchSoftwareTitleConfigurationDependencies 

type PatchSoftwareTitleConfigurationDependencies struct {
	Results    []PatchSoftwareTitleConfigurationDependency `json:"results"`
	TotalCount int                                         `json:"totalCount"`
}

PatchSoftwareTitleConfigurationDependencies represents a patch software title configuration dependencies.

type PatchSoftwareTitleConfigurationDependency 

type PatchSoftwareTitleConfigurationDependency struct {
	SmartGroupID   string `json:"smartGroupId"`
	SmartGroupName string `json:"smartGroupName"`
}

PatchSoftwareTitleConfigurationDependency represents a patch software title configuration dependency.

type PatchSoftwareTitleConfigurationExtensionAttributes 

type PatchSoftwareTitleConfigurationExtensionAttributes struct {
	// Once an extension attribute is accepted, it cannot be reverted.
	Accepted *bool   `json:"accepted,omitempty"`
	EaID     *string `json:"eaId,omitempty"`
}

PatchSoftwareTitleConfigurationExtensionAttributes represents a patch software title configuration extension attributes.

type PatchSoftwareTitleConfigurationPatch 

type PatchSoftwareTitleConfigurationPatch struct {
	CategoryID          *string                                               `json:"categoryId,omitempty"`
	DisplayName         *string                                               `json:"displayName,omitempty"`
	EmailNotifications  *bool                                                 `json:"emailNotifications,omitempty"`
	ExtensionAttributes *[]PatchSoftwareTitleConfigurationExtensionAttributes `json:"extensionAttributes,omitempty"`
	Packages            *[]PatchSoftwareTitlePackages                         `json:"packages,omitempty"`
	SiteID              *string                                               `json:"siteId,omitempty"`
	SoftwareTitleID     *string                                               `json:"softwareTitleId,omitempty"`
	UiNotifications     *bool                                                 `json:"uiNotifications,omitempty"`
}

PatchSoftwareTitleConfigurationPatch represents a patch software title configuration patch.

type PatchSoftwareTitleDefinition 

type PatchSoftwareTitleDefinition struct {
	AbsoluteOrderID        string                                             `json:"absoluteOrderId"`
	KillApps               []PatchSoftwareTitleConfigurationDefinitionKillApp `json:"killApps"`
	MinimumOperatingSystem string                                             `json:"minimumOperatingSystem"`
	RebootRequired         bool                                               `json:"rebootRequired"`
	ReleaseDate            string                                             `json:"releaseDate"`
	Standalone             bool                                               `json:"standalone"`
	Version                string                                             `json:"version"`
}

PatchSoftwareTitleDefinition represents a patch software title definition.

type PatchSoftwareTitleDefinitions 

type PatchSoftwareTitleDefinitions struct {
	Results    []PatchSoftwareTitleDefinition `json:"results"`
	TotalCount int                            `json:"totalCount"`
}

PatchSoftwareTitleDefinitions represents a patch software title definitions.

type PatchSoftwareTitleExtensionAttributes 

type PatchSoftwareTitleExtensionAttributes struct {
	Accepted       bool   `json:"accepted"`
	DisplayName    string `json:"displayName"`
	EaID           string `json:"eaId"`
	ScriptContents string `json:"scriptContents"`
}

PatchSoftwareTitleExtensionAttributes represents a patch software title extension attributes.

type PatchSoftwareTitlePackages 

type PatchSoftwareTitlePackages struct {
	DisplayName *string `json:"displayName,omitempty"`
	PackageID   *string `json:"packageId,omitempty"`
	Version     *string `json:"version,omitempty"`
}

PatchSoftwareTitlePackages represents a patch software title packages.

type PatchSoftwareTitleReportV3SearchResult 

type PatchSoftwareTitleReportV3SearchResult struct {
	Results    []PatchReportV3 `json:"results"`
	TotalCount int             `json:"totalCount"`
}

PatchSoftwareTitleReportV3SearchResult represents a patch software title report v3 search result.

type PatchSummary 

type PatchSummary struct {
	LatestVersion                string     `json:"latestVersion"`
	OnDashboard                  bool       `json:"onDashboard"`
	OutOfDate                    int        `json:"outOfDate"`
	ReleaseDate                  *time.Time `json:"releaseDate,omitempty"`
	SoftwareTitleConfigurationID string     `json:"softwareTitleConfigurationId"`
	SoftwareTitleID              string     `json:"softwareTitleId"`
	Title                        string     `json:"title"`
	UpToDate                     int        `json:"upToDate"`
}

PatchSummary represents a patch summary.

type PatchSummaryVersion 

type PatchSummaryVersion struct {
	AbsoluteOrderID string `json:"absoluteOrderId"`
	OnVersion       int    `json:"onVersion"`
	Version         string `json:"version"`
}

PatchSummaryVersion represents a patch summary version.

type PlanConfigurationPost 

type PlanConfigurationPost struct {
	// Optional. Indicates the build version to update to. Only available when the version type is set to
	// custom version.
	BuildVersion *string `json:"buildVersion,omitempty"`
	// Optional. Indicates the local date and time of the device to force update by.
	ForceInstallLocalDateTime *string `json:"forceInstallLocalDateTime,omitempty"`
	// Required when the provided updateAction is DOWNLOAD_INSTALL_ALLOW_DEFERRAL, not applicable to all
	// managed software update plans.
	MaxDeferrals *int `json:"maxDeferrals,omitempty"`
	// Optional. Indicates the specific version to update to. Only available when the version type is set
	// to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.
	SpecificVersion *string `json:"specificVersion,omitempty"`
	// Allowed values: see the PlanConfigurationPostUpdateAction constants.
	UpdateAction string `json:"updateAction"`
	// Allowed values: see the PlanConfigurationPostVersionType constants.
	VersionType string `json:"versionType"`
}

PlanConfigurationPost represents a plan configuration post.

type PlanConfigurationPostUpdateAction 

type PlanConfigurationPostUpdateAction = string

PlanConfigurationPostUpdateAction is the set of values accepted by PlanConfigurationPost.UpdateAction. 

const (
	PlanConfigurationPostUpdateActionDownloadOnly                 PlanConfigurationPostUpdateAction = "DOWNLOAD_ONLY"
	PlanConfigurationPostUpdateActionDownloadInstall              PlanConfigurationPostUpdateAction = "DOWNLOAD_INSTALL"
	PlanConfigurationPostUpdateActionDownloadInstallAllowDeferral PlanConfigurationPostUpdateAction = "DOWNLOAD_INSTALL_ALLOW_DEFERRAL"
	PlanConfigurationPostUpdateActionDownloadInstallRestart       PlanConfigurationPostUpdateAction = "DOWNLOAD_INSTALL_RESTART"
	PlanConfigurationPostUpdateActionDownloadInstallSchedule      PlanConfigurationPostUpdateAction = "DOWNLOAD_INSTALL_SCHEDULE"
	PlanConfigurationPostUpdateActionUnknown                      PlanConfigurationPostUpdateAction = "UNKNOWN"
)

PlanConfigurationPostUpdateAction values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanConfigurationPostUpdateActionValues 

func PlanConfigurationPostUpdateActionValues() []PlanConfigurationPostUpdateAction

PlanConfigurationPostUpdateActionValues returns every value the Jamf API accepts for PlanConfigurationPostUpdateAction, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PlanConfigurationPostVersionType 

type PlanConfigurationPostVersionType = string

PlanConfigurationPostVersionType is the set of values accepted by PlanConfigurationPost.VersionType. 

const (
	PlanConfigurationPostVersionTypeLatestMajor     PlanConfigurationPostVersionType = "LATEST_MAJOR"
	PlanConfigurationPostVersionTypeLatestMinor     PlanConfigurationPostVersionType = "LATEST_MINOR"
	PlanConfigurationPostVersionTypeLatestAny       PlanConfigurationPostVersionType = "LATEST_ANY"
	PlanConfigurationPostVersionTypeSpecificVersion PlanConfigurationPostVersionType = "SPECIFIC_VERSION"
	PlanConfigurationPostVersionTypeCustomVersion   PlanConfigurationPostVersionType = "CUSTOM_VERSION"
	PlanConfigurationPostVersionTypeUnknown         PlanConfigurationPostVersionType = "UNKNOWN"
)

PlanConfigurationPostVersionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanConfigurationPostVersionTypeValues 

func PlanConfigurationPostVersionTypeValues() []PlanConfigurationPostVersionType

PlanConfigurationPostVersionTypeValues returns every value the Jamf API accepts for PlanConfigurationPostVersionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PlanDevice 

type PlanDevice struct {
	DeviceID string `json:"deviceId"`
	Href     string `json:"href"`
	// Allowed values: see the PlanDeviceObjectType constants.
	ObjectType string `json:"objectType"`
}

PlanDevice represents a plan device.

type PlanDeviceObjectType 

type PlanDeviceObjectType = string

PlanDeviceObjectType is the set of values accepted by PlanDevice.ObjectType. 

const (
	PlanDeviceObjectTypeComputer     PlanDeviceObjectType = "COMPUTER"
	PlanDeviceObjectTypeMobileDevice PlanDeviceObjectType = "MOBILE_DEVICE"
	PlanDeviceObjectTypeAppleTv      PlanDeviceObjectType = "APPLE_TV"
)

PlanDeviceObjectType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanDeviceObjectTypeValues 

func PlanDeviceObjectTypeValues() []PlanDeviceObjectType

PlanDeviceObjectTypeValues returns every value the Jamf API accepts for PlanDeviceObjectType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PlanDevicePost 

type PlanDevicePost struct {
	DeviceID string `json:"deviceId"`
	// Allowed values: see the PlanDevicePostObjectType constants.
	ObjectType string `json:"objectType"`
}

PlanDevicePost represents a plan device post.

type PlanDevicePostObjectType 

type PlanDevicePostObjectType = string

PlanDevicePostObjectType is the set of values accepted by PlanDevicePost.ObjectType. 

const (
	PlanDevicePostObjectTypeComputer     PlanDevicePostObjectType = "COMPUTER"
	PlanDevicePostObjectTypeMobileDevice PlanDevicePostObjectType = "MOBILE_DEVICE"
	PlanDevicePostObjectTypeAppleTv      PlanDevicePostObjectType = "APPLE_TV"
)

PlanDevicePostObjectType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanDevicePostObjectTypeValues 

func PlanDevicePostObjectTypeValues() []PlanDevicePostObjectType

PlanDevicePostObjectTypeValues returns every value the Jamf API accepts for PlanDevicePostObjectType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PlanDeviceResponse 

type PlanDeviceResponse struct {
	Device *PlanDevice `json:"device,omitempty"`
	Href   string      `json:"href"`
	PlanID string      `json:"planId"`
}

PlanDeviceResponse represents a plan device response.

type PlanGroupPost 

type PlanGroupPost struct {
	GroupID string `json:"groupId"`
	// Allowed values: see the PlanGroupPostObjectType constants.
	ObjectType string `json:"objectType"`
}

PlanGroupPost represents a plan group post.

type PlanGroupPostObjectType 

type PlanGroupPostObjectType = string

PlanGroupPostObjectType is the set of values accepted by PlanGroupPost.ObjectType. 

const (
	PlanGroupPostObjectTypeComputerGroup     PlanGroupPostObjectType = "COMPUTER_GROUP"
	PlanGroupPostObjectTypeMobileDeviceGroup PlanGroupPostObjectType = "MOBILE_DEVICE_GROUP"
)

PlanGroupPostObjectType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanGroupPostObjectTypeValues 

func PlanGroupPostObjectTypeValues() []PlanGroupPostObjectType

PlanGroupPostObjectTypeValues returns every value the Jamf API accepts for PlanGroupPostObjectType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PlanSearchResults 

type PlanSearchResults struct {
	Results    []JamfProtectPlan `json:"results"`
	TotalCount int               `json:"totalCount"`
}

PlanSearchResults represents a plan search results.

type PlanStatus 

type PlanStatus struct {
	// Allowed values: see the PlanStatusErrorReasons constants.
	ErrorReasons *[]string `json:"errorReasons,omitempty"`
	// Allowed values: see the PlanStatusState constants.
	State string `json:"state"`
}

PlanStatus represents a plan status.

type PlanStatusErrorReasons 

type PlanStatusErrorReasons = string

PlanStatusErrorReasons is the set of values accepted by PlanStatus.ErrorReasons. 

const (
	PlanStatusErrorReasonsAppleSiliconNoEscrowKey                                                  PlanStatusErrorReasons = "APPLE_SILICON_NO_ESCROW_KEY"
	PlanStatusErrorReasonsNotSupervised                                                            PlanStatusErrorReasons = "NOT_SUPERVISED"
	PlanStatusErrorReasonsNotManaged                                                               PlanStatusErrorReasons = "NOT_MANAGED"
	PlanStatusErrorReasonsNoDiskSpace                                                              PlanStatusErrorReasons = "NO_DISK_SPACE"
	PlanStatusErrorReasonsNoUpdatesAvailable                                                       PlanStatusErrorReasons = "NO_UPDATES_AVAILABLE"
	PlanStatusErrorReasonsSpecificVersionUnavailable                                               PlanStatusErrorReasons = "SPECIFIC_VERSION_UNAVAILABLE"
	PlanStatusErrorReasonsSpecificVersionUnavailableForDeviceModel                                 PlanStatusErrorReasons = "SPECIFIC_VERSION_UNAVAILABLE_FOR_DEVICE_MODEL"
	PlanStatusErrorReasonsActionNotSupportedForDeviceType                                          PlanStatusErrorReasons = "ACTION_NOT_SUPPORTED_FOR_DEVICE_TYPE"
	PlanStatusErrorReasonsDeclarativeDeviceManagementSoftwareUpdatesNotSupportedForDeviceOsVersion PlanStatusErrorReasons = "DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_OS_VERSION"
	PlanStatusErrorReasonsDeclarativeDeviceManagementSoftwareUpdatesNotSupportedForDeviceType      PlanStatusErrorReasons = "DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_TYPE"
	PlanStatusErrorReasonsPlanNotFound                                                             PlanStatusErrorReasons = "PLAN_NOT_FOUND"
	PlanStatusErrorReasonsAppleSoftwareLookupServiceError                                          PlanStatusErrorReasons = "APPLE_SOFTWARE_LOOKUP_SERVICE_ERROR"
	PlanStatusErrorReasonsExistingPlanForDeviceInProgress                                          PlanStatusErrorReasons = "EXISTING_PLAN_FOR_DEVICE_IN_PROGRESS"
	PlanStatusErrorReasonsDowngradeNotSupported                                                    PlanStatusErrorReasons = "DOWNGRADE_NOT_SUPPORTED"
	PlanStatusErrorReasonsDeclarativeServiceError                                                  PlanStatusErrorReasons = "DECLARATIVE_SERVICE_ERROR"
	PlanStatusErrorReasonsUnableToFindUpdatesAndOutOfRetries                                       PlanStatusErrorReasons = "UNABLE_TO_FIND_UPDATES_AND_OUT_OF_RETRIES"
	PlanStatusErrorReasonsDataIntegrityViolationException                                          PlanStatusErrorReasons = "DATA_INTEGRITY_VIOLATION_EXCEPTION"
	PlanStatusErrorReasonsIllegalArgumentException                                                 PlanStatusErrorReasons = "ILLEGAL_ARGUMENT_EXCEPTION"
	PlanStatusErrorReasonsMDMException                                                             PlanStatusErrorReasons = "MDM_EXCEPTION"
	PlanStatusErrorReasonsInstallReasonUnknown                                                     PlanStatusErrorReasons = "INSTALL_REASON_UNKNOWN"
	PlanStatusErrorReasonsAcceptPlanFailure                                                        PlanStatusErrorReasons = "ACCEPT_PLAN_FAILURE"
	PlanStatusErrorReasonsSchedulePlanFailure                                                      PlanStatusErrorReasons = "SCHEDULE_PLAN_FAILURE"
	PlanStatusErrorReasonsRejectPlanFailure                                                        PlanStatusErrorReasons = "REJECT_PLAN_FAILURE"
	PlanStatusErrorReasonsStartPlanFailure                                                         PlanStatusErrorReasons = "START_PLAN_FAILURE"
	PlanStatusErrorReasonsQueueScheduledOsUpdateScanFailure                                        PlanStatusErrorReasons = "QUEUE_SCHEDULED_OS_UPDATE_SCAN_FAILURE"
	PlanStatusErrorReasonsScanWaitFinishedFailure                                                  PlanStatusErrorReasons = "SCAN_WAIT_FINISHED_FAILURE"
	PlanStatusErrorReasonsQueueAvailableOsUpdateCommandFailure                                     PlanStatusErrorReasons = "QUEUE_AVAILABLE_OS_UPDATE_COMMAND_FAILURE"
	PlanStatusErrorReasonsMDMClientException                                                       PlanStatusErrorReasons = "MDM_CLIENT_EXCEPTION"
	PlanStatusErrorReasonsQueueScheduleOsUpdateFailure                                             PlanStatusErrorReasons = "QUEUE_SCHEDULE_OS_UPDATE_FAILURE"
	PlanStatusErrorReasonsQueueOsUpdateStatusCommandFailure                                        PlanStatusErrorReasons = "QUEUE_OS_UPDATE_STATUS_COMMAND_FAILURE"
	PlanStatusErrorReasonsStillInProgressFailure                                                   PlanStatusErrorReasons = "STILL_IN_PROGRESS_FAILURE"
	PlanStatusErrorReasonsWaitToCollectOsUpdateStatusFailure                                       PlanStatusErrorReasons = "WAIT_TO_COLLECT_OS_UPDATE_STATUS_FAILURE"
	PlanStatusErrorReasonsIsDownloadedAndNeedsInstallFailure                                       PlanStatusErrorReasons = "IS_DOWNLOADED_AND_NEEDS_INSTALL_FAILURE"
	PlanStatusErrorReasonsIsInstalledFailure                                                       PlanStatusErrorReasons = "IS_INSTALLED_FAILURE"
	PlanStatusErrorReasonsIsDownloadOnlyAndDownloadedFailure                                       PlanStatusErrorReasons = "IS_DOWNLOAD_ONLY_AND_DOWNLOADED_FAILURE"
	PlanStatusErrorReasonsVerifyInstallationFailure                                                PlanStatusErrorReasons = "VERIFY_INSTALLATION_FAILURE"
	PlanStatusErrorReasonsIsMacOsUpdateFailure                                                     PlanStatusErrorReasons = "IS_MAC_OS_UPDATE_FAILURE"
	PlanStatusErrorReasonsIsLatestFailure                                                          PlanStatusErrorReasons = "IS_LATEST_FAILURE"
	PlanStatusErrorReasonsIsSpecificVersionFailure                                                 PlanStatusErrorReasons = "IS_SPECIFIC_VERSION_FAILURE"
	PlanStatusErrorReasonsHandleCommandQueueFailure                                                PlanStatusErrorReasons = "HANDLE_COMMAND_QUEUE_FAILURE"
	PlanStatusErrorReasonsInvalidConfigurationDeclaration                                          PlanStatusErrorReasons = "INVALID_CONFIGURATION_DECLARATION"
	PlanStatusErrorReasonsDeclarativeDeviceManagementStatusResponseFailureReasonReceived           PlanStatusErrorReasons = "DECLARATIVE_DEVICE_MANAGEMENT_STATUS_RESPONSE_FAILURE_REASON_RECEIVED"
	PlanStatusErrorReasonsNoDeviceStatusByGracePeriod                                              PlanStatusErrorReasons = "NO_DEVICE_STATUS_BY_GRACE_PERIOD"
	PlanStatusErrorReasonsUnknown                                                                  PlanStatusErrorReasons = "UNKNOWN"
)

PlanStatusErrorReasons values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanStatusErrorReasonsValues 

func PlanStatusErrorReasonsValues() []PlanStatusErrorReasons

PlanStatusErrorReasonsValues returns every value the Jamf API accepts for PlanStatusErrorReasons, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PlanStatusState 

type PlanStatusState = string

PlanStatusState is the set of values accepted by PlanStatus.State. 

const (
	PlanStatusStateInit                                      PlanStatusState = "Init"
	PlanStatusStatePendingPlanValidation                     PlanStatusState = "PendingPlanValidation"
	PlanStatusStateAcceptingPlan                             PlanStatusState = "AcceptingPlan"
	PlanStatusStateRejectingPlan                             PlanStatusState = "RejectingPlan"
	PlanStatusStateProcessingPlanType                        PlanStatusState = "ProcessingPlanType"
	PlanStatusStateProcessingPlanTypeMDM                     PlanStatusState = "ProcessingPlanTypeMdm"
	PlanStatusStateStartingPlan                              PlanStatusState = "StartingPlan"
	PlanStatusStatePlanFailed                                PlanStatusState = "PlanFailed"
	PlanStatusStateSchedulingScanForOSUpdates                PlanStatusState = "SchedulingScanForOSUpdates"
	PlanStatusStateProcessingScheduleOSUpdateScanResponse    PlanStatusState = "ProcessingScheduleOSUpdateScanResponse"
	PlanStatusStateWaitingForScheduledOSUpdateScanToComplete PlanStatusState = "WaitingForScheduledOSUpdateScanToComplete"
	PlanStatusStateCollectingAvailableOSUpdates              PlanStatusState = "CollectingAvailableOSUpdates"
	PlanStatusStateProcessingAvailableOSUpdatesResponse      PlanStatusState = "ProcessingAvailableOSUpdatesResponse"
	PlanStatusStateProcessingSchedulingType                  PlanStatusState = "ProcessingSchedulingType"
	PlanStatusStateSchedulingDDM                             PlanStatusState = "SchedulingDDM"
	PlanStatusStateDDMPlanScheduled                          PlanStatusState = "DDMPlanScheduled"
	PlanStatusStateWaitingToStartDDMUpdate                   PlanStatusState = "WaitingToStartDDMUpdate"
	PlanStatusStateProcessingDDMStatusResponse               PlanStatusState = "ProcessingDDMStatusResponse"
	PlanStatusStateCollectingDDMStatus                       PlanStatusState = "CollectingDDMStatus"
	PlanStatusStateSchedulingMDM                             PlanStatusState = "SchedulingMDM"
	PlanStatusStateMDMPlanScheduled                          PlanStatusState = "MDMPlanScheduled"
	PlanStatusStateSchedulingOSUpdate                        PlanStatusState = "SchedulingOSUpdate"
	PlanStatusStateProcessingScheduleOSUpdateResponse        PlanStatusState = "ProcessingScheduleOSUpdateResponse"
	PlanStatusStateCollectingOSUpdateStatus                  PlanStatusState = "CollectingOSUpdateStatus"
	PlanStatusStateProcessingOSUpdateStatusResponse          PlanStatusState = "ProcessingOSUpdateStatusResponse"
	PlanStatusStateWaitingToCollectOSUpdateStatus            PlanStatusState = "WaitingToCollectOSUpdateStatus"
	PlanStatusStateVerifyingInstallation                     PlanStatusState = "VerifyingInstallation"
	PlanStatusStateProcessingInstallationVerification        PlanStatusState = "ProcessingInstallationVerification"
	PlanStatusStatePlanCompleted                             PlanStatusState = "PlanCompleted"
	PlanStatusStatePlanCanceled                              PlanStatusState = "PlanCanceled"
	PlanStatusStatePlanException                             PlanStatusState = "PlanException"
	PlanStatusStateUnknown                                   PlanStatusState = "Unknown"
)

PlanStatusState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PlanStatusStateValues 

func PlanStatusStateValues() []PlanStatusState

PlanStatusStateValues returns every value the Jamf API accepts for PlanStatusState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PolicyPropertiesV1 

type PolicyPropertiesV1 struct {
	AllowNetworkStateChangeTriggers *bool `json:"allowNetworkStateChangeTriggers,omitempty"`
	// This field always returns false.
	PoliciesRequireNetworkStateChange *bool `json:"policiesRequireNetworkStateChange,omitempty"`
}

PolicyPropertiesV1 represents a policy properties v1.

type PostComputerPrestageV3 

type PostComputerPrestageV3 struct {
	AccountSettings *AccountSettingsRequest `json:"accountSettings,omitempty"`
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                *[]string             `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt              string                `json:"authenticationPrompt"`
	AutoAdvanceSetup                  bool                  `json:"autoAdvanceSetup"`
	CustomPackageDistributionPointID  string                `json:"customPackageDistributionPointId"`
	CustomPackageIds                  []string              `json:"customPackageIds"`
	DefaultPrestage                   bool                  `json:"defaultPrestage"`
	Department                        string                `json:"department"`
	DeviceEnrollmentProgramInstanceID string                `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                       string                `json:"displayName"`
	EnableDeviceBasedActivationLock   bool                  `json:"enableDeviceBasedActivationLock"`
	EnableRecoveryLock                *bool                 `json:"enableRecoveryLock,omitempty"`
	EnrollmentCustomizationID         *string               `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                  string                `json:"enrollmentSiteId"`
	InstallProfilesDuringSetup        bool                  `json:"installProfilesDuringSetup"`
	KeepExistingLocationInformation   bool                  `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership        bool                  `json:"keepExistingSiteMembership"`
	Language                          *string               `json:"language,omitempty"`
	LocationInformation               LocationInformationV2 `json:"locationInformation"`
	Mandatory                         bool                  `json:"mandatory"`
	// The URL to the manifest file for the Platform SSO (PSSO) application Identity first workflow. This
	// URL is used when deploying the PSSO app to devices during the setup process.
	ManifestURL              *string `json:"manifestUrl,omitempty"`
	MDMRemovable             bool    `json:"mdmRemovable"`
	MinimumOsSpecificVersion *string `json:"minimumOsSpecificVersion,omitempty"`
	// The bundle identifier for the Platform SSO (PSSO) application Device first workflow. This identifier
	// is used to specify which PSSO app should be deployed to devices during the setup process.
	PlatformSsoAppBundleID      *string  `json:"platformSsoAppBundleId,omitempty"`
	PrestageInstalledProfileIds []string `json:"prestageInstalledProfileIds"`
	// Allowed values: see the PostComputerPrestageV3PrestageMinimumOsTargetVersionType constants.
	PrestageMinimumOsTargetVersionType *string `json:"prestageMinimumOsTargetVersionType,omitempty"`
	PreventActivationLock              bool    `json:"preventActivationLock"`
	// The URL to the configuration profile for the Platform SSO (PSSO) application Identity first
	// workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users
	// should use either profileUrl or populate pssoConfigProfileId, but not both.
	ProfileURL *string `json:"profileUrl,omitempty"`
	// The identifier for the configuration profile associated with the Platform SSO (PSSO) application
	// Identity first workflow. This ID is used to specify which configuration profile should be applied to
	// devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId
	// or populate profileUrl, but not both.
	PssoConfigProfileID *string `json:"pssoConfigProfileId,omitempty"`
	// Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of Device
	// first or Identity first workflows. When enabled, the PSSO application will be deployed to devices
	// during the setup process to facilitate single sign-on (SSO) for users.
	PssoEnabled           *bool                           `json:"pssoEnabled,omitempty"`
	PurchasingInformation PrestagePurchasingInformationV2 `json:"purchasingInformation"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	RecoveryLockPassword *string `json:"recoveryLockPassword,omitempty"`
	// Allowed values: see the PostComputerPrestageV3RecoveryLockPasswordType constants.
	RecoveryLockPasswordType   *string          `json:"recoveryLockPasswordType,omitempty"`
	Region                     *string          `json:"region,omitempty"`
	RequireAuthentication      bool             `json:"requireAuthentication"`
	RotateRecoveryLockPassword *bool            `json:"rotateRecoveryLockPassword,omitempty"`
	SkipSetupItems             *map[string]bool `json:"skipSetupItems,omitempty"`
	SupportEmailAddress        string           `json:"supportEmailAddress"`
	SupportPhoneNumber         string           `json:"supportPhoneNumber"`
}

PostComputerPrestageV3 represents a post computer prestage v3.

type PostComputerPrestageV3PrestageMinimumOsTargetVersionType 

type PostComputerPrestageV3PrestageMinimumOsTargetVersionType = string

PostComputerPrestageV3PrestageMinimumOsTargetVersionType is the set of values accepted by PostComputerPrestageV3.PrestageMinimumOsTargetVersionType. 

const (
	PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeNoEnforcement               PostComputerPrestageV3PrestageMinimumOsTargetVersionType = "NO_ENFORCEMENT"
	PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestVersion      PostComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_VERSION"
	PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMajorVersion PostComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMinorVersion PostComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MINOR_VERSION"
	PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsSpecificVersion    PostComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_SPECIFIC_VERSION"
)

PostComputerPrestageV3PrestageMinimumOsTargetVersionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues 

func PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues() []PostComputerPrestageV3PrestageMinimumOsTargetVersionType

PostComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues returns every value the Jamf API accepts for PostComputerPrestageV3PrestageMinimumOsTargetVersionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PostComputerPrestageV3RecoveryLockPasswordType 

type PostComputerPrestageV3RecoveryLockPasswordType = string

PostComputerPrestageV3RecoveryLockPasswordType is the set of values accepted by PostComputerPrestageV3.RecoveryLockPasswordType. 

const (
	PostComputerPrestageV3RecoveryLockPasswordTypeManual PostComputerPrestageV3RecoveryLockPasswordType = "MANUAL"
	PostComputerPrestageV3RecoveryLockPasswordTypeRandom PostComputerPrestageV3RecoveryLockPasswordType = "RANDOM"
)

PostComputerPrestageV3RecoveryLockPasswordType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PostComputerPrestageV3RecoveryLockPasswordTypeValues 

func PostComputerPrestageV3RecoveryLockPasswordTypeValues() []PostComputerPrestageV3RecoveryLockPasswordType

PostComputerPrestageV3RecoveryLockPasswordTypeValues returns every value the Jamf API accepts for PostComputerPrestageV3RecoveryLockPasswordType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PrestageDependencies 

type PrestageDependencies struct {
	Dependencies []PrestageDependency `json:"dependencies"`
}

PrestageDependencies represents a prestage dependencies.

type PrestageDependency 

type PrestageDependency struct {
	HumanReadableName string `json:"humanReadableName"`
	Hyperlink         string `json:"hyperlink"`
	Name              string `json:"name"`
}

PrestageDependency represents a prestage dependency.

type PrestageFileAttachmentV3 

type PrestageFileAttachmentV3 struct {
	FileType string `json:"fileType"`
	ID       string `json:"id"`
	Name     string `json:"name"`
}

PrestageFileAttachmentV3 represents a prestage file attachment v3.

type PrestagePurchasingInformationV2 

type PrestagePurchasingInformationV2 struct {
	AppleCareID       string `json:"appleCareId"`
	ID                string `json:"id"`
	LeaseDate         string `json:"leaseDate"`
	Leased            bool   `json:"leased"`
	LifeExpectancy    int    `json:"lifeExpectancy"`
	PoDate            string `json:"poDate"`
	PoNumber          string `json:"poNumber"`
	PurchasePrice     string `json:"purchasePrice"`
	Purchased         bool   `json:"purchased"`
	PurchasingAccount string `json:"purchasingAccount"`
	PurchasingContact string `json:"purchasingContact"`
	Vendor            string `json:"vendor"`
	VersionLock       int    `json:"versionLock"`
	WarrantyDate      string `json:"warrantyDate"`
}

PrestagePurchasingInformationV2 represents a prestage purchasing information v2.

type PrestagePurchasingInformationV3 

type PrestagePurchasingInformationV3 struct {
	AppleCareID       string `json:"appleCareId"`
	ID                string `json:"id"`
	LeaseDate         string `json:"leaseDate"`
	Leased            bool   `json:"leased"`
	LifeExpectancy    int    `json:"lifeExpectancy"`
	PoDate            string `json:"poDate"`
	PoNumber          string `json:"poNumber"`
	PurchasePrice     string `json:"purchasePrice"`
	Purchased         bool   `json:"purchased"`
	PurchasingAccount string `json:"purchasingAccount"`
	PurchasingContact string `json:"purchasingContact"`
	Vendor            string `json:"vendor"`
	VersionLock       int    `json:"versionLock"`
	WarrantyDate      string `json:"warrantyDate"`
}

PrestagePurchasingInformationV3 represents a prestage purchasing information v3.

type PrestageScopeAssignmentV2 

type PrestageScopeAssignmentV2 struct {
	AssignmentDate *string `json:"assignmentDate"`
	SerialNumber   string  `json:"serialNumber"`
	UserAssigned   string  `json:"userAssigned"`
}

PrestageScopeAssignmentV2 represents a prestage scope assignment v2.

type PrestageScopeResponseV2 

type PrestageScopeResponseV2 struct {
	Assignments []PrestageScopeAssignmentV2 `json:"assignments"`
	PrestageID  string                      `json:"prestageId"`
	VersionLock int                         `json:"versionLock"`
}

PrestageScopeResponseV2 represents a prestage scope response v2.

type PrestageScopeUpdate 

type PrestageScopeUpdate struct {
	SerialNumbers []string `json:"serialNumbers"`
	VersionLock   int      `json:"versionLock"`
}

PrestageScopeUpdate represents a prestage scope update.

type PrestageScopeV2 

type PrestageScopeV2 struct {
	SerialsByPrestageID map[string]string `json:"serialsByPrestageId"`
}

PrestageScopeV2 represents a prestage scope v2.

type PrestageSyncStatusV2 

type PrestageSyncStatusV2 struct {
	PrestageID string `json:"prestageId"`
	SyncState  string `json:"syncState"`
	Timestamp  string `json:"timestamp"`
}

PrestageSyncStatusV2 represents a prestage sync status v2.

type ProcessTextsSearchResults 

type ProcessTextsSearchResults struct {
	Results    []EnrollmentProcessTextObject `json:"results"`
	TotalCount int                           `json:"totalCount"`
}

ProcessTextsSearchResults represents a process texts search results.

type ProtectRegistrationRequest 

type ProtectRegistrationRequest struct {
	ClientID string `json:"clientId"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password   string `json:"password"`
	ProtectURL string `json:"protectUrl"`
}

ProtectRegistrationRequest Create an API Client in the Jamf Protect web console to obtain these values.

type ProtectSettingsResponse 

type ProtectSettingsResponse struct {
	ApiClientID string `json:"apiClientId"`
	// display name used when creating the API Client in the Jamf Protect web console.
	ApiClientName string `json:"apiClientName"`
	// determines whether the Jamf Protect agent will be automatically installed on client computers.
	AutoInstall  bool   `json:"autoInstall"`
	ID           string `json:"id"`
	LastSyncTime string `json:"lastSyncTime"`
	// determines whether Protect Platform Plan syncing is enabled.
	PlatformPlanSync bool   `json:"platformPlanSync"`
	ProtectURL       string `json:"protectUrl"`
	// ID used when making requests to identify this particular Protect registration.
	RegistrationID string `json:"registrationId"`
	// Allowed values: see the ProtectSettingsResponseSyncStatus constants.
	SyncStatus string `json:"syncStatus"`
}

ProtectSettingsResponse represents a protect settings response.

type ProtectSettingsResponseSyncStatus 

type ProtectSettingsResponseSyncStatus = string

ProtectSettingsResponseSyncStatus is the set of values accepted by ProtectSettingsResponse.SyncStatus. 

const (
	ProtectSettingsResponseSyncStatusInProgress ProtectSettingsResponseSyncStatus = "IN_PROGRESS"
	ProtectSettingsResponseSyncStatusCompleted  ProtectSettingsResponseSyncStatus = "COMPLETED"
	ProtectSettingsResponseSyncStatusError      ProtectSettingsResponseSyncStatus = "ERROR"
	ProtectSettingsResponseSyncStatusUnknown    ProtectSettingsResponseSyncStatus = "UNKNOWN"
)

ProtectSettingsResponseSyncStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ProtectSettingsResponseSyncStatusValues 

func ProtectSettingsResponseSyncStatusValues() []ProtectSettingsResponseSyncStatus

ProtectSettingsResponseSyncStatusValues returns every value the Jamf API accepts for ProtectSettingsResponseSyncStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ProtectUpdatableSettingsRequest 

type ProtectUpdatableSettingsRequest struct {
	// determines whether the Jamf Protect agent will be automatically installed on client computers.
	AutoInstall *bool `json:"autoInstall,omitempty"`
}

ProtectUpdatableSettingsRequest represents a protect updatable settings request.

type PurchasingV2 

type PurchasingV2 struct {
	AppleCareID         *string    `json:"appleCareId,omitempty"`
	LeaseExpiresDate    *time.Time `json:"leaseExpiresDate,omitempty"`
	Leased              *bool      `json:"leased,omitempty"`
	LifeExpectancy      *int       `json:"lifeExpectancy,omitempty"`
	PoDate              *time.Time `json:"poDate,omitempty"`
	PoNumber            *string    `json:"poNumber,omitempty"`
	PurchasePrice       *string    `json:"purchasePrice,omitempty"`
	Purchased           *bool      `json:"purchased,omitempty"`
	PurchasingAccount   *string    `json:"purchasingAccount,omitempty"`
	PurchasingContact   *string    `json:"purchasingContact,omitempty"`
	Vendor              *string    `json:"vendor,omitempty"`
	WarrantyExpiresDate *time.Time `json:"warrantyExpiresDate,omitempty"`
}

PurchasingV2 represents a purchasing v2.

type PutComputerPrestageV3 

type PutComputerPrestageV3 struct {
	AccountSettings *AccountSettingsRequest `json:"accountSettings,omitempty"`
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                *[]string             `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt              string                `json:"authenticationPrompt"`
	AutoAdvanceSetup                  bool                  `json:"autoAdvanceSetup"`
	CustomPackageDistributionPointID  string                `json:"customPackageDistributionPointId"`
	CustomPackageIds                  []string              `json:"customPackageIds"`
	DefaultPrestage                   bool                  `json:"defaultPrestage"`
	Department                        string                `json:"department"`
	DeviceEnrollmentProgramInstanceID string                `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                       string                `json:"displayName"`
	EnableDeviceBasedActivationLock   bool                  `json:"enableDeviceBasedActivationLock"`
	EnableRecoveryLock                *bool                 `json:"enableRecoveryLock,omitempty"`
	EnrollmentCustomizationID         *string               `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                  string                `json:"enrollmentSiteId"`
	InstallProfilesDuringSetup        bool                  `json:"installProfilesDuringSetup"`
	KeepExistingLocationInformation   bool                  `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership        bool                  `json:"keepExistingSiteMembership"`
	Language                          *string               `json:"language,omitempty"`
	LocationInformation               LocationInformationV2 `json:"locationInformation"`
	Mandatory                         bool                  `json:"mandatory"`
	// The URL to the manifest file for the Platform SSO (PSSO) application Identity first workflow. This
	// URL is used when deploying the PSSO app to devices during the setup process.
	ManifestURL              *string `json:"manifestUrl,omitempty"`
	MDMRemovable             bool    `json:"mdmRemovable"`
	MinimumOsSpecificVersion *string `json:"minimumOsSpecificVersion,omitempty"`
	// The bundle identifier for the Platform SSO (PSSO) application Device first workflow. This identifier
	// is used to specify which PSSO app should be deployed to devices during the setup process.
	PlatformSsoAppBundleID      *string  `json:"platformSsoAppBundleId,omitempty"`
	PrestageInstalledProfileIds []string `json:"prestageInstalledProfileIds"`
	// Allowed values: see the PutComputerPrestageV3PrestageMinimumOsTargetVersionType constants.
	PrestageMinimumOsTargetVersionType *string `json:"prestageMinimumOsTargetVersionType,omitempty"`
	PreventActivationLock              bool    `json:"preventActivationLock"`
	// The URL to the configuration profile for the Platform SSO (PSSO) application Identity first
	// workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users
	// should use either profileUrl or populate pssoConfigProfileId, but not both.
	ProfileURL *string `json:"profileUrl,omitempty"`
	// The identifier for the configuration profile associated with the Platform SSO (PSSO) application
	// Identity first workflow. This ID is used to specify which configuration profile should be applied to
	// devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId
	// or populate profileUrl, but not both.
	PssoConfigProfileID *string `json:"pssoConfigProfileId,omitempty"`
	// Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of Device
	// first or Identity first workflows. When enabled, the PSSO application will be deployed to devices
	// during the setup process to facilitate single sign-on (SSO) for users.
	PssoEnabled           *bool                           `json:"pssoEnabled,omitempty"`
	PurchasingInformation PrestagePurchasingInformationV2 `json:"purchasingInformation"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	RecoveryLockPassword *string `json:"recoveryLockPassword,omitempty"`
	// Allowed values: see the PutComputerPrestageV3RecoveryLockPasswordType constants.
	RecoveryLockPasswordType   *string          `json:"recoveryLockPasswordType,omitempty"`
	Region                     *string          `json:"region,omitempty"`
	RequireAuthentication      bool             `json:"requireAuthentication"`
	RotateRecoveryLockPassword *bool            `json:"rotateRecoveryLockPassword,omitempty"`
	SkipSetupItems             *map[string]bool `json:"skipSetupItems,omitempty"`
	SupportEmailAddress        string           `json:"supportEmailAddress"`
	SupportPhoneNumber         string           `json:"supportPhoneNumber"`
	VersionLock                *int             `json:"versionLock,omitempty"`
}

PutComputerPrestageV3 represents a put computer prestage v3.

type PutComputerPrestageV3PrestageMinimumOsTargetVersionType 

type PutComputerPrestageV3PrestageMinimumOsTargetVersionType = string

PutComputerPrestageV3PrestageMinimumOsTargetVersionType is the set of values accepted by PutComputerPrestageV3.PrestageMinimumOsTargetVersionType. 

const (
	PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeNoEnforcement               PutComputerPrestageV3PrestageMinimumOsTargetVersionType = "NO_ENFORCEMENT"
	PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestVersion      PutComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_VERSION"
	PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMajorVersion PutComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsLatestMinorVersion PutComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_LATEST_MINOR_VERSION"
	PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeMinimumOsSpecificVersion    PutComputerPrestageV3PrestageMinimumOsTargetVersionType = "MINIMUM_OS_SPECIFIC_VERSION"
)

PutComputerPrestageV3PrestageMinimumOsTargetVersionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues 

func PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues() []PutComputerPrestageV3PrestageMinimumOsTargetVersionType

PutComputerPrestageV3PrestageMinimumOsTargetVersionTypeValues returns every value the Jamf API accepts for PutComputerPrestageV3PrestageMinimumOsTargetVersionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PutComputerPrestageV3RecoveryLockPasswordType 

type PutComputerPrestageV3RecoveryLockPasswordType = string

PutComputerPrestageV3RecoveryLockPasswordType is the set of values accepted by PutComputerPrestageV3.RecoveryLockPasswordType. 

const (
	PutComputerPrestageV3RecoveryLockPasswordTypeManual PutComputerPrestageV3RecoveryLockPasswordType = "MANUAL"
	PutComputerPrestageV3RecoveryLockPasswordTypeRandom PutComputerPrestageV3RecoveryLockPasswordType = "RANDOM"
)

PutComputerPrestageV3RecoveryLockPasswordType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PutComputerPrestageV3RecoveryLockPasswordTypeValues 

func PutComputerPrestageV3RecoveryLockPasswordTypeValues() []PutComputerPrestageV3RecoveryLockPasswordType

PutComputerPrestageV3RecoveryLockPasswordTypeValues returns every value the Jamf API accepts for PutComputerPrestageV3RecoveryLockPasswordType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PutMobileDevicePrestageV3 

type PutMobileDevicePrestageV3 struct {
	AllowPairing bool `json:"allowPairing"`
	// The Base64 encoded PEM Certificate.
	AnchorCertificates                  *[]string `json:"anchorCertificates,omitempty"`
	AuthenticationPrompt                string    `json:"authenticationPrompt"`
	AutoAdvanceSetup                    bool      `json:"autoAdvanceSetup"`
	ConfigureDeviceBeforeSetupAssistant bool      `json:"configureDeviceBeforeSetupAssistant"`
	DefaultPrestage                     bool      `json:"defaultPrestage"`
	Department                          string    `json:"department"`
	DeviceEnrollmentProgramInstanceID   string    `json:"deviceEnrollmentProgramInstanceId"`
	DisplayName                         string    `json:"displayName"`
	// If true, the device does not use the profile when it restores a backup. Default is false. Available
	// in iOS 26 and later, and visionOS 26 and later; otherwise ignored by devices.
	DoNotUseProfileFromBackup       *bool   `json:"doNotUseProfileFromBackup,omitempty"`
	EnableDeviceBasedActivationLock bool    `json:"enableDeviceBasedActivationLock"`
	EnforceTemporarySessionTimeout  *bool   `json:"enforceTemporarySessionTimeout,omitempty"`
	EnforceUserSessionTimeout       *bool   `json:"enforceUserSessionTimeout,omitempty"`
	EnrollmentCustomizationID       *string `json:"enrollmentCustomizationId,omitempty"`
	EnrollmentSiteID                string  `json:"enrollmentSiteId"`
	// Controls whether apps are installed during the enrollment process.
	InstallAppsDuringEnrollment     *bool                        `json:"installAppsDuringEnrollment,omitempty"`
	KeepExistingLocationInformation bool                         `json:"keepExistingLocationInformation"`
	KeepExistingSiteMembership      bool                         `json:"keepExistingSiteMembership"`
	Language                        *string                      `json:"language,omitempty"`
	LocationInformation             LocationInformationV3        `json:"locationInformation"`
	Mandatory                       bool                         `json:"mandatory"`
	MaximumSharedAccounts           int                          `json:"maximumSharedAccounts"`
	MDMRemovable                    bool                         `json:"mdmRemovable"`
	MinimumOsSpecificVersionIos     *string                      `json:"minimumOsSpecificVersionIos,omitempty"`
	MinimumOsSpecificVersionIpad    *string                      `json:"minimumOsSpecificVersionIpad,omitempty"`
	MultiUser                       bool                         `json:"multiUser"`
	Names                           *MobileDevicePrestageNamesV3 `json:"names,omitempty"`
	// Controls whether managed apps are preserved during Return to Service operations.
	PreserveManagedApps *bool `json:"preserveManagedApps,omitempty"`
	// Allowed values: see the PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos constants.
	PrestageMinimumOsTargetVersionTypeIos *string `json:"prestageMinimumOsTargetVersionTypeIos,omitempty"`
	// Allowed values: see the PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad constants.
	PrestageMinimumOsTargetVersionTypeIpad *string                         `json:"prestageMinimumOsTargetVersionTypeIpad,omitempty"`
	PreventActivationLock                  bool                            `json:"preventActivationLock"`
	PurchasingInformation                  PrestagePurchasingInformationV3 `json:"purchasingInformation"`
	Region                                 *string                         `json:"region,omitempty"`
	RequireAuthentication                  bool                            `json:"requireAuthentication"`
	RtsConfigProfileID                     *string                         `json:"rtsConfigProfileId,omitempty"`
	RtsEnabled                             *bool                           `json:"rtsEnabled,omitempty"`
	SendTimezone                           bool                            `json:"sendTimezone"`
	SkipSetupItems                         *map[string]bool                `json:"skipSetupItems,omitempty"`
	StorageQuotaSizeMegabytes              int                             `json:"storageQuotaSizeMegabytes"`
	Supervised                             bool                            `json:"supervised"`
	SupportEmailAddress                    string                          `json:"supportEmailAddress"`
	SupportPhoneNumber                     string                          `json:"supportPhoneNumber"`
	TemporarySessionOnly                   *bool                           `json:"temporarySessionOnly,omitempty"`
	TemporarySessionTimeout                *int                            `json:"temporarySessionTimeout,omitempty"`
	Timezone                               string                          `json:"timezone"`
	UseStorageQuotaSize                    bool                            `json:"useStorageQuotaSize"`
	UserSessionTimeout                     *int                            `json:"userSessionTimeout,omitempty"`
	VersionLock                            *int                            `json:"versionLock,omitempty"`
}

PutMobileDevicePrestageV3 represents a put mobile device prestage v3.

type PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos 

type PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = string

PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos is the set of values accepted by PutMobileDevicePrestageV3.PrestageMinimumOsTargetVersionTypeIos. 

const (
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosNoEnforcement               PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "NO_ENFORCEMENT"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestVersion      PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_VERSION"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestMajorVersion PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsLatestMinorVersion PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_LATEST_MINOR_VERSION"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosMinimumOsSpecificVersion    PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos = "MINIMUM_OS_SPECIFIC_VERSION"
)

PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues 

func PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues() []PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos

PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIosValues returns every value the Jamf API accepts for PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIos, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad 

type PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = string

PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad is the set of values accepted by PutMobileDevicePrestageV3.PrestageMinimumOsTargetVersionTypeIpad. 

const (
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadNoEnforcement               PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "NO_ENFORCEMENT"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestVersion      PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_VERSION"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestMajorVersion PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_MAJOR_VERSION"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsLatestMinorVersion PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_LATEST_MINOR_VERSION"
	PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadMinimumOsSpecificVersion    PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad = "MINIMUM_OS_SPECIFIC_VERSION"
)

PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues 

func PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues() []PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad

PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpadValues returns every value the Jamf API accepts for PutMobileDevicePrestageV3PrestageMinimumOsTargetVersionTypeIpad, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type RecalculationResults 

type RecalculationResults struct {
	Count int `json:"count"`
}

RecalculationResults represents a recalculation results.

type RedeployJamfManagementFrameworkResponse 

type RedeployJamfManagementFrameworkResponse struct {
	CommandUUID string `json:"commandUuid"`
	DeviceID    string `json:"deviceId"`
}

RedeployJamfManagementFrameworkResponse represents a redeploy jamf management framework response.

type Reenrollment 

type Reenrollment struct {
	// Allowed values: see the ReenrollmentFlushMDMQueue constants.
	FlushMDMQueue                            string `json:"flushMDMQueue"`
	IsFlushExtensionAttributesEnabled        *bool  `json:"isFlushExtensionAttributesEnabled,omitempty"`
	IsFlushLocationInformationEnabled        *bool  `json:"isFlushLocationInformationEnabled,omitempty"`
	IsFlushLocationInformationHistoryEnabled *bool  `json:"isFlushLocationInformationHistoryEnabled,omitempty"`
	IsFlushPolicyHistoryEnabled              *bool  `json:"isFlushPolicyHistoryEnabled,omitempty"`
	IsFlushSoftwareUpdatePlansEnabled        *bool  `json:"isFlushSoftwareUpdatePlansEnabled,omitempty"`
}

Reenrollment represents a reenrollment.

type ReenrollmentFlushMDMQueue 

type ReenrollmentFlushMDMQueue = string

ReenrollmentFlushMDMQueue is the set of values accepted by Reenrollment.FlushMDMQueue. 

const (
	ReenrollmentFlushMDMQueueDeleteNothing                      ReenrollmentFlushMDMQueue = "DELETE_NOTHING"
	ReenrollmentFlushMDMQueueDeleteErrors                       ReenrollmentFlushMDMQueue = "DELETE_ERRORS"
	ReenrollmentFlushMDMQueueDeleteEverythingExceptAcknowledged ReenrollmentFlushMDMQueue = "DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED"
	ReenrollmentFlushMDMQueueDeleteEverything                   ReenrollmentFlushMDMQueue = "DELETE_EVERYTHING"
)

ReenrollmentFlushMDMQueue values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ReenrollmentFlushMDMQueueValues 

func ReenrollmentFlushMDMQueueValues() []ReenrollmentFlushMDMQueue

ReenrollmentFlushMDMQueueValues returns every value the Jamf API accepts for ReenrollmentFlushMDMQueue, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type RemoteAdministrationResponse 

type RemoteAdministrationResponse struct {
	DisplayName string `json:"displayName"`
	ID          string `json:"id"`
	SiteID      string `json:"siteId"`
	// Allowed values: see the RemoteAdministrationResponseType constants.
	Type string `json:"type"`
}

RemoteAdministrationResponse A Remote administration response.

type RemoteAdministrationResponseType 

type RemoteAdministrationResponseType = string

RemoteAdministrationResponseType is the set of values accepted by RemoteAdministrationResponse.Type. 

const (
	RemoteAdministrationResponseTypeTeamViewer RemoteAdministrationResponseType = "team-viewer"
)

RemoteAdministrationResponseType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func RemoteAdministrationResponseTypeValues 

func RemoteAdministrationResponseTypeValues() []RemoteAdministrationResponseType

RemoteAdministrationResponseTypeValues returns every value the Jamf API accepts for RemoteAdministrationResponseType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type RemoteAdministrationSearchResults 

type RemoteAdministrationSearchResults struct {
	Results    []RemoteAdministrationResponse `json:"results"`
	TotalCount int                            `json:"totalCount"`
}

RemoteAdministrationSearchResults A list with Remote administration configurations.

type RemoveComputerMDMProfileResponse 

type RemoveComputerMDMProfileResponse struct {
	// Uuid of the command queued that removes the MDM profile.
	CommandUUID string `json:"commandUuid"`
	// Id of the computer whose MDM profile was removed.
	DeviceID string `json:"deviceId"`
}

RemoveComputerMDMProfileResponse represents a remove computer m d m profile response.

type RenewMDMProfileResponse 

type RenewMDMProfileResponse struct {
	UdidsNotProcessed *Udids `json:"udidsNotProcessed,omitempty"`
}

RenewMDMProfileResponse represents a renew m d m profile response.

type RetentionPolicyV1 

type RetentionPolicyV1 struct {
	DisplayName     string `json:"displayName"`
	Qualifier       string `json:"qualifier"`
	RetentionPeriod int    `json:"retentionPeriod"`
	// The unit of the retention period (eg: DAY, WEEK, MONTH, YEAR).
	RetentionPeriodUnit string `json:"retentionPeriodUnit"`
}

RetentionPolicyV1 represents a retention policy v1.

type ReturnToServiceConfiguration 

type ReturnToServiceConfiguration struct {
	DisplayName string `json:"displayName"`
	// Id of the Return to Service Configuration.
	ID string `json:"id"`
	// Id of the wifi profile that is associated with the return to service configuration.
	WifiProfileID string `json:"wifiProfileId"`
}

ReturnToServiceConfiguration represents a return to service configuration.

type ReturnToServiceConfigurationRequest 

type ReturnToServiceConfigurationRequest struct {
	// Display name of the Return to Service Configuration.
	DisplayName *string `json:"displayName,omitempty"`
	// Id of the wifi profile that is associated with the return to service configuration.
	WifiProfileID *string `json:"wifiProfileId,omitempty"`
}

ReturnToServiceConfigurationRequest represents a return to service configuration request.

type ReturnToServiceConfigurationSearchResults 

type ReturnToServiceConfigurationSearchResults struct {
	Results    []ReturnToServiceConfiguration `json:"results"`
	TotalCount int                            `json:"totalCount"`
}

ReturnToServiceConfigurationSearchResults represents a return to service configuration search results.

type SafelistedApp 

type SafelistedApp struct {
	BundleID *string `json:"bundleId,omitempty"`
	Name     *string `json:"name,omitempty"`
}

SafelistedApp represents a safelisted app.

type SamlSettings 

type SamlSettings struct {
	EntityID               *string `json:"entityId"`
	FederationMetadataFile *[]byte `json:"federationMetadataFile"`
	GroupAttributeName     *string `json:"groupAttributeName"`
	GroupRdnKey            *string `json:"groupRdnKey"`
	// Allowed values: see the SamlSettingsIdpProviderType constants.
	IdpProviderType  *string `json:"idpProviderType"`
	IdpURL           *string `json:"idpUrl"`
	MetadataFileName *string `json:"metadataFileName"`
	// Allowed values: see the SamlSettingsMetadataSource constants.
	MetadataSource          *string `json:"metadataSource"`
	OtherProviderTypeName   *string `json:"otherProviderTypeName"`
	SessionTimeout          *int    `json:"sessionTimeout"`
	TokenExpirationDisabled *bool   `json:"tokenExpirationDisabled"`
	UserAttributeEnabled    *bool   `json:"userAttributeEnabled"`
	UserAttributeName       *string `json:"userAttributeName"`
	// Allowed values: see the SamlSettingsUserMapping constants.
	UserMapping *string `json:"userMapping"`
}

SamlSettings represents a saml settings.

type SamlSettingsIdpProviderType 

type SamlSettingsIdpProviderType = string

SamlSettingsIdpProviderType is the set of values accepted by SamlSettings.IdpProviderType. 

const (
	SamlSettingsIdpProviderTypeAdfs       SamlSettingsIdpProviderType = "ADFS"
	SamlSettingsIdpProviderTypeOkta       SamlSettingsIdpProviderType = "OKTA"
	SamlSettingsIdpProviderTypeGoogle     SamlSettingsIdpProviderType = "GOOGLE"
	SamlSettingsIdpProviderTypeShibboleth SamlSettingsIdpProviderType = "SHIBBOLETH"
	SamlSettingsIdpProviderTypeOnelogin   SamlSettingsIdpProviderType = "ONELOGIN"
	SamlSettingsIdpProviderTypePing       SamlSettingsIdpProviderType = "PING"
	SamlSettingsIdpProviderTypeCentrify   SamlSettingsIdpProviderType = "CENTRIFY"
	SamlSettingsIdpProviderTypeAzure      SamlSettingsIdpProviderType = "AZURE"
	SamlSettingsIdpProviderTypeOther      SamlSettingsIdpProviderType = "OTHER"
)

SamlSettingsIdpProviderType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SamlSettingsIdpProviderTypeValues 

func SamlSettingsIdpProviderTypeValues() []SamlSettingsIdpProviderType

SamlSettingsIdpProviderTypeValues returns every value the Jamf API accepts for SamlSettingsIdpProviderType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SamlSettingsMetadataSource 

type SamlSettingsMetadataSource = string

SamlSettingsMetadataSource is the set of values accepted by SamlSettings.MetadataSource. 

const (
	SamlSettingsMetadataSourceURL     SamlSettingsMetadataSource = "URL"
	SamlSettingsMetadataSourceFile    SamlSettingsMetadataSource = "FILE"
	SamlSettingsMetadataSourceUnknown SamlSettingsMetadataSource = "UNKNOWN"
)

SamlSettingsMetadataSource values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SamlSettingsMetadataSourceValues 

func SamlSettingsMetadataSourceValues() []SamlSettingsMetadataSource

SamlSettingsMetadataSourceValues returns every value the Jamf API accepts for SamlSettingsMetadataSource, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SamlSettingsUserMapping 

type SamlSettingsUserMapping = string

SamlSettingsUserMapping is the set of values accepted by SamlSettings.UserMapping. 

const (
	SamlSettingsUserMappingUsername SamlSettingsUserMapping = "USERNAME"
	SamlSettingsUserMappingEmail    SamlSettingsUserMapping = "EMAIL"
)

SamlSettingsUserMapping values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SamlSettingsUserMappingValues 

func SamlSettingsUserMappingValues() []SamlSettingsUserMapping

SamlSettingsUserMappingValues returns every value the Jamf API accepts for SamlSettingsUserMapping, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SchedulerJob 

type SchedulerJob struct {
	Results    []SchedulerTrigger `json:"results"`
	TotalCount int                `json:"totalCount"`
}

SchedulerJob represents a scheduler job.

type SchedulerJobs 

type SchedulerJobs struct {
	JobKeys []string `json:"jobKeys"`
}

SchedulerJobs represents a scheduler jobs.

type SchedulerSummary 

type SchedulerSummary struct {
	NumberOfExecutedJobs  int  `json:"numberOfExecutedJobs"`
	NumberOfExecutingJobs int  `json:"numberOfExecutingJobs"`
	NumberOfPendingJobs   int  `json:"numberOfPendingJobs"`
	Started               bool `json:"started"`
}

SchedulerSummary represents a scheduler summary.

type SchedulerTrigger 

type SchedulerTrigger struct {
	NextFireTime     *time.Time `json:"nextFireTime,omitempty"`
	PreviousFireTime *time.Time `json:"previousFireTime,omitempty"`
	TriggerKey       string     `json:"triggerKey"`
}

SchedulerTrigger represents a scheduler trigger.

type Script 

type Script struct {
	CategoryID     *string `json:"categoryId,omitempty"`
	CategoryName   *string `json:"categoryName,omitempty"`
	ID             *string `json:"id,omitempty"`
	Info           *string `json:"info,omitempty"`
	Name           string  `json:"name"`
	Notes          *string `json:"notes,omitempty"`
	OsRequirements *string `json:"osRequirements,omitempty"`
	Parameter10    *string `json:"parameter10,omitempty"`
	Parameter11    *string `json:"parameter11,omitempty"`
	Parameter4     *string `json:"parameter4,omitempty"`
	Parameter5     *string `json:"parameter5,omitempty"`
	Parameter6     *string `json:"parameter6,omitempty"`
	Parameter7     *string `json:"parameter7,omitempty"`
	Parameter8     *string `json:"parameter8,omitempty"`
	Parameter9     *string `json:"parameter9,omitempty"`
	// Allowed values: see the ScriptPriority constants.
	Priority       *string `json:"priority,omitempty"`
	ScriptContents *string `json:"scriptContents,omitempty"`
}

Script represents a script.

type ScriptPriority 

type ScriptPriority = string

ScriptPriority is the set of values accepted by Script.Priority. 

const (
	ScriptPriorityBefore   ScriptPriority = "BEFORE"
	ScriptPriorityAfter    ScriptPriority = "AFTER"
	ScriptPriorityAtReboot ScriptPriority = "AT_REBOOT"
)

ScriptPriority values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ScriptPriorityValues 

func ScriptPriorityValues() []ScriptPriority

ScriptPriorityValues returns every value the Jamf API accepts for ScriptPriority, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type ScriptsSearchResults 

type ScriptsSearchResults struct {
	Results    []Script `json:"results"`
	TotalCount int      `json:"totalCount"`
}

ScriptsSearchResults represents a scripts search results.

type SecurityV2 

type SecurityV2 struct {
	ActivationLockEnabled bool `json:"activationLockEnabled"`
	// Allowed values: see the SecurityV2AttestationStatus constants.
	AttestationStatus           string `json:"attestationStatus"`
	BlockLevelEncryptionCapable bool   `json:"blockLevelEncryptionCapable"`
	// The bootstrap token for the device.
	BootstrapToken string `json:"bootstrapToken"`
	// Indicates the bootstrap token escrow status for the device.
	// Allowed values: see the SecurityV2BootstrapTokenEscrowed constants.
	BootstrapTokenEscrowed        string     `json:"bootstrapTokenEscrowed"`
	DataProtected                 bool       `json:"dataProtected"`
	FileLevelEncryptionCapable    bool       `json:"fileLevelEncryptionCapable"`
	HardwareEncryption            int        `json:"hardwareEncryption"`
	JailBreakDetected             bool       `json:"jailBreakDetected"`
	LastAttestationAttemptDate    *time.Time `json:"lastAttestationAttemptDate,omitempty"`
	LastSuccessfulAttestationDate *time.Time `json:"lastSuccessfulAttestationDate,omitempty"`
	// Whether Lockdown Mode is enabled.
	LockdownModeEnabled          bool `json:"lockdownModeEnabled"`
	PasscodeCompliant            bool `json:"passcodeCompliant"`
	PasscodeCompliantWithProfile bool `json:"passcodeCompliantWithProfile"`
	PasscodePresent              bool `json:"passcodePresent"`
}

SecurityV2 represents a security v2.

type SecurityV2AttestationStatus 

type SecurityV2AttestationStatus = string

SecurityV2AttestationStatus is the set of values accepted by SecurityV2.AttestationStatus. 

const (
	SecurityV2AttestationStatusPending                     SecurityV2AttestationStatus = "PENDING"
	SecurityV2AttestationStatusSuccess                     SecurityV2AttestationStatus = "SUCCESS"
	SecurityV2AttestationStatusCertificateInvalid          SecurityV2AttestationStatus = "CERTIFICATE_INVALID"
	SecurityV2AttestationStatusDevicePropertiesMismatch    SecurityV2AttestationStatus = "DEVICE_PROPERTIES_MISMATCH"
	SecurityV2AttestationStatusMdaUnsupportedDueToHardware SecurityV2AttestationStatus = "MDA_UNSUPPORTED_DUE_TO_HARDWARE"
	SecurityV2AttestationStatusMdaUnsupportedDueToSoftware SecurityV2AttestationStatus = "MDA_UNSUPPORTED_DUE_TO_SOFTWARE"
)

SecurityV2AttestationStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SecurityV2AttestationStatusValues 

func SecurityV2AttestationStatusValues() []SecurityV2AttestationStatus

SecurityV2AttestationStatusValues returns every value the Jamf API accepts for SecurityV2AttestationStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SecurityV2BootstrapTokenEscrowed 

type SecurityV2BootstrapTokenEscrowed = string

SecurityV2BootstrapTokenEscrowed is the set of values accepted by SecurityV2.BootstrapTokenEscrowed. 

const (
	SecurityV2BootstrapTokenEscrowedEscrowed     SecurityV2BootstrapTokenEscrowed = "ESCROWED"
	SecurityV2BootstrapTokenEscrowedNotEscrowed  SecurityV2BootstrapTokenEscrowed = "NOT_ESCROWED"
	SecurityV2BootstrapTokenEscrowedNotSupported SecurityV2BootstrapTokenEscrowed = "NOT_SUPPORTED"
)

SecurityV2BootstrapTokenEscrowed values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SecurityV2BootstrapTokenEscrowedValues 

func SecurityV2BootstrapTokenEscrowedValues() []SecurityV2BootstrapTokenEscrowed

SecurityV2BootstrapTokenEscrowedValues returns every value the Jamf API accepts for SecurityV2BootstrapTokenEscrowed, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SelfServiceInstallSettings 

type SelfServiceInstallSettings struct {
	// true if Self Service is installed automatically, false if not.
	InstallAutomatically *bool `json:"installAutomatically,omitempty"`
	// path at which Self Service is installed. Required if installAutomatically is true.
	InstallLocation string `json:"installLocation"`
}

SelfServiceInstallSettings object representation of Self Service settings regarding installation.

type SelfServiceInteractionSettings 

type SelfServiceInteractionSettings struct {
	// whether users should be notified they need to approve organization's MDM profile.
	AlertUserApprovedMDM *bool `json:"alertUserApprovedMdm,omitempty"`
	// renamed string for bookmarks if the admin wishes.
	BookmarksName string `json:"bookmarksName"`
	// id for the default home category in Self Service.
	DefaultHomeCategoryID *int `json:"defaultHomeCategoryId,omitempty"`
	// the default landing page in Self Service.
	// Allowed values: see the SelfServiceInteractionSettingsDefaultLandingPage constants.
	DefaultLandingPage *string `json:"defaultLandingPage,omitempty"`
	// global Self Service setting for if notifications are on or off.
	NotificationsEnabled *bool `json:"notificationsEnabled,omitempty"`
}

SelfServiceInteractionSettings object representation of Self Service settings regarding user interaction.

type SelfServiceInteractionSettingsDefaultLandingPage 

type SelfServiceInteractionSettingsDefaultLandingPage = string

SelfServiceInteractionSettingsDefaultLandingPage is the set of values accepted by SelfServiceInteractionSettings.DefaultLandingPage. 

const (
	SelfServiceInteractionSettingsDefaultLandingPageHome          SelfServiceInteractionSettingsDefaultLandingPage = "HOME"
	SelfServiceInteractionSettingsDefaultLandingPageBrowse        SelfServiceInteractionSettingsDefaultLandingPage = "BROWSE"
	SelfServiceInteractionSettingsDefaultLandingPageHistory       SelfServiceInteractionSettingsDefaultLandingPage = "HISTORY"
	SelfServiceInteractionSettingsDefaultLandingPageNotifications SelfServiceInteractionSettingsDefaultLandingPage = "NOTIFICATIONS"
)

SelfServiceInteractionSettingsDefaultLandingPage values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SelfServiceInteractionSettingsDefaultLandingPageValues 

func SelfServiceInteractionSettingsDefaultLandingPageValues() []SelfServiceInteractionSettingsDefaultLandingPage

SelfServiceInteractionSettingsDefaultLandingPageValues returns every value the Jamf API accepts for SelfServiceInteractionSettingsDefaultLandingPage, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SelfServiceLoginSettings 

type SelfServiceLoginSettings struct {
	// true if remember me functionality is allowed, false if not.
	AllowRememberMe *bool `json:"allowRememberMe,omitempty"`
	// login type to be used when asking users to log in.
	// Allowed values: see the SelfServiceLoginSettingsAuthType constants.
	AuthType string `json:"authType"`
	// true if use FIDO2 functionality is allowed, false if not.
	UseFido2 *bool `json:"useFido2,omitempty"`
	// login setting to tell clients how to let users log in.
	// Allowed values: see the SelfServiceLoginSettingsUserLoginLevel constants.
	UserLoginLevel string `json:"userLoginLevel"`
}

SelfServiceLoginSettings object representation of Self Service settings regarding login.

type SelfServiceLoginSettingsAuthType 

type SelfServiceLoginSettingsAuthType = string

SelfServiceLoginSettingsAuthType is the set of values accepted by SelfServiceLoginSettings.AuthType. 

const (
	SelfServiceLoginSettingsAuthTypeBasic SelfServiceLoginSettingsAuthType = "Basic"
	SelfServiceLoginSettingsAuthTypeSaml  SelfServiceLoginSettingsAuthType = "Saml"
)

SelfServiceLoginSettingsAuthType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SelfServiceLoginSettingsAuthTypeValues 

func SelfServiceLoginSettingsAuthTypeValues() []SelfServiceLoginSettingsAuthType

SelfServiceLoginSettingsAuthTypeValues returns every value the Jamf API accepts for SelfServiceLoginSettingsAuthType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SelfServiceLoginSettingsUserLoginLevel 

type SelfServiceLoginSettingsUserLoginLevel = string

SelfServiceLoginSettingsUserLoginLevel is the set of values accepted by SelfServiceLoginSettings.UserLoginLevel. 

const (
	SelfServiceLoginSettingsUserLoginLevelNotRequired SelfServiceLoginSettingsUserLoginLevel = "NotRequired"
	SelfServiceLoginSettingsUserLoginLevelAnonymous   SelfServiceLoginSettingsUserLoginLevel = "Anonymous"
	SelfServiceLoginSettingsUserLoginLevelRequired    SelfServiceLoginSettingsUserLoginLevel = "Required"
)

SelfServiceLoginSettingsUserLoginLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SelfServiceLoginSettingsUserLoginLevelValues 

func SelfServiceLoginSettingsUserLoginLevelValues() []SelfServiceLoginSettingsUserLoginLevel

SelfServiceLoginSettingsUserLoginLevelValues returns every value the Jamf API accepts for SelfServiceLoginSettingsUserLoginLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SelfServicePlusSettings 

type SelfServicePlusSettings struct {
	// Whether Self Service Plus is enabled.
	Enabled *bool `json:"enabled,omitempty"`
}

SelfServicePlusSettings represents a self service plus settings.

type SelfServiceSettings 

type SelfServiceSettings struct {
	// object representation of Self Service settings regarding user interaction.
	ConfigurationSettings *SelfServiceInteractionSettings `json:"configurationSettings,omitempty"`
	// object representation of Self Service settings regarding installation.
	InstallSettings *SelfServiceInstallSettings `json:"installSettings,omitempty"`
	// object representation of Self Service settings regarding login.
	LoginSettings *SelfServiceLoginSettings `json:"loginSettings,omitempty"`
}

SelfServiceSettings object representation of Self Service settings.

type ServiceDiscoveryVersion 

type ServiceDiscoveryVersion = string

ServiceDiscoveryVersion represents a service discovery version value. 

const (
	ServiceDiscoveryVersionNone    ServiceDiscoveryVersion = "none"
	ServiceDiscoveryVersionMDMByod ServiceDiscoveryVersion = "mdm-byod"
	ServiceDiscoveryVersionMDMAdde ServiceDiscoveryVersion = "mdm-adde"
)

ServiceDiscoveryVersion values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func ServiceDiscoveryVersionValues 

func ServiceDiscoveryVersionValues() []ServiceDiscoveryVersion

ServiceDiscoveryVersionValues returns every value the Jamf API accepts for ServiceDiscoveryVersion, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type Session 

type Session struct {
	CurrentSiteID *int `json:"currentSiteId,omitempty"`
}

Session represents a session.

type SessionCandidateRequest 

type SessionCandidateRequest struct {
	// Session description. To be used for additional context on the reason of the session.
	Description string `json:"description"`
	// Device identifier.
	DeviceID string `json:"deviceId"`
	// Device type.
	// Allowed values: see the SessionCandidateRequestDeviceType constants.
	DeviceType string `json:"deviceType"`
}

SessionCandidateRequest Request to crate new remote session. Ultimately this allows connection between an admin and an end-user.

type SessionCandidateRequestDeviceType 

type SessionCandidateRequestDeviceType = string

SessionCandidateRequestDeviceType is the set of values accepted by SessionCandidateRequest.DeviceType. 

const (
	SessionCandidateRequestDeviceTypeComputer SessionCandidateRequestDeviceType = "COMPUTER"
)

SessionCandidateRequestDeviceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionCandidateRequestDeviceTypeValues 

func SessionCandidateRequestDeviceTypeValues() []SessionCandidateRequestDeviceType

SessionCandidateRequestDeviceTypeValues returns every value the Jamf API accepts for SessionCandidateRequestDeviceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionDetails 

type SessionDetails struct {
	// Sessions code.
	Code string `json:"code"`
	// Session creation time.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// ID of session creator if session created by Jamf Pro local user, null otherwise.
	CreatorID string `json:"creatorId"`
	// Username of the session creator.
	CreatorName string `json:"creatorName"`
	// Session description. To be used for additional context on the reason of the session.
	Description string `json:"description"`
	// Device identifier.
	DeviceID string `json:"deviceId"`
	// Device name if found - null otherwise.
	DeviceName string `json:"deviceName"`
	// Device type.
	// Allowed values: see the SessionDetailsDeviceType constants.
	DeviceType string `json:"deviceType"`
	// End user session URL.
	EndUserLink string `json:"endUserLink"`
	// Session identifier.
	ID string `json:"id"`
	// Session state.
	// Allowed values: see the SessionDetailsState constants.
	State string `json:"state"`
	// Supporter session URL.
	SupporterLink string `json:"supporterLink"`
}

SessionDetails Session details.

type SessionDetailsDeviceType 

type SessionDetailsDeviceType = string

SessionDetailsDeviceType is the set of values accepted by SessionDetails.DeviceType. 

const (
	SessionDetailsDeviceTypeComputer SessionDetailsDeviceType = "COMPUTER"
)

SessionDetailsDeviceType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionDetailsDeviceTypeValues 

func SessionDetailsDeviceTypeValues() []SessionDetailsDeviceType

SessionDetailsDeviceTypeValues returns every value the Jamf API accepts for SessionDetailsDeviceType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionDetailsSearchResults 

type SessionDetailsSearchResults struct {
	Results    []SessionDetails `json:"results"`
	TotalCount int              `json:"totalCount"`
}

SessionDetailsSearchResults Sessions search result.

type SessionDetailsState 

type SessionDetailsState = string

SessionDetailsState is the set of values accepted by SessionDetails.State. 

const (
	SessionDetailsStateOpen    SessionDetailsState = "OPEN"
	SessionDetailsStateClosed  SessionDetailsState = "CLOSED"
	SessionDetailsStateUnknown SessionDetailsState = "UNKNOWN"
)

SessionDetailsState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionDetailsStateValues 

func SessionDetailsStateValues() []SessionDetailsState

SessionDetailsStateValues returns every value the Jamf API accepts for SessionDetailsState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionHistoryItem 

type SessionHistoryItem struct {
	Comment                 string     `json:"comment"`
	DeviceID                string     `json:"deviceId"`
	SessionAdminID          string     `json:"sessionAdminId"`
	SessionEndedTimestamp   *time.Time `json:"sessionEndedTimestamp,omitempty"`
	SessionID               string     `json:"sessionId"`
	SessionStartedTimestamp *time.Time `json:"sessionStartedTimestamp,omitempty"`
	// Allowed values: see the SessionHistoryItemSessionType constants.
	SessionType string `json:"sessionType"`
	// Allowed values: see the SessionHistoryItemStatusType constants.
	StatusType string `json:"statusType"`
	TenantID   string `json:"tenantId"`
}

SessionHistoryItem represents a session history item.

type SessionHistoryItemDetails 

type SessionHistoryItemDetails struct {
	FileTransferItemList []FileTransferItem `json:"fileTransferItemList"`
}

SessionHistoryItemDetails represents a session history item details.

type SessionHistoryItemSessionType 

type SessionHistoryItemSessionType = string

SessionHistoryItemSessionType is the set of values accepted by SessionHistoryItem.SessionType. 

const (
	SessionHistoryItemSessionTypeAttended   SessionHistoryItemSessionType = "ATTENDED"
	SessionHistoryItemSessionTypeUnattended SessionHistoryItemSessionType = "UNATTENDED"
)

SessionHistoryItemSessionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionHistoryItemSessionTypeValues 

func SessionHistoryItemSessionTypeValues() []SessionHistoryItemSessionType

SessionHistoryItemSessionTypeValues returns every value the Jamf API accepts for SessionHistoryItemSessionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionHistoryItemStatusType 

type SessionHistoryItemStatusType = string

SessionHistoryItemStatusType is the set of values accepted by SessionHistoryItem.StatusType. 

const (
	SessionHistoryItemStatusTypeStarted  SessionHistoryItemStatusType = "STARTED"
	SessionHistoryItemStatusTypeFinished SessionHistoryItemStatusType = "FINISHED"
	SessionHistoryItemStatusTypeError    SessionHistoryItemStatusType = "ERROR"
)

SessionHistoryItemStatusType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionHistoryItemStatusTypeValues 

func SessionHistoryItemStatusTypeValues() []SessionHistoryItemStatusType

SessionHistoryItemStatusTypeValues returns every value the Jamf API accepts for SessionHistoryItemStatusType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionHistoryItemWithDetails 

type SessionHistoryItemWithDetails struct {
	Comment                 string                     `json:"comment"`
	Details                 *SessionHistoryItemDetails `json:"details,omitempty"`
	DeviceID                string                     `json:"deviceId"`
	SessionAdminID          string                     `json:"sessionAdminId"`
	SessionEndedTimestamp   *time.Time                 `json:"sessionEndedTimestamp,omitempty"`
	SessionID               string                     `json:"sessionId"`
	SessionStartedTimestamp *time.Time                 `json:"sessionStartedTimestamp,omitempty"`
	// Allowed values: see the SessionHistoryItemWithDetailsSessionType constants.
	SessionType string `json:"sessionType"`
	// Allowed values: see the SessionHistoryItemWithDetailsStatusType constants.
	StatusType string `json:"statusType"`
	TenantID   string `json:"tenantId"`
}

SessionHistoryItemWithDetails represents a session history item with details.

type SessionHistoryItemWithDetailsSessionType 

type SessionHistoryItemWithDetailsSessionType = string

SessionHistoryItemWithDetailsSessionType is the set of values accepted by SessionHistoryItemWithDetails.SessionType. 

const (
	SessionHistoryItemWithDetailsSessionTypeAttended   SessionHistoryItemWithDetailsSessionType = "ATTENDED"
	SessionHistoryItemWithDetailsSessionTypeUnattended SessionHistoryItemWithDetailsSessionType = "UNATTENDED"
)

SessionHistoryItemWithDetailsSessionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionHistoryItemWithDetailsSessionTypeValues 

func SessionHistoryItemWithDetailsSessionTypeValues() []SessionHistoryItemWithDetailsSessionType

SessionHistoryItemWithDetailsSessionTypeValues returns every value the Jamf API accepts for SessionHistoryItemWithDetailsSessionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionHistoryItemWithDetailsStatusType 

type SessionHistoryItemWithDetailsStatusType = string

SessionHistoryItemWithDetailsStatusType is the set of values accepted by SessionHistoryItemWithDetails.StatusType. 

const (
	SessionHistoryItemWithDetailsStatusTypeStarted  SessionHistoryItemWithDetailsStatusType = "STARTED"
	SessionHistoryItemWithDetailsStatusTypeFinished SessionHistoryItemWithDetailsStatusType = "FINISHED"
	SessionHistoryItemWithDetailsStatusTypeError    SessionHistoryItemWithDetailsStatusType = "ERROR"
)

SessionHistoryItemWithDetailsStatusType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionHistoryItemWithDetailsStatusTypeValues 

func SessionHistoryItemWithDetailsStatusTypeValues() []SessionHistoryItemWithDetailsStatusType

SessionHistoryItemWithDetailsStatusTypeValues returns every value the Jamf API accepts for SessionHistoryItemWithDetailsStatusType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SessionHistorySearchResults 

type SessionHistorySearchResults struct {
	Results    []SessionHistoryItem `json:"results"`
	TotalCount int                  `json:"totalCount"`
}

SessionHistorySearchResults represents a session history search results.

type SessionStatus 

type SessionStatus struct {
	// Defines if the end user is online.
	Online bool `json:"online"`
	// Session state.
	// Allowed values: see the SessionStatusSessionState constants.
	SessionState string `json:"sessionState"`
}

SessionStatus Session status.

type SessionStatusSessionState 

type SessionStatusSessionState = string

SessionStatusSessionState is the set of values accepted by SessionStatus.SessionState. 

const (
	SessionStatusSessionStateOpen    SessionStatusSessionState = "OPEN"
	SessionStatusSessionStateClosed  SessionStatusSessionState = "CLOSED"
	SessionStatusSessionStateUnknown SessionStatusSessionState = "UNKNOWN"
)

SessionStatusSessionState values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SessionStatusSessionStateValues 

func SessionStatusSessionStateValues() []SessionStatusSessionState

SessionStatusSessionStateValues returns every value the Jamf API accepts for SessionStatusSessionState, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SharedDeviceComplianceFeatureToggle 

type SharedDeviceComplianceFeatureToggle struct {
	SharedDeviceFeatureEnabled bool `json:"sharedDeviceFeatureEnabled"`
}

SharedDeviceComplianceFeatureToggle represents a shared device compliance feature toggle.

type Signature 

type Signature struct {
	Algorithm    string `json:"algorithm"`
	AlgorithmOid string `json:"algorithmOid"`
	Value        string `json:"value"`
}

Signature represents a signature.

type SiteObject 

type SiteObject struct {
	ObjectID string `json:"objectId"`
	// Allowed values: see the SiteObjectObjectType constants.
	ObjectType string `json:"objectType"`
	SiteID     string `json:"siteId"`
}

SiteObject represents a site object.

type SiteObjectObjectType 

type SiteObjectObjectType = string

SiteObjectObjectType is the set of values accepted by SiteObject.ObjectType. 

const (
	SiteObjectObjectTypeComputer                        SiteObjectObjectType = "Computer"
	SiteObjectObjectTypePeripheral                      SiteObjectObjectType = "Peripheral"
	SiteObjectObjectTypeLicensedSoftware                SiteObjectObjectType = "Licensed Software"
	SiteObjectObjectTypeLicensedSoftwareTemplate        SiteObjectObjectType = "Licensed Software Template"
	SiteObjectObjectTypePolicy                          SiteObjectObjectType = "Policy"
	SiteObjectObjectTypeMacOSConfigurationProfile       SiteObjectObjectType = "macOS Configuration Profile"
	SiteObjectObjectTypeRestrictedSoftware              SiteObjectObjectType = "Restricted Software"
	SiteObjectObjectTypeManagedPreferenceProfile        SiteObjectObjectType = "Managed Preference Profile"
	SiteObjectObjectTypeComputerGroup                   SiteObjectObjectType = "Computer Group"
	SiteObjectObjectTypeMobileDevice                    SiteObjectObjectType = "Mobile Device"
	SiteObjectObjectTypeAppleTv                         SiteObjectObjectType = "Apple TV"
	SiteObjectObjectTypeUserGroup                       SiteObjectObjectType = "User Group"
	SiteObjectObjectTypeIOSConfigurationProfile         SiteObjectObjectType = "iOS Configuration Profile"
	SiteObjectObjectTypeMobileDeviceApp                 SiteObjectObjectType = "Mobile Device App"
	SiteObjectObjectTypeEBook                           SiteObjectObjectType = "E-book"
	SiteObjectObjectTypeMobileDeviceGroup               SiteObjectObjectType = "Mobile Device Group"
	SiteObjectObjectTypeClassroom                       SiteObjectObjectType = "Classroom"
	SiteObjectObjectTypeAdvancedComputerSearch          SiteObjectObjectType = "Advanced Computer Search"
	SiteObjectObjectTypeAdvancedMobileSearch            SiteObjectObjectType = "Advanced Mobile Search"
	SiteObjectObjectTypeAdvancedUserSearch              SiteObjectObjectType = "Advanced User Search"
	SiteObjectObjectTypeAdvancedUserContentSearch       SiteObjectObjectType = "Advanced User Content Search"
	SiteObjectObjectTypeComputerInvitation              SiteObjectObjectType = "Computer Invitation"
	SiteObjectObjectTypeMobileDeviceInvitation          SiteObjectObjectType = "Mobile Device Invitation"
	SiteObjectObjectTypeMobileDeviceEnrollmentProfile   SiteObjectObjectType = "Mobile Device Enrollment Profile"
	SiteObjectObjectTypeDeviceEnrollmentProgramInstance SiteObjectObjectType = "Device Enrollment Program Instance"
	SiteObjectObjectTypeMobileDevicePrestage            SiteObjectObjectType = "Mobile Device Prestage"
	SiteObjectObjectTypeComputerDepPrestage             SiteObjectObjectType = "Computer DEP Prestage"
	SiteObjectObjectTypeEnrollmentCustomization         SiteObjectObjectType = "Enrollment Customization"
	SiteObjectObjectTypeVppLocation                     SiteObjectObjectType = "VPP Location"
	SiteObjectObjectTypeVppSubscription                 SiteObjectObjectType = "VPP Subscription"
	SiteObjectObjectTypeVppInvitation                   SiteObjectObjectType = "VPP Invitation"
	SiteObjectObjectTypeVppAssignment                   SiteObjectObjectType = "VPP Assignment"
	SiteObjectObjectTypeUser                            SiteObjectObjectType = "User"
	SiteObjectObjectTypeNetworkIntegration              SiteObjectObjectType = "Network Integration"
	SiteObjectObjectTypeMacApp                          SiteObjectObjectType = "Mac App"
	SiteObjectObjectTypeAppInstaller                    SiteObjectObjectType = "App Installer"
	SiteObjectObjectTypeSelfServicePlugin               SiteObjectObjectType = "Self Service Plugin"
	SiteObjectObjectTypeSoftwareTitle                   SiteObjectObjectType = "Software Title"
	SiteObjectObjectTypePatchSoftwareTitleSummary       SiteObjectObjectType = "Patch Software Title Summary"
	SiteObjectObjectTypePatchPolicy                     SiteObjectObjectType = "Patch Policy"
	SiteObjectObjectTypePatchSoftwareTitleConfiguration SiteObjectObjectType = "Patch Software Title Configuration"
	SiteObjectObjectTypeChangePassword                  SiteObjectObjectType = "Change Password"
	SiteObjectObjectTypeMobileDeviceInventory           SiteObjectObjectType = "Mobile Device Inventory"
	SiteObjectObjectTypeComputerInventory               SiteObjectObjectType = "Computer Inventory"
	SiteObjectObjectTypeChangeManagement                SiteObjectObjectType = "Change Management"
	SiteObjectObjectTypeLicensedSoftwareLicense         SiteObjectObjectType = "Licensed Software License"
	SiteObjectObjectTypeUnknown                         SiteObjectObjectType = "Unknown"
)

SiteObjectObjectType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SiteObjectObjectTypeValues 

func SiteObjectObjectTypeValues() []SiteObjectObjectType

SiteObjectObjectTypeValues returns every value the Jamf API accepts for SiteObjectObjectType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SlasaAcceptance 

type SlasaAcceptance struct {
	// Allowed values: see the SlasaAcceptanceSlasaAcceptanceStatus constants.
	SlasaAcceptanceStatus string `json:"slasaAcceptanceStatus"`
}

SlasaAcceptance represents a slasa acceptance.

type SlasaAcceptanceSlasaAcceptanceStatus 

type SlasaAcceptanceSlasaAcceptanceStatus = string

SlasaAcceptanceSlasaAcceptanceStatus is the set of values accepted by SlasaAcceptance.SlasaAcceptanceStatus. 

const (
	SlasaAcceptanceSlasaAcceptanceStatusAccepted    SlasaAcceptanceSlasaAcceptanceStatus = "ACCEPTED"
	SlasaAcceptanceSlasaAcceptanceStatusNotAccepted SlasaAcceptanceSlasaAcceptanceStatus = "NOT_ACCEPTED"
)

SlasaAcceptanceSlasaAcceptanceStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SlasaAcceptanceSlasaAcceptanceStatusValues 

func SlasaAcceptanceSlasaAcceptanceStatusValues() []SlasaAcceptanceSlasaAcceptanceStatus

SlasaAcceptanceSlasaAcceptanceStatusValues returns every value the Jamf API accepts for SlasaAcceptanceSlasaAcceptanceStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SmartComputerGroupSearch 

type SmartComputerGroupSearch struct {
	Description     string `json:"description"`
	ID              string `json:"id"`
	MembershipCount int    `json:"membershipCount"`
	Name            string `json:"name"`
	SiteID          string `json:"siteId"`
}

SmartComputerGroupSearch represents a smart computer group search.

type SmartComputerGroupV3 

type SmartComputerGroupV3 struct {
	Criteria    *[]ComputerSmartGroupCriteriaV2 `json:"criteria,omitempty"`
	Description *string                         `json:"description,omitempty"`
	Name        string                          `json:"name"`
	SiteID      *string                         `json:"siteId,omitempty"`
}

SmartComputerGroupV3 represents a smart computer group v3.

type SmartGroup 

type SmartGroup struct {
	// membership count.
	Count            int    `json:"count"`
	GroupDescription string `json:"groupDescription"`
	GroupID          string `json:"groupId"`
	GroupName        string `json:"groupName"`
	SiteID           string `json:"siteId"`
}

SmartGroup represents a smart group.

type SmartGroupAssignmentV2 

type SmartGroupAssignmentV2 struct {
	Criteria         *[]MobileDeviceSmartGroupCriteriaV2 `json:"criteria,omitempty"`
	GroupDescription *string                             `json:"groupDescription,omitempty"`
	// The unique identifier of the smart group.
	GroupID   *string `json:"groupId,omitempty"`
	GroupName string  `json:"groupName"`
	SiteID    *string `json:"siteId,omitempty"`
}

SmartGroupAssignmentV2 represents a smart group assignment v2.

type SmartGroupCriteria 

type SmartGroupCriteria struct {
	// Whether this criterion should be ANDed or ORed with the previous criterion.
	AndOr string `json:"andOr"`
	// Whether to add a closing parenthesis after this criterion.
	ClosingParen bool `json:"closingParen"`
	// The field to search on (e.g., Model, OS Version, etc.).
	Name string `json:"name"`
	// Whether to add an opening parenthesis before this criterion.
	OpeningParen bool `json:"openingParen"`
	// The priority order of this criterion.
	Priority int `json:"priority"`
	// The type of search to perform (e.g., is, is not, like, etc.).
	SearchType string `json:"searchType"`
	// The value to search for.
	Value string `json:"value"`
}

SmartGroupCriteria V1 criteria format with string andOr field.

type SmartGroupDetailV2 

type SmartGroupDetailV2 struct {
	// membership count.
	Count int `json:"count"`
	// The criteria used to define the smart group.
	Criteria         []MobileDeviceSmartGroupCriteriaV2 `json:"criteria"`
	GroupDescription string                             `json:"groupDescription"`
	GroupID          string                             `json:"groupId"`
	GroupName        string                             `json:"groupName"`
	SiteID           string                             `json:"siteId"`
}

SmartGroupDetailV2 represents a smart group detail v2.

type SmartGroupMembership 

type SmartGroupMembership struct {
	Members []int `json:"members"`
}

SmartGroupMembership the ids of the computers that are members of the smart group.

type SmartGroupSearchResult 

type SmartGroupSearchResult struct {
	Results    []SmartComputerGroupSearch `json:"results"`
	TotalCount int                        `json:"totalCount"`
}

SmartGroupSearchResult represents a smart group search result.

type SmartGroupSearchResults 

type SmartGroupSearchResults struct {
	Results    []SmartGroup `json:"results"`
	TotalCount int          `json:"totalCount"`
}

SmartGroupSearchResults represents a smart group search results.

type SmartSearchCriterion 

type SmartSearchCriterion struct {
	AndOr        string `json:"andOr"`
	ClosingParen *bool  `json:"closingParen,omitempty"`
	Name         string `json:"name"`
	OpeningParen *bool  `json:"openingParen,omitempty"`
	Priority     *int   `json:"priority,omitempty"`
	SearchType   string `json:"searchType"`
	Value        string `json:"value"`
}

SmartSearchCriterion represents a smart search criterion.

type SmtpAuthenticationTypeList 

type SmtpAuthenticationTypeList struct {
	// Allowed values: see the SmtpAuthenticationTypeListAllowedAuthenticationTypes constants.
	AllowedAuthenticationTypes []string `json:"allowedAuthenticationTypes"`
}

SmtpAuthenticationTypeList represents a smtp authentication type list.

type SmtpAuthenticationTypeListAllowedAuthenticationTypes 

type SmtpAuthenticationTypeListAllowedAuthenticationTypes = string

SmtpAuthenticationTypeListAllowedAuthenticationTypes is the set of values accepted by SmtpAuthenticationTypeList.AllowedAuthenticationTypes. 

const (
	SmtpAuthenticationTypeListAllowedAuthenticationTypesNone       SmtpAuthenticationTypeListAllowedAuthenticationTypes = "NONE"
	SmtpAuthenticationTypeListAllowedAuthenticationTypesBasic      SmtpAuthenticationTypeListAllowedAuthenticationTypes = "BASIC"
	SmtpAuthenticationTypeListAllowedAuthenticationTypesGraphApi   SmtpAuthenticationTypeListAllowedAuthenticationTypes = "GRAPH_API"
	SmtpAuthenticationTypeListAllowedAuthenticationTypesGoogleMail SmtpAuthenticationTypeListAllowedAuthenticationTypes = "GOOGLE_MAIL"
)

SmtpAuthenticationTypeListAllowedAuthenticationTypes values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SmtpAuthenticationTypeListAllowedAuthenticationTypesValues 

func SmtpAuthenticationTypeListAllowedAuthenticationTypesValues() []SmtpAuthenticationTypeListAllowedAuthenticationTypes

SmtpAuthenticationTypeListAllowedAuthenticationTypesValues returns every value the Jamf API accepts for SmtpAuthenticationTypeListAllowedAuthenticationTypes, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SmtpBasicCredentials 

type SmtpBasicCredentials struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
	Username string `json:"username"`
}

SmtpBasicCredentials represents a smtp basic credentials.

type SmtpConnectionSettings 

type SmtpConnectionSettings struct {
	ConnectionTimeout int `json:"connectionTimeout"`
	// Allowed values: see the SmtpConnectionSettingsEncryptionType constants.
	EncryptionType string `json:"encryptionType"`
	Host           string `json:"host"`
	Port           int    `json:"port"`
}

SmtpConnectionSettings represents a smtp connection settings.

type SmtpConnectionSettingsEncryptionType 

type SmtpConnectionSettingsEncryptionType = string

SmtpConnectionSettingsEncryptionType is the set of values accepted by SmtpConnectionSettings.EncryptionType. 

const (
	SmtpConnectionSettingsEncryptionTypeNone  SmtpConnectionSettingsEncryptionType = "NONE"
	SmtpConnectionSettingsEncryptionTypeSsl   SmtpConnectionSettingsEncryptionType = "SSL"
	SmtpConnectionSettingsEncryptionTypeTls12 SmtpConnectionSettingsEncryptionType = "TLS_1_2"
	SmtpConnectionSettingsEncryptionTypeTls11 SmtpConnectionSettingsEncryptionType = "TLS_1_1"
	SmtpConnectionSettingsEncryptionTypeTls1  SmtpConnectionSettingsEncryptionType = "TLS_1"
	SmtpConnectionSettingsEncryptionTypeTls13 SmtpConnectionSettingsEncryptionType = "TLS_1_3"
)

SmtpConnectionSettingsEncryptionType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SmtpConnectionSettingsEncryptionTypeValues 

func SmtpConnectionSettingsEncryptionTypeValues() []SmtpConnectionSettingsEncryptionType

SmtpConnectionSettingsEncryptionTypeValues returns every value the Jamf API accepts for SmtpConnectionSettingsEncryptionType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SmtpGoogleMailAuthentication 

type SmtpGoogleMailAuthentication struct {
	EmailAddress string `json:"emailAddress"`
	// Allowed values: see the SmtpGoogleMailAuthenticationStatus constants.
	Status string `json:"status"`
}

SmtpGoogleMailAuthentication represents a smtp google mail authentication.

type SmtpGoogleMailAuthenticationStatus 

type SmtpGoogleMailAuthenticationStatus = string

SmtpGoogleMailAuthenticationStatus is the set of values accepted by SmtpGoogleMailAuthentication.Status. 

const (
	SmtpGoogleMailAuthenticationStatusFailed          SmtpGoogleMailAuthenticationStatus = "FAILED"
	SmtpGoogleMailAuthenticationStatusUnauthenticated SmtpGoogleMailAuthenticationStatus = "UNAUTHENTICATED"
	SmtpGoogleMailAuthenticationStatusAuthenticated   SmtpGoogleMailAuthenticationStatus = "AUTHENTICATED"
)

SmtpGoogleMailAuthenticationStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SmtpGoogleMailAuthenticationStatusValues 

func SmtpGoogleMailAuthenticationStatusValues() []SmtpGoogleMailAuthenticationStatus

SmtpGoogleMailAuthenticationStatusValues returns every value the Jamf API accepts for SmtpGoogleMailAuthenticationStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SmtpGoogleMailCredentials 

type SmtpGoogleMailCredentials struct {
	Authentications *[]SmtpGoogleMailAuthentication `json:"authentications,omitempty"`
	ClientID        string                          `json:"clientId"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	ClientSecret string `json:"clientSecret"`
}

SmtpGoogleMailCredentials represents a smtp google mail credentials.

type SmtpGraphApiCredentials 

type SmtpGraphApiCredentials struct {
	ClientID string `json:"clientId"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	ClientSecret string `json:"clientSecret"`
	TenantID     string `json:"tenantId"`
}

SmtpGraphApiCredentials represents a smtp graph api credentials.

type SmtpSenderSettings 

type SmtpSenderSettings struct {
	DisplayName  *string `json:"displayName,omitempty"`
	EmailAddress string  `json:"emailAddress"`
}

SmtpSenderSettings represents a smtp sender settings.

type SmtpServerTest 

type SmtpServerTest struct {
	RecipientEmail string `json:"recipientEmail"`
}

SmtpServerTest represents a smtp server test.

type SmtpServerV2 

type SmtpServerV2 struct {
	// The authentication type to use for the SMTP server. Note that NONE and BASIC may not be available
	// depending on the server configuration. Check allowedAuthenticationTypes for the list of currently
	// supported values.
	// Allowed values: see the SmtpServerV2AuthenticationType constants.
	AuthenticationType    string                     `json:"authenticationType"`
	BasicAuthCredentials  *SmtpBasicCredentials      `json:"basicAuthCredentials,omitempty"`
	ConnectionSettings    *SmtpConnectionSettings    `json:"connectionSettings,omitempty"`
	Enabled               bool                       `json:"enabled"`
	GoogleMailCredentials *SmtpGoogleMailCredentials `json:"googleMailCredentials,omitempty"`
	GraphApiCredentials   *SmtpGraphApiCredentials   `json:"graphApiCredentials,omitempty"`
	SenderSettings        SmtpSenderSettings         `json:"senderSettings"`
}

SmtpServerV2 represents a smtp server v2.

type SmtpServerV2AuthenticationType 

type SmtpServerV2AuthenticationType = string

SmtpServerV2AuthenticationType is the set of values accepted by SmtpServerV2.AuthenticationType. 

const (
	SmtpServerV2AuthenticationTypeNone       SmtpServerV2AuthenticationType = "NONE"
	SmtpServerV2AuthenticationTypeBasic      SmtpServerV2AuthenticationType = "BASIC"
	SmtpServerV2AuthenticationTypeGraphApi   SmtpServerV2AuthenticationType = "GRAPH_API"
	SmtpServerV2AuthenticationTypeGoogleMail SmtpServerV2AuthenticationType = "GOOGLE_MAIL"
)

SmtpServerV2AuthenticationType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SmtpServerV2AuthenticationTypeValues 

func SmtpServerV2AuthenticationTypeValues() []SmtpServerV2AuthenticationType

SmtpServerV2AuthenticationTypeValues returns every value the Jamf API accepts for SmtpServerV2AuthenticationType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SoftwareTitleConfigurationOnDashboard 

type SoftwareTitleConfigurationOnDashboard struct {
	OnDashboard bool `json:"onDashboard"`
}

SoftwareTitleConfigurationOnDashboard represents a software title configuration on dashboard.

type SsoFailoverData 

type SsoFailoverData struct {
	FailoverURL string `json:"failoverUrl"`
	// Generation time of failover key.
	GenerationTime int64 `json:"generationTime"`
}

SsoFailoverData represents a sso failover data.

type SsoKeystore 

type SsoKeystore struct {
	Key              string            `json:"key"`
	Keys             *[]CertificateKey `json:"keys,omitempty"`
	KeystoreFile     []byte            `json:"keystoreFile"`
	KeystoreFileName string            `json:"keystoreFileName"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	KeystorePassword string `json:"keystorePassword"`
	// Allowed values: see the SsoKeystoreKeystoreSetupType constants.
	KeystoreSetupType *string `json:"keystoreSetupType,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
	// Allowed values: see the SsoKeystoreType constants.
	Type string `json:"type"`
}

SsoKeystore represents a sso keystore.

type SsoKeystoreCertParseResponse 

type SsoKeystoreCertParseResponse struct {
	Key              string           `json:"key"`
	Keys             []CertificateKey `json:"keys"`
	KeystoreFile     [][]byte         `json:"keystoreFile"`
	KeystoreFileName string           `json:"keystoreFileName"`
	// Allowed values: see the SsoKeystoreCertParseResponseKeystoreSetupType constants.
	KeystoreSetupType string `json:"keystoreSetupType"`
	// Allowed values: see the SsoKeystoreCertParseResponseType constants.
	Type string `json:"type"`
}

SsoKeystoreCertParseResponse represents a sso keystore cert parse response.

type SsoKeystoreCertParseResponseKeystoreSetupType 

type SsoKeystoreCertParseResponseKeystoreSetupType = string

SsoKeystoreCertParseResponseKeystoreSetupType is the set of values accepted by SsoKeystoreCertParseResponse.KeystoreSetupType. 

const (
	SsoKeystoreCertParseResponseKeystoreSetupTypeNone      SsoKeystoreCertParseResponseKeystoreSetupType = "NONE"
	SsoKeystoreCertParseResponseKeystoreSetupTypeUploaded  SsoKeystoreCertParseResponseKeystoreSetupType = "UPLOADED"
	SsoKeystoreCertParseResponseKeystoreSetupTypeGenerated SsoKeystoreCertParseResponseKeystoreSetupType = "GENERATED"
)

SsoKeystoreCertParseResponseKeystoreSetupType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoKeystoreCertParseResponseKeystoreSetupTypeValues 

func SsoKeystoreCertParseResponseKeystoreSetupTypeValues() []SsoKeystoreCertParseResponseKeystoreSetupType

SsoKeystoreCertParseResponseKeystoreSetupTypeValues returns every value the Jamf API accepts for SsoKeystoreCertParseResponseKeystoreSetupType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SsoKeystoreCertParseResponseType 

type SsoKeystoreCertParseResponseType = string

SsoKeystoreCertParseResponseType is the set of values accepted by SsoKeystoreCertParseResponse.Type. 

const (
	SsoKeystoreCertParseResponseTypePkcs12 SsoKeystoreCertParseResponseType = "PKCS12"
	SsoKeystoreCertParseResponseTypeJks    SsoKeystoreCertParseResponseType = "JKS"
	SsoKeystoreCertParseResponseTypeNone   SsoKeystoreCertParseResponseType = "NONE"
)

SsoKeystoreCertParseResponseType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoKeystoreCertParseResponseTypeValues 

func SsoKeystoreCertParseResponseTypeValues() []SsoKeystoreCertParseResponseType

SsoKeystoreCertParseResponseTypeValues returns every value the Jamf API accepts for SsoKeystoreCertParseResponseType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SsoKeystoreDetails 

type SsoKeystoreDetails struct {
	Expiration   string       `json:"expiration"`
	Issuer       string       `json:"issuer"`
	Keys         []string     `json:"keys"`
	SerialNumber *json.Number `json:"serialNumber,omitempty"`
	Subject      string       `json:"subject"`
}

SsoKeystoreDetails represents a sso keystore details.

type SsoKeystoreKeystoreSetupType 

type SsoKeystoreKeystoreSetupType = string

SsoKeystoreKeystoreSetupType is the set of values accepted by SsoKeystore.KeystoreSetupType. 

const (
	SsoKeystoreKeystoreSetupTypeNone      SsoKeystoreKeystoreSetupType = "NONE"
	SsoKeystoreKeystoreSetupTypeUploaded  SsoKeystoreKeystoreSetupType = "UPLOADED"
	SsoKeystoreKeystoreSetupTypeGenerated SsoKeystoreKeystoreSetupType = "GENERATED"
)

SsoKeystoreKeystoreSetupType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoKeystoreKeystoreSetupTypeValues 

func SsoKeystoreKeystoreSetupTypeValues() []SsoKeystoreKeystoreSetupType

SsoKeystoreKeystoreSetupTypeValues returns every value the Jamf API accepts for SsoKeystoreKeystoreSetupType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SsoKeystoreParse 

type SsoKeystoreParse struct {
	KeystoreFile     []byte `json:"keystoreFile"`
	KeystoreFileName string `json:"keystoreFileName"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	KeystorePassword string `json:"keystorePassword"`
}

SsoKeystoreParse represents a sso keystore parse.

type SsoKeystoreResponse 

type SsoKeystoreResponse struct {
	Key              string           `json:"key"`
	Keys             []CertificateKey `json:"keys"`
	KeystoreFileName string           `json:"keystoreFileName"`
	// Allowed values: see the SsoKeystoreResponseKeystoreSetupType constants.
	KeystoreSetupType string `json:"keystoreSetupType"`
	// Allowed values: see the SsoKeystoreResponseType constants.
	Type string `json:"type"`
}

SsoKeystoreResponse represents a sso keystore response.

type SsoKeystoreResponseKeystoreSetupType 

type SsoKeystoreResponseKeystoreSetupType = string

SsoKeystoreResponseKeystoreSetupType is the set of values accepted by SsoKeystoreResponse.KeystoreSetupType. 

const (
	SsoKeystoreResponseKeystoreSetupTypeNone      SsoKeystoreResponseKeystoreSetupType = "NONE"
	SsoKeystoreResponseKeystoreSetupTypeUploaded  SsoKeystoreResponseKeystoreSetupType = "UPLOADED"
	SsoKeystoreResponseKeystoreSetupTypeGenerated SsoKeystoreResponseKeystoreSetupType = "GENERATED"
)

SsoKeystoreResponseKeystoreSetupType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoKeystoreResponseKeystoreSetupTypeValues 

func SsoKeystoreResponseKeystoreSetupTypeValues() []SsoKeystoreResponseKeystoreSetupType

SsoKeystoreResponseKeystoreSetupTypeValues returns every value the Jamf API accepts for SsoKeystoreResponseKeystoreSetupType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SsoKeystoreResponseType 

type SsoKeystoreResponseType = string

SsoKeystoreResponseType is the set of values accepted by SsoKeystoreResponse.Type. 

const (
	SsoKeystoreResponseTypePkcs12 SsoKeystoreResponseType = "PKCS12"
	SsoKeystoreResponseTypeJks    SsoKeystoreResponseType = "JKS"
	SsoKeystoreResponseTypeNone   SsoKeystoreResponseType = "NONE"
)

SsoKeystoreResponseType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoKeystoreResponseTypeValues 

func SsoKeystoreResponseTypeValues() []SsoKeystoreResponseType

SsoKeystoreResponseTypeValues returns every value the Jamf API accepts for SsoKeystoreResponseType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SsoKeystoreResponseWithDetails 

type SsoKeystoreResponseWithDetails struct {
	Keystore        *SsoKeystoreResponse `json:"keystore,omitempty"`
	KeystoreDetails *SsoKeystoreDetails  `json:"keystoreDetails,omitempty"`
}

SsoKeystoreResponseWithDetails represents a sso keystore response with details.

type SsoKeystoreType 

type SsoKeystoreType = string

SsoKeystoreType is the set of values accepted by SsoKeystore.Type. 

const (
	SsoKeystoreTypePkcs12 SsoKeystoreType = "PKCS12"
	SsoKeystoreTypeJks    SsoKeystoreType = "JKS"
	SsoKeystoreTypeNone   SsoKeystoreType = "NONE"
)

SsoKeystoreType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoKeystoreTypeValues 

func SsoKeystoreTypeValues() []SsoKeystoreType

SsoKeystoreTypeValues returns every value the Jamf API accepts for SsoKeystoreType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type SsoSettingsV3 

type SsoSettingsV3 struct {
	// Allowed values: see the SsoSettingsV3ConfigurationType constants.
	ConfigurationType                              string               `json:"configurationType"`
	EnrollmentSsoConfig                            *EnrollmentSsoConfig `json:"enrollmentSsoConfig,omitempty"`
	EnrollmentSsoForAccountDrivenEnrollmentEnabled bool                 `json:"enrollmentSsoForAccountDrivenEnrollmentEnabled"`
	GroupEnrollmentAccessEnabled                   bool                 `json:"groupEnrollmentAccessEnabled"`
	GroupEnrollmentAccessName                      *string              `json:"groupEnrollmentAccessName,omitempty"`
	OidcSettings                                   OidcSettings         `json:"oidcSettings"`
	SamlSettings                                   SamlSettings         `json:"samlSettings"`
	SsoBypassAllowed                               bool                 `json:"ssoBypassAllowed"`
	SsoEnabled                                     bool                 `json:"ssoEnabled"`
	SsoForEnrollmentEnabled                        bool                 `json:"ssoForEnrollmentEnabled"`
	SsoForMacOsSelfServiceEnabled                  bool                 `json:"ssoForMacOsSelfServiceEnabled"`
}

SsoSettingsV3 represents a sso settings v3.

type SsoSettingsV3ConfigurationType 

type SsoSettingsV3ConfigurationType = string

SsoSettingsV3ConfigurationType is the set of values accepted by SsoSettingsV3.ConfigurationType. 

const (
	SsoSettingsV3ConfigurationTypeSaml         SsoSettingsV3ConfigurationType = "SAML"
	SsoSettingsV3ConfigurationTypeOidc         SsoSettingsV3ConfigurationType = "OIDC"
	SsoSettingsV3ConfigurationTypeOidcWithSaml SsoSettingsV3ConfigurationType = "OIDC_WITH_SAML"
)

SsoSettingsV3ConfigurationType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func SsoSettingsV3ConfigurationTypeValues 

func SsoSettingsV3ConfigurationTypeValues() []SsoSettingsV3ConfigurationType

SsoSettingsV3ConfigurationTypeValues returns every value the Jamf API accepts for SsoSettingsV3ConfigurationType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type StartupStatus 

type StartupStatus struct {
	Error *string `json:"error,omitempty"`
	// Allowed values: see the StartupStatusErrorCode constants.
	ErrorCode               *string `json:"errorCode,omitempty"`
	Percentage              int     `json:"percentage"`
	SetupAssistantNecessary bool    `json:"setupAssistantNecessary"`
	Step                    string  `json:"step"`
	// Allowed values: see the StartupStatusStepCode constants.
	StepCode  string  `json:"stepCode"`
	StepParam *string `json:"stepParam,omitempty"`
	Warning   *string `json:"warning,omitempty"`
	// Allowed values: see the StartupStatusWarningCode constants.
	WarningCode  *string `json:"warningCode,omitempty"`
	WarningParam *string `json:"warningParam,omitempty"`
}

StartupStatus represents a startup status.

type StartupStatusErrorCode 

type StartupStatusErrorCode = string

StartupStatusErrorCode is the set of values accepted by StartupStatus.ErrorCode. 

const (
	StartupStatusErrorCodeCacheConfigurationError         StartupStatusErrorCode = "CACHE_CONFIGURATION_ERROR"
	StartupStatusErrorCodeSecondaryNodeStartupError       StartupStatusErrorCode = "SECONDARY_NODE_STARTUP_ERROR"
	StartupStatusErrorCodeMoreThanOneClusterSettingsError StartupStatusErrorCode = "MORE_THAN_ONE_CLUSTER_SETTINGS_ERROR"
	StartupStatusErrorCodePrimaryNodeNotSetError          StartupStatusErrorCode = "PRIMARY_NODE_NOT_SET_ERROR"
	StartupStatusErrorCodeDatabaseError                   StartupStatusErrorCode = "DATABASE_ERROR"
	StartupStatusErrorCodeDatabasePasswordMissing         StartupStatusErrorCode = "DATABASE_PASSWORD_MISSING"
	StartupStatusErrorCodeEhcacheError                    StartupStatusErrorCode = "EHCACHE_ERROR"
	StartupStatusErrorCodeFlagInitializationFailed        StartupStatusErrorCode = "FLAG_INITIALIZATION_FAILED"
	StartupStatusErrorCodeMemcachedError                  StartupStatusErrorCode = "MEMCACHED_ERROR"
	StartupStatusErrorCodeDatabaseMyisamError             StartupStatusErrorCode = "DATABASE_MYISAM_ERROR"
	StartupStatusErrorCodeOldVersionError                 StartupStatusErrorCode = "OLD_VERSION_ERROR"
)

StartupStatusErrorCode values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func StartupStatusErrorCodeValues 

func StartupStatusErrorCodeValues() []StartupStatusErrorCode

StartupStatusErrorCodeValues returns every value the Jamf API accepts for StartupStatusErrorCode, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type StartupStatusStepCode 

type StartupStatusStepCode = string

StartupStatusStepCode is the set of values accepted by StartupStatus.StepCode. 

const (
	StartupStatusStepCodeServerInitStart                           StartupStatusStepCode = "SERVER_INIT_START"
	StartupStatusStepCodeServerInitAnalyzingWebapp                 StartupStatusStepCode = "SERVER_INIT_ANALYZING_WEBAPP"
	StartupStatusStepCodeServerInitPopulatingNavigation            StartupStatusStepCode = "SERVER_INIT_POPULATING_NAVIGATION"
	StartupStatusStepCodeServerInitPopulatingObjects               StartupStatusStepCode = "SERVER_INIT_POPULATING_OBJECTS"
	StartupStatusStepCodeServerInitInitializingObj                 StartupStatusStepCode = "SERVER_INIT_INITIALIZING_OBJ"
	StartupStatusStepCodeServerInitVerifyingCache                  StartupStatusStepCode = "SERVER_INIT_VERIFYING_CACHE"
	StartupStatusStepCodeServerInitInitializingChangeManagement    StartupStatusStepCode = "SERVER_INIT_INITIALIZING_CHANGE_MANAGEMENT"
	StartupStatusStepCodeServerInitInitializingCommunicationSystem StartupStatusStepCode = "SERVER_INIT_INITIALIZING_COMMUNICATION_SYSTEM"
	StartupStatusStepCodeServerInitInitializingMDMQueueMonitor     StartupStatusStepCode = "SERVER_INIT_INITIALIZING_MDM_QUEUE_MONITOR"
	StartupStatusStepCodeServerInitCalculatingSmartGroups          StartupStatusStepCode = "SERVER_INIT_CALCULATING_SMART_GROUPS"
	StartupStatusStepCodeServerInitDbSchemaCompare                 StartupStatusStepCode = "SERVER_INIT_DB_SCHEMA_COMPARE"
	StartupStatusStepCodeServerInitDbTableCheckForRename           StartupStatusStepCode = "SERVER_INIT_DB_TABLE_CHECK_FOR_RENAME"
	StartupStatusStepCodeServerInitDbTableAlter                    StartupStatusStepCode = "SERVER_INIT_DB_TABLE_ALTER"
	StartupStatusStepCodeServerInitDbTableAnalyzing                StartupStatusStepCode = "SERVER_INIT_DB_TABLE_ANALYZING"
	StartupStatusStepCodeServerInitDbTableCreate                   StartupStatusStepCode = "SERVER_INIT_DB_TABLE_CREATE"
	StartupStatusStepCodeServerInitDbTableDrop                     StartupStatusStepCode = "SERVER_INIT_DB_TABLE_DROP"
	StartupStatusStepCodeServerInitDbTableRename                   StartupStatusStepCode = "SERVER_INIT_DB_TABLE_RENAME"
	StartupStatusStepCodeServerInitDbColumnRename                  StartupStatusStepCode = "SERVER_INIT_DB_COLUMN_RENAME"
	StartupStatusStepCodeServerInitDbColumnEncodingChangeStep1     StartupStatusStepCode = "SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_1"
	StartupStatusStepCodeServerInitDbColumnEncodingChangeStep2     StartupStatusStepCode = "SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_2"
	StartupStatusStepCodeServerInitDbColumnEncodingChangeStep3     StartupStatusStepCode = "SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_3"
	StartupStatusStepCodeServerInitDbUpgradeCheck                  StartupStatusStepCode = "SERVER_INIT_DB_UPGRADE_CHECK"
	StartupStatusStepCodeServerInitDbUpgradeComplete               StartupStatusStepCode = "SERVER_INIT_DB_UPGRADE_COMPLETE"
	StartupStatusStepCodeServerInitSsGenerateNotifications         StartupStatusStepCode = "SERVER_INIT_SS_GENERATE_NOTIFICATIONS"
	StartupStatusStepCodeServerInitSsGenerateNotificationsStatus   StartupStatusStepCode = "SERVER_INIT_SS_GENERATE_NOTIFICATIONS_STATUS"
	StartupStatusStepCodeServerInitSsGenerateNotificationsFinalize StartupStatusStepCode = "SERVER_INIT_SS_GENERATE_NOTIFICATIONS_FINALIZE"
	StartupStatusStepCodeServerInitPkiMigrationDone                StartupStatusStepCode = "SERVER_INIT_PKI_MIGRATION_DONE"
	StartupStatusStepCodeServerInitPkiMigrationStatus              StartupStatusStepCode = "SERVER_INIT_PKI_MIGRATION_STATUS"
	StartupStatusStepCodeServerInitMemcachedEndpointsCheck         StartupStatusStepCode = "SERVER_INIT_MEMCACHED_ENDPOINTS_CHECK"
	StartupStatusStepCodeServerInitCacheFlushing                   StartupStatusStepCode = "SERVER_INIT_CACHE_FLUSHING"
	StartupStatusStepCodeServerInitComplete                        StartupStatusStepCode = "SERVER_INIT_COMPLETE"
)

StartupStatusStepCode values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func StartupStatusStepCodeValues 

func StartupStatusStepCodeValues() []StartupStatusStepCode

StartupStatusStepCodeValues returns every value the Jamf API accepts for StartupStatusStepCode, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type StartupStatusWarningCode 

type StartupStatusWarningCode = string

StartupStatusWarningCode is the set of values accepted by StartupStatus.WarningCode. 

const (
	StartupStatusWarningCodeServerInitWarningDbTableEncoding StartupStatusWarningCode = "SERVER_INIT_WARNING_DB_TABLE_ENCODING"
)

StartupStatusWarningCode values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func StartupStatusWarningCodeValues 

func StartupStatusWarningCodeValues() []StartupStatusWarningCode

StartupStatusWarningCodeValues returns every value the Jamf API accepts for StartupStatusWarningCode, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type StaticComputerGroup 

type StaticComputerGroup struct {
	Description *string `json:"description,omitempty"`
	ID          string  `json:"id"`
	Name        string  `json:"name"`
	SiteID      *string `json:"siteId,omitempty"`
}

StaticComputerGroup represents a static computer group.

type StaticComputerGroupAssignment 

type StaticComputerGroupAssignment struct {
	// Set of computer IDs to assign to the static group.
	Assignments *[]string `json:"assignments,omitempty"`
	Description *string   `json:"description,omitempty"`
	ID          *string   `json:"id,omitempty"`
	Name        string    `json:"name"`
	SiteID      *string   `json:"siteId,omitempty"`
}

StaticComputerGroupAssignment represents a static computer group assignment.

type StaticComputerGroupSearchResults 

type StaticComputerGroupSearchResults struct {
	Results    []StaticComputerGroupSummary `json:"results"`
	TotalCount int                          `json:"totalCount"`
}

StaticComputerGroupSearchResults represents a static computer group search results.

type StaticComputerGroupSummary 

type StaticComputerGroupSummary struct {
	Count       int     `json:"count"`
	Description *string `json:"description,omitempty"`
	ID          string  `json:"id"`
	Name        string  `json:"name"`
	SiteID      *string `json:"siteId,omitempty"`
}

StaticComputerGroupSummary represents a static computer group summary.

type StaticGroup 

type StaticGroup struct {
	// membership count.
	Count            int    `json:"count"`
	GroupDescription string `json:"groupDescription"`
	GroupID          string `json:"groupId"`
	GroupName        string `json:"groupName"`
	SiteID           string `json:"siteId"`
}

StaticGroup represents a static group.

type StaticGroupAssignment 

type StaticGroupAssignment struct {
	Assignments      *[]Assignment `json:"assignments,omitempty"`
	GroupDescription *string       `json:"groupDescription,omitempty"`
	GroupID          *string       `json:"groupId,omitempty"`
	GroupName        string        `json:"groupName"`
	SiteID           *string       `json:"siteId,omitempty"`
}

StaticGroupAssignment represents a static group assignment.

type StaticGroupSearchResults 

type StaticGroupSearchResults struct {
	Results    []StaticGroup `json:"results"`
	TotalCount int           `json:"totalCount"`
}

StaticGroupSearchResults represents a static group search results.

type StaticUserGroup 

type StaticUserGroup struct {
	Description string `json:"description"`
	ID          int    `json:"id"`
	Name        string `json:"name"`
}

StaticUserGroup represents a static user group.

type StatusItem 

type StatusItem struct {
	// The StatusItem key.
	Key string `json:"key"`
	// The local server time when the StatusItem was last updated.
	LastUpdateTime string `json:"lastUpdateTime"`
	// The StatusItem value.
	Value string `json:"value"`
}

StatusItem represents a status item.

type StatusItems 

type StatusItems struct {
	StatusItems []StatusItem `json:"statusItems"`
}

StatusItems represents a status items.

type SupervisionIdentity 

type SupervisionIdentity struct {
	CommonName     string `json:"commonName"`
	DisplayName    string `json:"displayName"`
	ExpirationDate string `json:"expirationDate"`
	ID             int    `json:"id"`
}

SupervisionIdentity represents a supervision identity.

type SupervisionIdentityCertificateUpload 

type SupervisionIdentityCertificateUpload struct {
	// The base 64 encoded supervision identity certificate data.
	CertificateData *[]byte `json:"certificateData,omitempty"`
	DisplayName     string  `json:"displayName"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
}

SupervisionIdentityCertificateUpload represents a supervision identity certificate upload.

type SupervisionIdentityCreate 

type SupervisionIdentityCreate struct {
	DisplayName string `json:"displayName"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	Password string `json:"password"`
}

SupervisionIdentityCreate represents a supervision identity create.

type SupervisionIdentitySearchResults 

type SupervisionIdentitySearchResults struct {
	Results    []SupervisionIdentity `json:"results"`
	TotalCount int                   `json:"totalCount"`
}

SupervisionIdentitySearchResults represents a supervision identity search results.

type SupervisionIdentityUpdate 

type SupervisionIdentityUpdate struct {
	DisplayName string `json:"displayName"`
}

SupervisionIdentityUpdate represents a supervision identity update.

type SystemHealthV2 

type SystemHealthV2 struct {
	Baseband      string `json:"baseband"`
	Camera        string `json:"camera"`
	Display       string `json:"display"`
	FaceID        string `json:"faceId"`
	Nfc           string `json:"nfc"`
	TouchID       string `json:"touchId"`
	UltraWideband string `json:"ultraWideband"`
}

SystemHealthV2 System health status for device components. Reported for iOS devices.

type TeacherFeatures 

type TeacherFeatures struct {
	IsAllowAppLock         bool `json:"isAllowAppLock"`
	IsAllowAttentionScreen bool `json:"isAllowAttentionScreen"`
	IsAllowClearPasscode   bool `json:"isAllowClearPasscode"`
	IsAllowRestrictions    bool `json:"isAllowRestrictions"`
	IsAllowWebLock         bool `json:"isAllowWebLock"`
}

TeacherFeatures represents a teacher features.

type TeacherSettingsRequest 

type TeacherSettingsRequest struct {
	AutoClear                   *string          `json:"autoClear,omitempty"`
	IsEnabled                   *bool            `json:"isEnabled,omitempty"`
	MaxRestrictionLengthSeconds *int             `json:"maxRestrictionLengthSeconds,omitempty"`
	SafelistedApps              *[]SafelistedApp `json:"safelistedApps,omitempty"`
	TimezoneID                  *string          `json:"timezoneId,omitempty"`
}

TeacherSettingsRequest represents a teacher settings request.

type TeacherSettingsResponse 

type TeacherSettingsResponse struct {
	AutoClear                   string           `json:"autoClear"`
	DisplayNameType             string           `json:"displayNameType"`
	Features                    *TeacherFeatures `json:"features,omitempty"`
	IsEnabled                   bool             `json:"isEnabled"`
	MaxRestrictionLengthSeconds int              `json:"maxRestrictionLengthSeconds"`
	SafelistedApps              []SafelistedApp  `json:"safelistedApps"`
	TimezoneID                  string           `json:"timezoneId"`
}

TeacherSettingsResponse represents a teacher settings response.

type TimeFrame 

type TimeFrame struct {
	BeginTime *string `json:"beginTime,omitempty"`
	EndTime   *string `json:"endTime,omitempty"`
}

TimeFrame represents a time frame.

type TimeZone 

type TimeZone struct {
	DisplayName string `json:"displayName"`
	// Allowed values: see the TimeZoneRegion constants.
	Region string `json:"region"`
	ZoneID string `json:"zoneId"`
}

TimeZone represents a time zone.

type TimeZoneRegion 

type TimeZoneRegion = string

TimeZoneRegion is the set of values accepted by TimeZone.Region. 

const (
	TimeZoneRegionAfrica    TimeZoneRegion = "Africa"
	TimeZoneRegionAmerica   TimeZoneRegion = "America"
	TimeZoneRegionAsia      TimeZoneRegion = "Asia"
	TimeZoneRegionAtlantic  TimeZoneRegion = "Atlantic"
	TimeZoneRegionAustralia TimeZoneRegion = "Australia"
	TimeZoneRegionEurope    TimeZoneRegion = "Europe"
	TimeZoneRegionIndian    TimeZoneRegion = "Indian"
	TimeZoneRegionPacific   TimeZoneRegion = "Pacific"
	TimeZoneRegionNone      TimeZoneRegion = "None"
)

TimeZoneRegion values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func TimeZoneRegionValues 

func TimeZoneRegionValues() []TimeZoneRegion

TimeZoneRegionValues returns every value the Jamf API accepts for TimeZoneRegion, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type TvOsDetails 

type TvOsDetails struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	AirplayPassword       string                      `json:"airplayPassword"`
	Applications          []MobileDeviceApplication   `json:"applications"`
	Certificates          []MobileDeviceCertificateV2 `json:"certificates"`
	ConfigurationProfiles []ConfigurationProfile      `json:"configurationProfiles"`
	DeviceID              string                      `json:"deviceId"`
	Locales               string                      `json:"locales"`
	Model                 string                      `json:"model"`
	ModelIdentifier       string                      `json:"modelIdentifier"`
	ModelNumber           string                      `json:"modelNumber"`
	Purchasing            *PurchasingV2               `json:"purchasing,omitempty"`
	Supervised            bool                        `json:"supervised"`
}

TvOsDetails will be populated if the type is appleTv.

type Udids 

type Udids struct {
	Udids *[]string `json:"udids,omitempty"`
}

Udids represents a udids.

type UnifiedSmartGroupCriteriaV2 

type UnifiedSmartGroupCriteriaV2 struct {
	// Whether this criterion should be ANDed or ORed with the previous criterion. Only "and" or "or"
	// values are accepted (case-insensitive).
	// Allowed values: see the UnifiedSmartGroupCriteriaV2AndOr constants.
	AndOr string `json:"andOr"`
	// Whether to add a closing parenthesis after this criterion.
	ClosingParen *bool `json:"closingParen,omitempty"`
	// The field to search on (e.g., Model, OS Version, etc.).
	Name string `json:"name"`
	// Whether to add an opening parenthesis before this criterion.
	OpeningParen *bool `json:"openingParen,omitempty"`
	// The priority order of this criterion.
	Priority int `json:"priority"`
	// The type of search to perform (e.g., is, is not, like, etc.).
	SearchType string `json:"searchType"`
	// The value to search for.
	Value string `json:"value"`
}

UnifiedSmartGroupCriteriaV2 V2 criteria format with strict enum validation for andOr field. Only "and" or "or" values are accepted (case-insensitive).

type UnifiedSmartGroupCriteriaV2AndOr 

type UnifiedSmartGroupCriteriaV2AndOr = string

UnifiedSmartGroupCriteriaV2AndOr is the set of values accepted by UnifiedSmartGroupCriteriaV2.AndOr. 

const (
	UnifiedSmartGroupCriteriaV2AndOrAnd UnifiedSmartGroupCriteriaV2AndOr = "and"
	UnifiedSmartGroupCriteriaV2AndOrOr  UnifiedSmartGroupCriteriaV2AndOr = "or"
)

UnifiedSmartGroupCriteriaV2AndOr values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UnifiedSmartGroupCriteriaV2AndOrValues 

func UnifiedSmartGroupCriteriaV2AndOrValues() []UnifiedSmartGroupCriteriaV2AndOr

UnifiedSmartGroupCriteriaV2AndOrValues returns every value the Jamf API accepts for UnifiedSmartGroupCriteriaV2AndOr, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UnmanageMobileDeviceResponse 

type UnmanageMobileDeviceResponse struct {
	// Uuid of the command queued that removes the MDM profile.
	CommandUUID string `json:"commandUuid"`
	// Id of the mobile device whose MDM profile was removed.
	DeviceID string `json:"deviceId"`
}

UnmanageMobileDeviceResponse represents a unmanage mobile device response.

type UpdateIosV2 

type UpdateIosV2 struct {
	Purchasing *PurchasingV2 `json:"purchasing,omitempty"`
}

UpdateIosV2 represents a update ios v2.

type UpdateMobileDeviceV2 

type UpdateMobileDeviceV2 struct {
	AssetTag *string `json:"assetTag,omitempty"`
	// Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the
	// Mobile Device Name to the ‘name’ value each time the device checks in.
	EnforceName *bool        `json:"enforceName,omitempty"`
	Ios         *UpdateIosV2 `json:"ios,omitempty"`
	Location    *LocationV2  `json:"location,omitempty"`
	// Mobile Device Name. When updated, Jamf Pro sends an MDM settings command to the device (device must
	// be supervised).
	Name   *string `json:"name,omitempty"`
	SiteID *string `json:"siteId,omitempty"`
	// IANA time zone database name.
	TimeZone                   *string                 `json:"timeZone,omitempty"`
	Tvos                       *UpdateTvOs             `json:"tvos,omitempty"`
	UpdatedExtensionAttributes *[]ExtensionAttributeV2 `json:"updatedExtensionAttributes,omitempty"`
}

UpdateMobileDeviceV2 represents a update mobile device v2.

type UpdateTvOs 

type UpdateTvOs struct {
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	AirplayPassword *string       `json:"airplayPassword,omitempty"`
	Purchasing      *PurchasingV2 `json:"purchasing,omitempty"`
}

UpdateTvOs represents a update tv os.

type User 

type User struct {
	CustomPhotoURL       string  `json:"customPhotoUrl"`
	Email                string  `json:"email"`
	EnableCustomPhotoURL bool    `json:"enableCustomPhotoUrl"`
	ID                   string  `json:"id"`
	ManagedAppleID       string  `json:"managedAppleId"`
	Phone                *string `json:"phone,omitempty"`
	Position             *string `json:"position,omitempty"`
	Realname             string  `json:"realname"`
	Username             string  `json:"username"`
}

User represents a user.

type UserAccount 

type UserAccount struct {
	// Access level for the account.
	// Allowed values: see the UserAccountAccessLevel constants.
	AccessLevel *string `json:"accessLevel,omitempty"`
	// Status of the account.
	// Allowed values: see the UserAccountAccountStatus constants.
	AccountStatus *string `json:"accountStatus,omitempty"`
	// Type of the account.
	// Allowed values: see the UserAccountAccountType constants.
	AccountType               *string `json:"accountType,omitempty"`
	ChangePasswordOnNextLogin *bool   `json:"changePasswordOnNextLogin,omitempty"`
	DistinguishedName         *string `json:"distinguishedName,omitempty"`
	Email                     *string `json:"email,omitempty"`
	FailedLoginAttempts       *int    `json:"failedLoginAttempts,omitempty"`
	ID                        *string `json:"id,omitempty"`
	LastPasswordChange        *string `json:"lastPasswordChange"`
	LdapServerID              *int    `json:"ldapServerId,omitempty"`
	Phone                     *string `json:"phone,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	PlainPassword *string `json:"plainPassword,omitempty"`
	// Privilege level for the account.
	// Allowed values: see the UserAccountPrivilegeLevel constants.
	PrivilegeLevel *string `json:"privilegeLevel,omitempty"`
	Realname       *string `json:"realname,omitempty"`
	SiteID         *int    `json:"siteId,omitempty"`
	Username       *string `json:"username,omitempty"`
}

UserAccount represents a user account.

type UserAccountAccessLevel 

type UserAccountAccessLevel = string

UserAccountAccessLevel is the set of values accepted by UserAccount.AccessLevel. 

const (
	UserAccountAccessLevelFullAccess       UserAccountAccessLevel = "FullAccess"
	UserAccountAccessLevelSiteAccess       UserAccountAccessLevel = "SiteAccess"
	UserAccountAccessLevelGroupBasedAccess UserAccountAccessLevel = "GroupBasedAccess"
)

UserAccountAccessLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UserAccountAccessLevelValues 

func UserAccountAccessLevelValues() []UserAccountAccessLevel

UserAccountAccessLevelValues returns every value the Jamf API accepts for UserAccountAccessLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UserAccountAccountStatus 

type UserAccountAccountStatus = string

UserAccountAccountStatus is the set of values accepted by UserAccount.AccountStatus. 

const (
	UserAccountAccountStatusEnabled  UserAccountAccountStatus = "Enabled"
	UserAccountAccountStatusDisabled UserAccountAccountStatus = "Disabled"
)

UserAccountAccountStatus values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UserAccountAccountStatusValues 

func UserAccountAccountStatusValues() []UserAccountAccountStatus

UserAccountAccountStatusValues returns every value the Jamf API accepts for UserAccountAccountStatus, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UserAccountAccountType 

type UserAccountAccountType = string

UserAccountAccountType is the set of values accepted by UserAccount.AccountType. 

const (
	UserAccountAccountTypeDefault   UserAccountAccountType = "DEFAULT"
	UserAccountAccountTypeFederated UserAccountAccountType = "FEDERATED"
	UserAccountAccountTypeMigrated  UserAccountAccountType = "MIGRATED"
)

UserAccountAccountType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UserAccountAccountTypeValues 

func UserAccountAccountTypeValues() []UserAccountAccountType

UserAccountAccountTypeValues returns every value the Jamf API accepts for UserAccountAccountType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UserAccountPrivilegeLevel 

type UserAccountPrivilegeLevel = string

UserAccountPrivilegeLevel is the set of values accepted by UserAccount.PrivilegeLevel. 

const (
	UserAccountPrivilegeLevelAdministrator UserAccountPrivilegeLevel = "ADMINISTRATOR"
	UserAccountPrivilegeLevelAuditor       UserAccountPrivilegeLevel = "AUDITOR"
	UserAccountPrivilegeLevelEnrollment    UserAccountPrivilegeLevel = "ENROLLMENT"
	UserAccountPrivilegeLevelCustom        UserAccountPrivilegeLevel = "CUSTOM"
)

UserAccountPrivilegeLevel values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UserAccountPrivilegeLevelValues 

func UserAccountPrivilegeLevelValues() []UserAccountPrivilegeLevel

UserAccountPrivilegeLevelValues returns every value the Jamf API accepts for UserAccountPrivilegeLevel, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UserAccountSearchResults 

type UserAccountSearchResults struct {
	// The collection of user accounts for the requested page.
	Results []UserAccount `json:"results"`
	// Total number of user accounts matching the filter criteria.
	TotalCount int `json:"totalCount"`
}

UserAccountSearchResults represents a user account search results.

type UserInventory 

type UserInventory struct {
	CustomPhotoURL       *string `json:"customPhotoUrl,omitempty"`
	Email                *string `json:"email,omitempty"`
	EnableCustomPhotoURL *bool   `json:"enableCustomPhotoUrl,omitempty"`
	ManagedAppleID       *string `json:"managedAppleId,omitempty"`
	Phone                *string `json:"phone,omitempty"`
	Position             *string `json:"position,omitempty"`
	Realname             *string `json:"realname,omitempty"`
	Username             *string `json:"username,omitempty"`
}

UserInventory represents a user inventory.

type UserMappings 

type UserMappings struct {
	AdditionalSearchBase *string `json:"additionalSearchBase,omitempty"`
	Building             string  `json:"building"`
	Department           string  `json:"department"`
	EmailAddress         string  `json:"emailAddress"`
	// Allowed values: see the UserMappingsObjectClassLimitation constants.
	ObjectClassLimitation string `json:"objectClassLimitation"`
	ObjectClasses         string `json:"objectClasses"`
	Phone                 string `json:"phone"`
	Position              string `json:"position"`
	RealName              string `json:"realName"`
	Room                  string `json:"room"`
	SearchBase            string `json:"searchBase"`
	// Allowed values: see the UserMappingsSearchScope constants.
	SearchScope string `json:"searchScope"`
	UserID      string `json:"userID"`
	UserUUID    string `json:"userUuid"`
	Username    string `json:"username"`
}

UserMappings Cloud Identity Provider user mappings configuration.

type UserMappingsObjectClassLimitation 

type UserMappingsObjectClassLimitation = string

UserMappingsObjectClassLimitation is the set of values accepted by UserMappings.ObjectClassLimitation. 

const (
	UserMappingsObjectClassLimitationAnyObjectClasses UserMappingsObjectClassLimitation = "ANY_OBJECT_CLASSES"
	UserMappingsObjectClassLimitationAllObjectClasses UserMappingsObjectClassLimitation = "ALL_OBJECT_CLASSES"
)

UserMappingsObjectClassLimitation values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UserMappingsObjectClassLimitationValues 

func UserMappingsObjectClassLimitationValues() []UserMappingsObjectClassLimitation

UserMappingsObjectClassLimitationValues returns every value the Jamf API accepts for UserMappingsObjectClassLimitation, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UserMappingsSearchScope 

type UserMappingsSearchScope = string

UserMappingsSearchScope is the set of values accepted by UserMappings.SearchScope. 

const (
	UserMappingsSearchScopeAllSubtrees    UserMappingsSearchScope = "ALL_SUBTREES"
	UserMappingsSearchScopeFirstLevelOnly UserMappingsSearchScope = "FIRST_LEVEL_ONLY"
)

UserMappingsSearchScope values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func UserMappingsSearchScopeValues 

func UserMappingsSearchScopeValues() []UserMappingsSearchScope

UserMappingsSearchScopeValues returns every value the Jamf API accepts for UserMappingsSearchScope, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type UserPreferencesJson 

type UserPreferencesJson = json.RawMessage

UserPreferencesJson valid JSON of any client-desired structure.

type UserPreferencesSettings 

type UserPreferencesSettings struct {
	Key      string `json:"key"`
	Username string `json:"username"`
	// List of preferences for the specific key and user.
	Values []string `json:"values"`
}

UserPreferencesSettings Response object.

type UserTestAttributes 

type UserTestAttributes struct {
	BuildingName   string `json:"buildingName"`
	DepartmentName string `json:"departmentName"`
	EmailAddress   string `json:"emailAddress"`
	FullName       string `json:"fullName"`
	PhoneNumber    string `json:"phoneNumber"`
	Position       string `json:"position"`
	Room           string `json:"room"`
}

UserTestAttributes represents a user test attributes.

type UserTestSearch 

type UserTestSearch struct {
	Attributes        *UserTestAttributes `json:"attributes,omitempty"`
	DistinguishedName string              `json:"distinguishedName"`
	ID                string              `json:"id"`
	Name              string              `json:"name"`
	ServerID          string              `json:"serverId"`
	UUID              string              `json:"uuid"`
}

UserTestSearch represents a user test search.

type UserTestSearchRequest 

type UserTestSearchRequest struct {
	Username string `json:"username"`
}

UserTestSearchRequest represents a user test search request.

type UserTestSearchResponse 

type UserTestSearchResponse struct {
	Results    []UserTestSearch `json:"results"`
	TotalCount int              `json:"totalCount"`
}

UserTestSearchResponse represents a user test search response.

type V1Site 

type V1Site struct {
	// Platform division identifier (UUID) for this site.
	DivisionID *string `json:"divisionId,omitempty"`
	ID         string  `json:"id"`
	Name       string  `json:"name"`
}

V1Site represents a v1 site.

type V1SiteBase 

type V1SiteBase struct {
	// Platform division identifier (UUID) for this site.
	DivisionID *string `json:"divisionId,omitempty"`
	ID         string  `json:"id"`
	Name       string  `json:"name"`
}

V1SiteBase represents a v1 site base.

type VenafiCaRecord 

type VenafiCaRecord struct {
	ClientID     *string `json:"clientId,omitempty"`
	ID           *int    `json:"id,omitempty"`
	Name         string  `json:"name"`
	ProxyAddress *string `json:"proxyAddress,omitempty"`
	// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
	// can supply a value on update.
	RefreshToken           *string `json:"refreshToken,omitempty"`
	RefreshTokenConfigured *bool   `json:"refreshTokenConfigured,omitempty"`
	RevocationEnabled      *bool   `json:"revocationEnabled,omitempty"`
}

VenafiCaRecord represents a venafi ca record.

type VenafiPkiPayloadRecord 

type VenafiPkiPayloadRecord struct {
	Name    string `json:"name"`
	URLPath string `json:"urlPath"`
}

VenafiPkiPayloadRecord represents a venafi pki payload record.

type VenafiPkiPayloadRecordSearchResults 

type VenafiPkiPayloadRecordSearchResults struct {
	Results    []VenafiPkiPayloadRecord `json:"results"`
	TotalCount int                      `json:"totalCount"`
}

VenafiPkiPayloadRecordSearchResults represents a venafi pki payload record search results.

type VenafiServiceStatus 

type VenafiServiceStatus struct {
	Status string `json:"status"`
}

VenafiServiceStatus represents a venafi service status.

type VerbosePackageDeploymentResponse 

type VerbosePackageDeploymentResponse struct {
	Errors         []VerbosePackageDeploymentResponseErrorsItem         `json:"errors"`
	QueuedCommands []VerbosePackageDeploymentResponseQueuedCommandsItem `json:"queuedCommands"`
}

VerbosePackageDeploymentResponse represents a verbose package deployment response.

type VerbosePackageDeploymentResponseErrorsItem 

type VerbosePackageDeploymentResponseErrorsItem struct {
	Device int    `json:"device"`
	Group  int    `json:"group"`
	Reason string `json:"reason"`
}

VerbosePackageDeploymentResponseErrorsItem The error will contain either the 'device' or 'group' property.

type VerbosePackageDeploymentResponseQueuedCommandsItem 

type VerbosePackageDeploymentResponseQueuedCommandsItem struct {
	CommandUUID string `json:"commandUuid"`
	Device      int    `json:"device"`
}

VerbosePackageDeploymentResponseQueuedCommandsItem represents a verbose package deployment response queued commands item.

type VolumePurchasingContent 

type VolumePurchasingContent struct {
	AdamID string `json:"adamId"`
	// Allowed values: see the VolumePurchasingContentContentType constants.
	ContentType string `json:"contentType"`
	// Allowed values: see the VolumePurchasingContentDeviceTypes constants.
	DeviceTypes          []string `json:"deviceTypes"`
	IconURL              string   `json:"iconUrl"`
	LicenseCountInUse    int      `json:"licenseCountInUse"`
	LicenseCountReported int      `json:"licenseCountReported"`
	LicenseCountTotal    int      `json:"licenseCountTotal"`
	Name                 string   `json:"name"`
	// Allowed values: see the VolumePurchasingContentPricingParam constants.
	PricingParam string `json:"pricingParam"`
}

VolumePurchasingContent represents a volume purchasing content.

type VolumePurchasingContentContentType 

type VolumePurchasingContentContentType = string

VolumePurchasingContentContentType is the set of values accepted by VolumePurchasingContent.ContentType. 

const (
	VolumePurchasingContentContentTypeIosApp  VolumePurchasingContentContentType = "IOS_APP"
	VolumePurchasingContentContentTypeMacApp  VolumePurchasingContentContentType = "MAC_APP"
	VolumePurchasingContentContentTypeBook    VolumePurchasingContentContentType = "BOOK"
	VolumePurchasingContentContentTypeUnknown VolumePurchasingContentContentType = "UNKNOWN"
)

VolumePurchasingContentContentType values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func VolumePurchasingContentContentTypeValues 

func VolumePurchasingContentContentTypeValues() []VolumePurchasingContentContentType

VolumePurchasingContentContentTypeValues returns every value the Jamf API accepts for VolumePurchasingContentContentType, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type VolumePurchasingContentDeviceTypes 

type VolumePurchasingContentDeviceTypes = string

VolumePurchasingContentDeviceTypes is the set of values accepted by VolumePurchasingContent.DeviceTypes. 

const (
	VolumePurchasingContentDeviceTypesIos   VolumePurchasingContentDeviceTypes = "IOS"
	VolumePurchasingContentDeviceTypesMacos VolumePurchasingContentDeviceTypes = "MACOS"
	VolumePurchasingContentDeviceTypesTvos  VolumePurchasingContentDeviceTypes = "TVOS"
)

VolumePurchasingContentDeviceTypes values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func VolumePurchasingContentDeviceTypesValues 

func VolumePurchasingContentDeviceTypesValues() []VolumePurchasingContentDeviceTypes

VolumePurchasingContentDeviceTypesValues returns every value the Jamf API accepts for VolumePurchasingContentDeviceTypes, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type VolumePurchasingContentList 

type VolumePurchasingContentList struct {
	Results    []VolumePurchasingContent `json:"results"`
	TotalCount int                       `json:"totalCount"`
}

VolumePurchasingContentList represents a volume purchasing content list.

type VolumePurchasingContentPricingParam 

type VolumePurchasingContentPricingParam = string

VolumePurchasingContentPricingParam is the set of values accepted by VolumePurchasingContent.PricingParam. 

const (
	VolumePurchasingContentPricingParamStdq    VolumePurchasingContentPricingParam = "STDQ"
	VolumePurchasingContentPricingParamPlus    VolumePurchasingContentPricingParam = "PLUS"
	VolumePurchasingContentPricingParamUnknown VolumePurchasingContentPricingParam = "Unknown"
)

VolumePurchasingContentPricingParam values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func VolumePurchasingContentPricingParamValues 

func VolumePurchasingContentPricingParamValues() []VolumePurchasingContentPricingParam

VolumePurchasingContentPricingParamValues returns every value the Jamf API accepts for VolumePurchasingContentPricingParam, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type VolumePurchasingLocation 

type VolumePurchasingLocation struct {
	AppleID                               string `json:"appleId"`
	AutoRegisterManagedUsers              bool   `json:"autoRegisterManagedUsers"`
	AutomaticallyPopulatePurchasedContent bool   `json:"automaticallyPopulatePurchasedContent"`
	// If this is "true", the clientContext used by this server does not match the clientContext returned
	// by the Volume Purchasing API.
	ClientContextMismatch bool                      `json:"clientContextMismatch"`
	Content               []VolumePurchasingContent `json:"content"`
	// The two-letter ISO 3166-1 code that designates the country where the Volume Purchasing account is
	// located.
	CountryCode                          string `json:"countryCode"`
	Email                                string `json:"email"`
	ID                                   string `json:"id"`
	LastSyncTime                         string `json:"lastSyncTime"`
	LocationName                         string `json:"locationName"`
	Name                                 string `json:"name"`
	OrganizationName                     string `json:"organizationName"`
	SendNotificationWhenNoLongerAssigned bool   `json:"sendNotificationWhenNoLongerAssigned"`
	SiteID                               string `json:"siteId"`
	SiteName                             string `json:"siteName"`
	TokenExpiration                      string `json:"tokenExpiration"`
	TotalPurchasedLicenses               int    `json:"totalPurchasedLicenses"`
	TotalUsedLicenses                    int    `json:"totalUsedLicenses"`
}

VolumePurchasingLocation represents a volume purchasing location.

type VolumePurchasingLocationListView 

type VolumePurchasingLocationListView struct {
	AppleID                               string `json:"appleId"`
	AutoRegisterManagedUsers              bool   `json:"autoRegisterManagedUsers"`
	AutomaticallyPopulatePurchasedContent bool   `json:"automaticallyPopulatePurchasedContent"`
	// If this is "true", the clientContext used by this server does not match the clientContext returned
	// by the Volume Purchasing API.
	ClientContextMismatch bool `json:"clientContextMismatch"`
	// The two-letter ISO 3166-1 code that designates the country where the Volume Purchasing account is
	// located.
	CountryCode                          string `json:"countryCode"`
	Email                                string `json:"email"`
	ID                                   string `json:"id"`
	LastSyncTime                         string `json:"lastSyncTime"`
	LocationName                         string `json:"locationName"`
	Name                                 string `json:"name"`
	OrganizationName                     string `json:"organizationName"`
	SendNotificationWhenNoLongerAssigned bool   `json:"sendNotificationWhenNoLongerAssigned"`
	SiteID                               string `json:"siteId"`
	SiteName                             string `json:"siteName"`
	TokenExpiration                      string `json:"tokenExpiration"`
	TotalPurchasedLicenses               int    `json:"totalPurchasedLicenses"`
	TotalUsedLicenses                    int    `json:"totalUsedLicenses"`
}

VolumePurchasingLocationListView represents a volume purchasing location list view.

type VolumePurchasingLocationPatch 

type VolumePurchasingLocationPatch struct {
	AutoRegisterManagedUsers              *bool   `json:"autoRegisterManagedUsers,omitempty"`
	AutomaticallyPopulatePurchasedContent *bool   `json:"automaticallyPopulatePurchasedContent,omitempty"`
	Name                                  *string `json:"name,omitempty"`
	SendNotificationWhenNoLongerAssigned  *bool   `json:"sendNotificationWhenNoLongerAssigned,omitempty"`
	ServiceToken                          *string `json:"serviceToken,omitempty"`
	SiteID                                *string `json:"siteId,omitempty"`
}

VolumePurchasingLocationPatch represents a volume purchasing location patch.

type VolumePurchasingLocationPost 

type VolumePurchasingLocationPost struct {
	AutoRegisterManagedUsers              *bool `json:"autoRegisterManagedUsers,omitempty"`
	AutomaticallyPopulatePurchasedContent *bool `json:"automaticallyPopulatePurchasedContent,omitempty"`
	// If no value is provided when creating a VolumePurchasingLocation object, the 'name' will default to
	// the 'locationName' value.
	Name                                 *string `json:"name,omitempty"`
	SendNotificationWhenNoLongerAssigned *bool   `json:"sendNotificationWhenNoLongerAssigned,omitempty"`
	ServiceToken                         string  `json:"serviceToken"`
	SiteID                               *string `json:"siteId,omitempty"`
}

VolumePurchasingLocationPost represents a volume purchasing location post.

type VolumePurchasingLocations 

type VolumePurchasingLocations struct {
	Results    []VolumePurchasingLocationListView `json:"results"`
	TotalCount int                                `json:"totalCount"`
}

VolumePurchasingLocations represents a volume purchasing locations.

type VolumePurchasingSubscription 

type VolumePurchasingSubscription struct {
	Enabled            bool                `json:"enabled"`
	ExternalRecipients []ExternalRecipient `json:"externalRecipients"`
	ID                 string              `json:"id"`
	InternalRecipients []InternalRecipient `json:"internalRecipients"`
	LocationIds        []string            `json:"locationIds"`
	Name               string              `json:"name"`
	SiteID             string              `json:"siteId"`
	// Allowed values: see the VolumePurchasingSubscriptionTriggers constants.
	Triggers []string `json:"triggers"`
}

VolumePurchasingSubscription represents a volume purchasing subscription.

type VolumePurchasingSubscriptionBase 

type VolumePurchasingSubscriptionBase struct {
	Enabled            *bool                `json:"enabled,omitempty"`
	ExternalRecipients *[]ExternalRecipient `json:"externalRecipients,omitempty"`
	InternalRecipients *[]InternalRecipient `json:"internalRecipients,omitempty"`
	LocationIds        *[]string            `json:"locationIds,omitempty"`
	Name               string               `json:"name"`
	SiteID             *string              `json:"siteId,omitempty"`
	// Allowed values: see the VolumePurchasingSubscriptionBaseTriggers constants.
	Triggers *[]string `json:"triggers,omitempty"`
}

VolumePurchasingSubscriptionBase represents a volume purchasing subscription base.

type VolumePurchasingSubscriptionBaseTriggers 

type VolumePurchasingSubscriptionBaseTriggers = string

VolumePurchasingSubscriptionBaseTriggers is the set of values accepted by VolumePurchasingSubscriptionBase.Triggers. 

const (
	VolumePurchasingSubscriptionBaseTriggersNoMoreLicenses      VolumePurchasingSubscriptionBaseTriggers = "NO_MORE_LICENSES"
	VolumePurchasingSubscriptionBaseTriggersRemovedFromAppStore VolumePurchasingSubscriptionBaseTriggers = "REMOVED_FROM_APP_STORE"
)

VolumePurchasingSubscriptionBaseTriggers values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func VolumePurchasingSubscriptionBaseTriggersValues 

func VolumePurchasingSubscriptionBaseTriggersValues() []VolumePurchasingSubscriptionBaseTriggers

VolumePurchasingSubscriptionBaseTriggersValues returns every value the Jamf API accepts for VolumePurchasingSubscriptionBaseTriggers, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type VolumePurchasingSubscriptionTriggers 

type VolumePurchasingSubscriptionTriggers = string

VolumePurchasingSubscriptionTriggers is the set of values accepted by VolumePurchasingSubscription.Triggers. 

const (
	VolumePurchasingSubscriptionTriggersNoMoreLicenses      VolumePurchasingSubscriptionTriggers = "NO_MORE_LICENSES"
	VolumePurchasingSubscriptionTriggersRemovedFromAppStore VolumePurchasingSubscriptionTriggers = "REMOVED_FROM_APP_STORE"
)

VolumePurchasingSubscriptionTriggers values accepted by the Jamf API. The alias above is a string, so these constants pass to any parameter or field declared as a plain string.

func VolumePurchasingSubscriptionTriggersValues 

func VolumePurchasingSubscriptionTriggersValues() []VolumePurchasingSubscriptionTriggers

VolumePurchasingSubscriptionTriggersValues returns every value the Jamf API accepts for VolumePurchasingSubscriptionTriggers, in the order the spec declares them. Returns a fresh slice per call, so no caller can corrupt the set for the rest of the process — which a package level var would allow. Suits attribute validation (Terraform's stringvalidator.OneOf, say) and anything that needs to enumerate the set rather than name one member.

type VolumePurchasingSubscriptions 

type VolumePurchasingSubscriptions struct {
	Results    []VolumePurchasingSubscription `json:"results"`
	TotalCount int                            `json:"totalCount"`
}

VolumePurchasingSubscriptions represents a volume purchasing subscriptions.

type WatchOsDetailsV2 

type WatchOsDetailsV2 struct {
	Applications                []MobileDeviceApplication          `json:"applications"`
	Attachments                 []MobileDeviceAttachmentV2         `json:"attachments"`
	AvailableMb                 int                                `json:"availableMb"`
	BatteryLevel                int                                `json:"batteryLevel"`
	BleCapable                  bool                               `json:"bleCapable"`
	CapacityMb                  int                                `json:"capacityMb"`
	Certificates                []MobileDeviceCertificateV2        `json:"certificates"`
	ConfigurationProfiles       []ConfigurationProfile             `json:"configurationProfiles"`
	DeviceLocatorServiceEnabled bool                               `json:"deviceLocatorServiceEnabled"`
	DoNotDisturbEnabled         bool                               `json:"doNotDisturbEnabled"`
	ITunesStoreAccountActive    bool                               `json:"iTunesStoreAccountActive"`
	LastCloudBackupTimestamp    *time.Time                         `json:"lastCloudBackupTimestamp,omitempty"`
	Model                       string                             `json:"model"`
	ModelIdentifier             string                             `json:"modelIdentifier"`
	ModelNumber                 string                             `json:"modelNumber"`
	PercentageUsed              int                                `json:"percentageUsed"`
	ProvisioningProfiles        []MobileDeviceProvisioningProfiles `json:"provisioningProfiles"`
	Security                    *SecurityV2                        `json:"security,omitempty"`
	Supervised                  bool                               `json:"supervised"`
	UnlockToken                 string                             `json:"unlockToken"`
}

WatchOsDetailsV2 will be populated if the type is watchos.

type WellKnownSetting 

type WellKnownSetting struct {
	// Service discovery enrollment version.
	EnrollmentType ServiceDiscoveryVersion `json:"enrollmentType"`
	// Organization display name.
	OrgName *string `json:"orgName,omitempty"`
	// Server UUID identifier.
	ServerUUID string `json:"serverUuid"`
}

WellKnownSetting represents a well known setting.

type WellKnownSettingsRequest 

type WellKnownSettingsRequest struct {
	// Array of well-known settings to update.
	WellKnownSettings []WellKnownSetting `json:"wellKnownSettings"`
}

WellKnownSettingsRequest represents a well known settings request.

type WellKnownSettingsResponse 

type WellKnownSettingsResponse struct {
	// Array of well-known settings for all AxM organizations.
	WellKnownSettings []WellKnownSetting `json:"wellKnownSettings"`
}

WellKnownSettingsResponse represents a well known settings response.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.