jamfpro

Documentation

Index

• type CSAToken
• type CertificateDetails
• type CreateManagedSoftwareUpdatePlanParams
• type CreateTeamViewerConfiguration
• type CreateTeamViewerSessionRequest
• type CreatedPlan
• type DeviceAssignedToEnrollment
• type DeviceDetail
• type DeviceEnrollment
• type DeviceForPlan
• type InstanceSyncState
• type ManagedSoftwareUpdateDeviceGroup
• type ManagedSoftwareUpdateDeviceGroupItem
• type ManagedSoftwareUpdateQueryParams
• type ManagedSoftwareUpdates
• type PlanConfig
• type ResponseCSAToken
• type ResponseCreateManagedSoftwareUpdatePlan
• type ResponseCreateTeamViewerConfiguration
• type ResponseCreateTeamViewerSession
• type ResponseDeviceEnrollment
• type ResponseEnrollmentSettings
• type ResponseFeatureToggleStatus
• type ResponseManagedSoftwareUpdatePlans
• type ResponseManagedSoftwareUpdatePlansForDeviceGroup
• type ResponseManagedSoftwareUpdates
• type ResponseStartupStatus
• type ResponseTeamViewerRemoteAdminStatus
• type ResponseTeamViewerRemoteAdministrationConfiguration
• type ResponseTeamViewerSessionStatus
• type SoftwareUpdatePlan
• type SoftwareUpdatePlanForDeviceGroup
• type SyncState
• type TeamViewerRemoteAdministrationConfiguration
• type TeamViewerSession
• type UpdateDeviceEnrollmentTokenRequest
• type UpdatePlanStatus
• type UpdateTeamViewerConfiguration

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 CreateManagedSoftwareUpdatePlanParams

type CreateManagedSoftwareUpdatePlanParams struct {
	Devices []DeviceForPlan `json:"devices"`
	Config  PlanConfig      `json:"config"`
}

Body parameters for creating managed software update plans

type CreateTeamViewerConfiguration

type CreateTeamViewerConfiguration struct {
	Enabled        bool   `json:"enabled"`
	SiteID         string `json:"siteId"`
	DisplayName    string `json:"displayName"`
	ScriptToken    string `json:"scriptToken"`
	SessionTimeout int    `json:"sessionTimeout"`
}

type CreateTeamViewerSessionRequest

type CreateTeamViewerSessionRequest struct {
	DeviceID    string `json:"deviceId"`
	DeviceType  string `json:"deviceType"`
	Description string `json:"description"`
}

type CreatedPlan

type CreatedPlan struct {
	Device DeviceDetail `json:"device"`
	PlanID string       `json:"planId"`
	Href   string       `json:"href"`
}

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 DeviceDetail struct {
	DeviceID   string `json:"deviceId"`
	ObjectType string `json:"objectType,omitempty"`
	Href       string `json:"href,omitempty"`
}

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 DeviceForPlan struct {
	DeviceID   string `json:"deviceId"`
	ObjectType string `json:"objectType"`
}

type InstanceSyncState

type InstanceSyncState struct {
	SyncState  string `json:"syncState"`
	InstanceID string `json:"instanceId"`
	Timestamp  string `json:"timestamp"`
}

type ManagedSoftwareUpdateDeviceGroup

type ManagedSoftwareUpdateDeviceGroup struct {
	GroupID    string `json:"groupId"`
	ObjectType string `json:"objectType"`
}

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 ManagedSoftwareUpdates struct {
	MacOS []string `json:"macOS,omitempty"`
	IOS   []string `json:"iOS,omitempty"`
}

type PlanConfig

type PlanConfig struct {
	UpdateAction              string `json:"updateAction"`
	VersionType               string `json:"versionType"`
	SpecificVersion           string `json:"specificVersion,omitempty"`
	MaxDeferrals              int    `json:"maxDeferrals"`
	ForceInstallLocalDateTime string `json:"forceInstallLocalDateTime,omitempty"`
}

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 ResponseCreateManagedSoftwareUpdatePlan

type ResponseCreateManagedSoftwareUpdatePlan struct {
	Plans []CreatedPlan `json:"plans"`
}

Response for creating managed software update plans

type ResponseCreateTeamViewerConfiguration

type ResponseCreateTeamViewerConfiguration struct {
	ID   string `json:"id"`
	Href string `json:"href"`
}

type ResponseCreateTeamViewerSession

type ResponseCreateTeamViewerSession struct {
	ID   string `json:"id"`
	Href string `json:"href"`
}

type ResponseDeviceEnrollment

type ResponseDeviceEnrollment struct {
	TotalCount int                `json:"totalCount"`
	Results    []DeviceEnrollment `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 ResponseFeatureToggleStatus

type ResponseFeatureToggleStatus struct {
	Toggle                       bool `json:"toggle"`
	ForceInstallLocalDateEnabled bool `json:"forceInstallLocalDateEnabled,omitempty"`
	DssEnabled                   bool `json:"dssEnabled,omitempty"`
}

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 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 ResponseTeamViewerSessionStatus

type ResponseTeamViewerSessionStatus struct {
	SessionState string `json:"sessionState"`
	Online       bool   `json:"online"`
}

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 SyncState

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

type TeamViewerRemoteAdministrationConfiguration

type TeamViewerRemoteAdministrationConfiguration struct {
	ID             string `json:"id"`
	SiteID         string `json:"siteId"`
	DisplayName    string `json:"displayName"`
	Enabled        bool   `json:"enabled"`
	SessionTimeout int    `json:"sessionTimeout"`
}

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 UpdateDeviceEnrollmentTokenRequest

type UpdateDeviceEnrollmentTokenRequest struct {
	TokenFileName string `json:"tokenFileName"`
	EncodedToken  string `json:"encodedToken"`
}

type UpdatePlanStatus

type UpdatePlanStatus struct {
	State        string   `json:"state,omitempty"`
	ErrorReasons []string `json:"errorReasons,omitempty"`
}

type UpdateTeamViewerConfiguration

type UpdateTeamViewerConfiguration struct {
	DisplayName    string `json:"displayName"`
	Enabled        bool   `json:"enabled"`
	SessionTimeout int    `json:"sessionTimeout"`
	Token          string `json:"token"`
}