Documentation ¶
Overview ¶
selfService.go
Index ¶
- type CSAToken
- type CertificateDetails
- type ClientCheckInHistoryResult
- type ComplianceVendorDeviceInformation
- type ComputerAppUsageDetail
- type ComputerAppUsageEntry
- type ComputerApplicationDataSubsetComputerDetail
- type ComputerApplicationDataSubsetComputerWrap
- type ComputerApplicationDataSubsetUniqueComputers
- type ComputerApplicationDataSubsetVersionDetail
- type ComputerApplicationDataSubsetVersions
- type ComputerApplicationUsageDetail
- type ComputerInventoryCollectionPreferences
- type ConditionalAccessDeviceState
- type ConfigurationSettings
- type CreateManagedSoftwareUpdatePlanParams
- type CreateTeamViewerConfiguration
- type CreateTeamViewerSessionRequest
- type CreatedPlan
- type CustomPathCreation
- type Details
- type DeviceAssignedToEnrollment
- type DeviceDetail
- type DeviceEnrollment
- type DeviceForPlan
- type EnrollmentCustomization
- type EnrollmentCustomizationDataSubsetBrandingSettings
- type ErrorDetail
- type FeatureOption
- type InstallSettings
- type InstanceSyncState
- type InventoryPath
- type JamfArtifact
- type JamfPackageV1
- type JamfPackageV2
- type JamfTeacherAppSettings
- type KeyDetails
- type Keystore
- type KeystoreDetails
- type LoginSettings
- type ManagedSoftwareUpdateDeviceGroup
- type ManagedSoftwareUpdateDeviceGroupItem
- type ManagedSoftwareUpdateQueryParams
- type ManagedSoftwareUpdates
- type MetricsDetail
- type PlanConfig
- type ReEnrollmentHistoryResult
- type ResponseCSAToken
- type ResponseCheckInHistoryNote
- type ResponseClientCheckIn
- type ResponseClientCheckInHistory
- type ResponseComputerApplication
- type ResponseComputerApplicationUsage
- type ResponseComputerInventoryCollectionSettings
- type ResponseConditionalAccess
- type ResponseCreateManagedSoftwareUpdatePlan
- type ResponseCreateTeamViewerConfiguration
- type ResponseCreateTeamViewerSession
- type ResponseCustomPathCreation
- type ResponseDashboard
- type ResponseDeviceCommunicationSettings
- type ResponseDeviceEnrollment
- type ResponseEnrollmentCustomization
- type ResponseEnrollmentSettings
- type ResponseFeatureToggleStatus
- type ResponseInventoryInformation
- type ResponseLocalAdminPasswordSettings
- type ResponseManagedSoftwareUpdatePlans
- type ResponseManagedSoftwareUpdatePlansForDeviceGroup
- type ResponseManagedSoftwareUpdates
- type ResponseReEnrollment
- type ResponseReEnrollmentHistory
- type ResponseStartupStatus
- type ResponseTeamViewerRemoteAdminStatus
- type ResponseTeamViewerRemoteAdministrationConfiguration
- type ResponseTeamViewerSessionStatus
- type SSOCertificateResponse
- type SafelistedApp
- type SelfServiceSettings
- type SetupTaskOption
- type SoftwareUpdatePlan
- type SoftwareUpdatePlanForDeviceGroup
- type SyncState
- type TeacherAppFeature
- type TeacherAppHistoryItem
- type TeacherAppHistoryResponse
- type TeamViewerRemoteAdministrationConfiguration
- type TeamViewerSession
- type TimeZoneInformation
- type UpdateDeviceEnrollmentTokenRequest
- type UpdatePlanStatus
- type UpdateTeamViewerConfiguration
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CSAToken ¶
type CSAToken struct { EmailAddress string `json:"emailAddress"` Password string `json:"password"` }
CSAToken is used to provide the email and password when requesting a CSA token from the Jamf Pro API.
type CertificateDetails ¶
type CertificateDetails struct { Filename string `json:"filename"` Md5Sum string `json:"md5Sum"` Subject string `json:"subject,omitempty"` SerialNumber string `json:"serialNumber,omitempty"` IdentityKeystore string `json:"identityKeystore,omitempty"` KeystorePassword string `json:"keystorePassword,omitempty"` }
type ComplianceVendorDeviceInformation ¶
type ComplianceVendorDeviceInformation struct {
DeviceIds []string `json:"deviceIds"`
}
type ComputerAppUsageDetail ¶
type ComputerAppUsageDetail struct { Name string `json:"name,omitempty" xml:"name,omitempty"` Version string `json:"version,omitempty" xml:"version,omitempty"` Foreground int `json:"foreground,omitempty" xml:"foreground,omitempty"` // Number of minutes application was in the foreground Open int `json:"open,omitempty" xml:"open,omitempty"` // Number of minutes the application was open }
type ComputerAppUsageEntry ¶
type ComputerAppUsageEntry struct {
App ComputerAppUsageDetail `json:"app,omitempty" xml:"app,omitempty"`
}
type ComputerApplicationDataSubsetComputerDetail ¶
type ComputerApplicationDataSubsetComputerDetail struct { ID int `json:"id,omitempty" xml:"id,omitempty"` Name string `json:"name,omitempty" xml:"name,omitempty"` UDID string `json:"udid,omitempty" xml:"udid,omitempty"` SerialNumber string `json:"serial_number,omitempty" xml:"serial_number,omitempty"` MacAddress string `json:"mac_address,omitempty" xml:"mac_address,omitempty"` }
type ComputerApplicationDataSubsetComputerWrap ¶
type ComputerApplicationDataSubsetComputerWrap struct {
Computer ComputerApplicationDataSubsetComputerDetail `json:"computer,omitempty" xml:"computer,omitempty"`
}
type ComputerApplicationDataSubsetUniqueComputers ¶
type ComputerApplicationDataSubsetUniqueComputers struct {
Computer []ComputerApplicationDataSubsetComputerDetail `json:"computer,omitempty" xml:"computer,omitempty"`
}
type ComputerApplicationDataSubsetVersionDetail ¶
type ComputerApplicationDataSubsetVersionDetail struct { Number string `json:"number,omitempty" xml:"number,omitempty"` Computers []ComputerApplicationDataSubsetComputerWrap `json:"computers,omitempty" xml:"computers,omitempty"` }
type ComputerApplicationDataSubsetVersions ¶
type ComputerApplicationDataSubsetVersions struct {
Version []ComputerApplicationDataSubsetVersionDetail `json:"version,omitempty" xml:"version,omitempty"`
}
type ComputerApplicationUsageDetail ¶
type ComputerApplicationUsageDetail struct { Date string `json:"date,omitempty" xml:"date,omitempty"` Apps []ComputerAppUsageEntry `json:"apps,omitempty" xml:"apps,omitempty"` }
type ComputerInventoryCollectionPreferences ¶
type ComputerInventoryCollectionPreferences struct { MonitorApplicationUsage bool `json:"monitorApplicationUsage"` IncludeFonts bool `json:"includeFonts"` IncludePlugins bool `json:"includePlugins"` IncludePackages bool `json:"includePackages"` IncludeSoftwareUpdates bool `json:"includeSoftwareUpdates"` IncludeAccounts bool `json:"includeAccounts"` CalculateSizes bool `json:"calculateSizes"` IncludeHiddenAccounts bool `json:"includeHiddenAccounts"` IncludePrinters bool `json:"includePrinters"` IncludeServices bool `json:"includeServices"` CollectSyncedMobileDeviceInfo bool `json:"collectSyncedMobileDeviceInfo"` UpdateLdapInfoOnComputerInventorySubmissions bool `json:"updateLdapInfoOnComputerInventorySubmissions"` MonitorBeacons bool `json:"monitorBeacons"` AllowChangingUserAndLocation bool `json:"allowChangingUserAndLocation"` UseUnixUserPaths bool `json:"useUnixUserPaths"` }
type ConditionalAccessDeviceState ¶
type ConditionalAccessDeviceState struct { DeviceId string `json:"deviceId"` Applicable bool `json:"applicable"` ComplianceState string `json:"complianceState"` ComplianceVendor string `json:"complianceVendor"` ComplianceVendorDeviceInformation ComplianceVendorDeviceInformation `json:"complianceVendorDeviceInformation"` }
type ConfigurationSettings ¶
type ConfigurationSettings struct { NotificationsEnabled bool `json:"notificationsEnabled"` AlertUserApprovedMdm bool `json:"alertUserApprovedMdm"` DefaultLandingPage string `json:"defaultLandingPage"` DefaultHomeCategoryId int32 `json:"defaultHomeCategoryId"` BookmarksName string `json:"bookmarksName"` }
type CreateManagedSoftwareUpdatePlanParams ¶
type CreateManagedSoftwareUpdatePlanParams struct { Devices []DeviceForPlan `json:"devices"` Config PlanConfig `json:"config"` }
Body parameters for creating managed software update plans
type CreatedPlan ¶
type CreatedPlan struct { Device DeviceDetail `json:"device"` PlanID string `json:"planId"` Href string `json:"href"` }
type CustomPathCreation ¶
type DeviceAssignedToEnrollment ¶
type DeviceAssignedToEnrollment struct { ID string `json:"id"` DeviceEnrollmentProgramInstanceId string `json:"deviceEnrollmentProgramInstanceId"` PrestageId string `json:"prestageId"` SerialNumber string `json:"serialNumber"` Description string `json:"description"` Model string `json:"model"` Color string `json:"color"` AssetTag string `json:"assetTag"` ProfileStatus string `json:"profileStatus"` SyncState SyncState `json:"syncState"` ProfileAssignTime string `json:"profileAssignTime"` ProfilePushTime string `json:"profilePushTime"` DeviceAssignedDate string `json:"deviceAssignedDate"` }
type DeviceDetail ¶
type DeviceEnrollment ¶
type DeviceEnrollment struct { ID string `json:"id"` Name string `json:"name"` SupervisionIdentityId string `json:"supervisionIdentityId"` SiteId string `json:"siteId"` ServerName string `json:"serverName"` ServerUuid string `json:"serverUuid"` AdminId string `json:"adminId"` OrgName string `json:"orgName"` OrgEmail string `json:"orgEmail"` OrgPhone string `json:"orgPhone"` OrgAddress string `json:"orgAddress"` TokenExpirationDate string `json:"tokenExpirationDate"` }
type DeviceForPlan ¶
type EnrollmentCustomization ¶
type EnrollmentCustomization struct { ID string `json:"id"` SiteId string `json:"siteId"` DisplayName string `json:"displayName"` Description string `json:"description"` EnrollmentCustomizationBrandingSettings EnrollmentCustomizationDataSubsetBrandingSettings `json:"enrollmentCustomizationBrandingSettings"` }
type ErrorDetail ¶
type FeatureOption ¶
type FeatureOption struct { ID string `json:"id"` Title string `json:"title"` Subtitle string `json:"subtitle"` Info string `json:"info"` Enabled bool `json:"enabled"` Metrics []MetricsDetail `json:"metrics"` Details []Details `json:"details"` Error ErrorDetail `json:"error"` }
type InstallSettings ¶
type InstanceSyncState ¶
type InventoryPath ¶
type JamfArtifact ¶
type JamfPackageV1 ¶
type JamfPackageV1 struct { ID string `json:"id"` Filename string `json:"filename"` Version string `json:"version"` Created string `json:"created"` URL string `json:"url"` }
JamfPackageV1 Response structure (from your initial request)
type JamfPackageV2 ¶
type JamfPackageV2 struct { DisplayName string `json:"displayName"` ReleaseHistoryUrl string `json:"releaseHistoryUrl"` Artifacts []JamfArtifact `json:"artifacts"` }
JamfPackageV2 Response structure (from the new v2 API)
type JamfTeacherAppSettings ¶
type JamfTeacherAppSettings struct { IsEnabled bool `json:"isEnabled"` TimezoneId string `json:"timezoneId"` AutoClear string `json:"autoClear"` MaxRestrictionLengthSeconds int `json:"maxRestrictionLengthSeconds"` DisplayNameType string `json:"displayNameType"` Features TeacherAppFeature `json:"features"` SafelistedApps []SafelistedApp `json:"safelistedApps"` }
type KeyDetails ¶
type Keystore ¶
type Keystore struct { Key string `json:"key"` Keys []KeyDetails `json:"keys"` Type string `json:"type"` KeystoreSetupType string `json:"keystoreSetupType"` KeystoreFileName string `json:"keystoreFileName"` }
type KeystoreDetails ¶
type LoginSettings ¶
type ManagedSoftwareUpdateDeviceGroupItem ¶
type ManagedSoftwareUpdateDeviceGroupItem struct { Group ManagedSoftwareUpdateDeviceGroup `json:"group"` Config PlanConfig `json:"config"` }
type ManagedSoftwareUpdateQueryParams ¶
type ManagedSoftwareUpdateQueryParams struct { Page int `json:"page"` PageSize int `json:"page-size"` Sort []string `json:"sort"` Filter string `json:"filter"` }
Define a struct for the query parameters
type ManagedSoftwareUpdates ¶
type MetricsDetail ¶
type PlanConfig ¶
type ResponseCSAToken ¶
type ResponseCSAToken struct { RefreshExpiration int `json:"refreshExpiration"` Scopes []string `json:"scopes"` }
ResponseCSAToken represents the structure of the response when requesting a CSA token from the Jamf Pro API.
type ResponseClientCheckIn ¶
type ResponseClientCheckIn struct { CheckInFrequency int `json:"checkInFrequency"` CreateHooks bool `json:"createHooks"` HookLog bool `json:"hookLog"` HookPolicies bool `json:"hookPolicies"` CreateStartupScript bool `json:"createStartupScript"` StartupLog bool `json:"startupLog"` StartupPolicies bool `json:"startupPolicies"` StartupSsh bool `json:"startupSsh"` EnableLocalConfigurationProfiles bool `json:"enableLocalConfigurationProfiles"` }
type ResponseClientCheckInHistory ¶
type ResponseClientCheckInHistory struct { TotalCount int `json:"totalCount"` Results []ClientCheckInHistoryResult `json:"results"` }
type ResponseComputerApplication ¶
type ResponseComputerApplication struct { Versions ComputerApplicationDataSubsetVersions `json:"versions,omitempty" xml:"versions,omitempty"` UniqueComputers ComputerApplicationDataSubsetUniqueComputers `json:"unique_computers,omitempty" xml:"unique_computers,omitempty"` }
type ResponseComputerApplicationUsage ¶
type ResponseComputerApplicationUsage struct {
Usage ComputerApplicationUsageDetail `json:"usage,omitempty" xml:"usage,omitempty"`
}
type ResponseComputerInventoryCollectionSettings ¶
type ResponseComputerInventoryCollectionSettings struct { Preferences ComputerInventoryCollectionPreferences `json:"computerInventoryCollectionPreferences"` ApplicationPaths []InventoryPath `json:"applicationPaths"` FontPaths []InventoryPath `json:"fontPaths"` PluginPaths []InventoryPath `json:"pluginPaths"` }
type ResponseConditionalAccess ¶
type ResponseConditionalAccess struct { TotalCount int `json:"totalCount,omitempty"` Results []ConditionalAccessDeviceState `json:"results"` }
Structures
type ResponseCreateManagedSoftwareUpdatePlan ¶
type ResponseCreateManagedSoftwareUpdatePlan struct {
Plans []CreatedPlan `json:"plans"`
}
Response for creating managed software update plans
type ResponseCustomPathCreation ¶
type ResponseCustomPathCreation struct {
Message string `json:"message"`
}
type ResponseDashboard ¶
type ResponseDashboard struct { SetupTaskOptions map[string]SetupTaskOption `json:"setupTaskOptions"` FeatureOptions map[string][]FeatureOption `json:"featureOptions"` }
type ResponseDeviceCommunicationSettings ¶
type ResponseDeviceCommunicationSettings struct { AutoRenewMobileDeviceMdmProfileWhenCaRenewed bool `json:"autoRenewMobileDeviceMdmProfileWhenCaRenewed"` AutoRenewMobileDeviceMdmProfileWhenDeviceIdentityCertExpiring bool `json:"autoRenewMobileDeviceMdmProfileWhenDeviceIdentityCertExpiring"` AutoRenewComputerMdmProfileWhenCaRenewed bool `json:"autoRenewComputerMdmProfileWhenCaRenewed"` AutoRenewComputerMdmProfileWhenDeviceIdentityCertExpiring bool `json:"autoRenewComputerMdmProfileWhenDeviceIdentityCertExpiring"` MdmProfileMobileDeviceExpirationLimitInDays int `json:"mdmProfileMobileDeviceExpirationLimitInDays"` MdmProfileComputerExpirationLimitInDays int `json:"mdmProfileComputerExpirationLimitInDays"` }
type ResponseDeviceEnrollment ¶
type ResponseDeviceEnrollment struct { TotalCount int `json:"totalCount"` Results []DeviceEnrollment `json:"results"` }
type ResponseEnrollmentCustomization ¶
type ResponseEnrollmentCustomization struct { TotalCount int `json:"totalCount"` Results []EnrollmentCustomization `json:"results"` }
type ResponseEnrollmentSettings ¶
type ResponseEnrollmentSettings struct { InstallSingleProfile bool `json:"installSingleProfile"` SigningMdmProfileEnabled bool `json:"signingMdmProfileEnabled"` MdmSigningCertificate *CertificateDetails `json:"mdmSigningCertificate"` RestrictReenrollment bool `json:"restrictReenrollment"` FlushLocationInformation bool `json:"flushLocationInformation"` FlushLocationHistoryInformation bool `json:"flushLocationHistoryInformation"` FlushPolicyHistory bool `json:"flushPolicyHistory"` FlushExtensionAttributes bool `json:"flushExtensionAttributes"` FlushMdmCommandsOnReenroll string `json:"flushMdmCommandsOnReenroll"` MacOsEnterpriseEnrollmentEnabled bool `json:"macOsEnterpriseEnrollmentEnabled"` ManagementUsername string `json:"managementUsername"` CreateManagementAccount bool `json:"createManagementAccount"` HideManagementAccount bool `json:"hideManagementAccount"` AllowSshOnlyManagementAccount bool `json:"allowSshOnlyManagementAccount"` EnsureSshRunning bool `json:"ensureSshRunning"` LaunchSelfService bool `json:"launchSelfService"` SignQuickAdd bool `json:"signQuickAdd"` DeveloperCertificateIdentity *CertificateDetails `json:"developerCertificateIdentity"` DeveloperCertificateIdentityDetails CertificateDetails `json:"developerCertificateIdentityDetails"` MdmSigningCertificateDetails CertificateDetails `json:"mdmSigningCertificateDetails"` IosEnterpriseEnrollmentEnabled bool `json:"iosEnterpriseEnrollmentEnabled"` IosPersonalEnrollmentEnabled bool `json:"iosPersonalEnrollmentEnabled"` PersonalDeviceEnrollmentType string `json:"personalDeviceEnrollmentType"` AccountDrivenUserEnrollmentEnabled bool `json:"accountDrivenUserEnrollmentEnabled"` }
type ResponseManagedSoftwareUpdatePlans ¶
type ResponseManagedSoftwareUpdatePlans struct { TotalCount int `json:"totalCount"` Results []SoftwareUpdatePlan `json:"results"` }
type ResponseManagedSoftwareUpdatePlansForDeviceGroup ¶
type ResponseManagedSoftwareUpdatePlansForDeviceGroup struct { TotalCount int `json:"totalCount"` Results []SoftwareUpdatePlanForDeviceGroup `json:"results"` }
type ResponseManagedSoftwareUpdates ¶
type ResponseManagedSoftwareUpdates struct {
AvailableUpdates *ManagedSoftwareUpdates `json:"availableUpdates,omitempty"`
}
Struct for ResponseManagedSoftwareUpdates
type ResponseReEnrollment ¶
type ResponseReEnrollment struct { IsFlushPolicyHistoryEnabled bool `json:"isFlushPolicyHistoryEnabled"` IsFlushLocationInformationEnabled bool `json:"isFlushLocationInformationEnabled"` IsFlushLocationInformationHistoryEnabled bool `json:"isFlushLocationInformationHistoryEnabled"` IsFlushExtensionAttributesEnabled bool `json:"isFlushExtensionAttributesEnabled"` FlushMDMQueue string `json:"flushMDMQueue"` }
type ResponseReEnrollmentHistory ¶
type ResponseReEnrollmentHistory struct { TotalCount int `json:"totalCount"` Results []ReEnrollmentHistoryResult `json:"results"` }
type ResponseStartupStatus ¶
type ResponseStartupStatus struct { Step string `json:"step"` StepCode string `json:"stepCode"` StepParam string `json:"stepParam"` Percentage int `json:"percentage"` Warning string `json:"warning"` WarningCode string `json:"warningCode"` WarningParam string `json:"warningParam"` Error string `json:"error"` ErrorCode string `json:"errorCode"` SetupAssistantNecessary bool `json:"setupAssistantNecessary"` }
type ResponseTeamViewerRemoteAdminStatus ¶
type ResponseTeamViewerRemoteAdminStatus struct {
ConnectionVerificationResult string `json:"connectionVerificationResult"`
}
type ResponseTeamViewerRemoteAdministrationConfiguration ¶
type ResponseTeamViewerRemoteAdministrationConfiguration struct { TotalCount int `json:"totalCount"` Results []TeamViewerRemoteAdministrationConfiguration `json:"results"` }
type SSOCertificateResponse ¶
type SSOCertificateResponse struct { Keystore Keystore `json:"keystore"` KeystoreDetails KeystoreDetails `json:"keystoreDetails"` }
type SafelistedApp ¶
type SelfServiceSettings ¶
type SelfServiceSettings struct { InstallSettings InstallSettings `json:"installSettings"` LoginSettings LoginSettings `json:"loginSettings"` ConfigurationSettings ConfigurationSettings `json:"configurationSettings"` }
SelfServiceSettings represents the settings of Self Service.
type SetupTaskOption ¶
type SetupTaskOption struct { Available bool `json:"available"` Error ErrorDetail `json:"error"` }
type SoftwareUpdatePlan ¶
type SoftwareUpdatePlan struct { PlanUUID string `json:"planUuid"` Device DeviceDetail `json:"device"` UpdateAction string `json:"updateAction"` VersionType string `json:"versionType"` SpecificVersion string `json:"specificVersion,omitempty"` MaxDeferrals int `json:"maxDeferrals"` ForceInstallLocalDateTime string `json:"forceInstallLocalDateTime,omitempty"` Status UpdatePlanStatus `json:"status"` }
type SoftwareUpdatePlanForDeviceGroup ¶
type SoftwareUpdatePlanForDeviceGroup struct { PlanUUID string `json:"planUuid"` Device DeviceDetail `json:"device"` UpdateAction string `json:"updateAction"` VersionType string `json:"versionType"` SpecificVersion string `json:"specificVersion,omitempty"` MaxDeferrals int `json:"maxDeferrals"` ForceInstallLocalDateTime string `json:"forceInstallLocalDateTime,omitempty"` Status UpdatePlanStatus `json:"status"` }
type TeacherAppFeature ¶
type TeacherAppHistoryItem ¶
type TeacherAppHistoryResponse ¶
type TeacherAppHistoryResponse struct { TotalCount int `json:"totalCount"` Results []TeacherAppHistoryItem `json:"results"` }
type TeamViewerSession ¶
type TeamViewerSession struct { ID string `json:"id"` Code string `json:"code"` Description string `json:"description"` SupporterLink string `json:"supporterLink"` EndUserLink string `json:"endUserLink"` DeviceID string `json:"deviceId"` DeviceName string `json:"deviceName"` DeviceType string `json:"deviceType"` State string `json:"state"` CreatorID string `json:"creatorId"` CreatorName string `json:"creatorName"` CreatedAt string `json:"createdAt"` }
type TimeZoneInformation ¶
type UpdatePlanStatus ¶
Source Files ¶
- branding.go
- clientCheckIn.go
- computerApplicationUsage.go
- computerApplications.go
- computerInventoryCollectionSettings.go
- conditionalAccess.go
- csa.go
- dashboard.go
- deviceComunicationSettings.go
- deviceEnrollments.go
- enrollment.go
- enrollmentCustomizations.go
- inventoryInformation.go
- jamfPackage.go
- localAdminPassword.go
- managedSoftwareUpdates.go
- reenrollment.go
- selfService.go
- ssoCertificate.go
- startupStatus.go
- teacherApps.go
- teamViewerRemoteAdministration.go
- timeZones.go
Click to show internal directories.
Click to hide internal directories.