Documentation
¶
Overview ¶
Package blueprints provides typed access to Jamf Platform blueprints API endpoints.
Index ¶
- Variables
- func PrivilegesFor(method string) (jamfplatform.MethodPrivileges, bool)
- type AcceptCookies
- type AcceptCookiesValue
- type AllowDisablingFraudWarning
- type AllowHistoryClearing
- type AllowJavaScript
- type AllowPopups
- type AllowPrivateBrowsing
- type AllowSummary
- type ApiError
- type AudioAccessorySettingsComponent
- type AudioAccessorySettingsComponentIdentifier
- type AudioAccessorySettingsConfiguration
- type AutomaticAction
- type AutomaticActionValue
- type AutomaticActions
- type BasicMode
- type Beta
- type BetaProgram
- type BetaSettings
- type BetaSettingsProgramEnrollment
- type BlueprintDetail
- type BlueprintOverview
- type BlueprintScope
- type BlueprintStatusDetail
- type BlueprintStep
- type BookmarkGroup
- type BookmarkItem
- type BookmarkItemType
- type Calculator
- type ChangeAtNextAuth
- type Client
- func (c *Client) CreateBlueprint(ctx context.Context, request *CreateBlueprintRequest) (*CreateResponse, error)
- func (c *Client) DeleteBlueprint(ctx context.Context, blueprintID string) error
- func (c *Client) DeployBlueprint(ctx context.Context, blueprintID string) error
- func (c *Client) GetBlueprint(ctx context.Context, blueprintID string) (*BlueprintDetail, error)
- func (c *Client) GetBlueprintComponent(ctx context.Context, identifier string) (*ComponentDescription, error)
- func (c *Client) GetBlueprintReport(ctx context.Context, blueprintID string) (*BlueprintStatusDetail, error)
- func (c *Client) ListBlueprintComponents(ctx context.Context) ([]ComponentDescription, error)
- func (c *Client) ListBlueprints(ctx context.Context, sort []string, search string) ([]BlueprintOverview, error)
- func (c *Client) ResolveBlueprintByName(ctx context.Context, name string) (*BlueprintOverview, error)
- func (c *Client) ResolveBlueprintComponentByName(ctx context.Context, name string) (*ComponentDescription, error)
- func (c *Client) ResolveBlueprintComponentIDByName(ctx context.Context, name string) (string, error)
- func (c *Client) ResolveBlueprintIDByName(ctx context.Context, name string) (string, error)
- func (c *Client) UndeployBlueprint(ctx context.Context, blueprintID string) error
- func (c *Client) UpdateBlueprint(ctx context.Context, blueprintID string, request *UpdateBlueprintRequest) error
- type Component
- type ComponentDescription
- type ConfigurationProfile
- type ConfigurationProfileConfiguration
- type ConfigurationProfileContentItem
- type ConfigurationProfileIdentifier
- type CreateBlueprintRequest
- type CreateResponse
- type CreateScope
- type CustomDeclaration
- type CustomDeclarationsComponent
- type CustomDeclarationsComponentIdentifier
- type CustomDeclarationsConfiguration
- type CustomRegex
- type DeclarationChannelType
- type DeclarationKind
- type Deferrals
- type Deployment
- type DeploymentState
- type DeploymentStateState
- type DetailsURL
- type DiskManagementComponent
- type DiskManagementComponentIdentifier
- type DiskManagementSettingsConfiguration
- type DiskManagementSettingsConfigurationVersion
- type Error
- type FailedAttemptsResetInMinutes
- type FolderBookmarkItem
- type FolderBookmarkItemType
- type InputModes
- type ManagedAppAttributes
- type ManagedAppComponent
- type ManagedAppComponentIdentifier
- type ManagedAppConfiguration
- type ManagedAppEntry
- type ManagedAppEntryAllowDownloadsOverCellular
- type ManagedAppEntryAutomaticAppUpdates
- type ManagedAppEntryInstall
- type ManagedExtension
- type ManagedExtensionDomain
- type ManagedExtensionPrivateBrowsing
- type ManagedExtensionState
- type MathNotesMode
- type MathSettingsComponent
- type MathSettingsComponentIdentifier
- type MathSettingsConfiguration
- type MaximumFailedAttempts
- type MaximumGracePeriodInMinutes
- type MaximumInactivityInMinutes
- type MaximumPasscodeAgeInDays
- type Meta
- type MinimumComplexCharacters
- type MinimumLength
- type NewTabStartPage
- type NewTabStartPagePageType
- type OptionalPeriodInDays
- type OptionallyEnabled
- type PagedResponseBlueprintOverview
- type PagedResponseComponentDescription
- type PasscodeReuseLimit
- type PasscodeSettingsComponent
- type PasscodeSettingsComponentIdentifier
- type PasscodeSettingsConfiguration
- type PasscodeSettingsConfigurationVersion
- type ProgrammerMode
- type RapidSecurityResponse
- type RecommendedCadence
- type RecommendedCadenceValue
- type RequireAlphanumericPasscode
- type RequireComplexPasscode
- type RequirePasscode
- type Restrictions
- type SafariBookmarksComponent
- type SafariBookmarksComponentIdentifier
- type SafariBookmarksConfiguration
- type SafariExtensionsComponent
- type SafariExtensionsComponentIdentifier
- type SafariExtensionsConfiguration
- type SafariSettingsComponent
- type SafariSettingsComponentIdentifier
- type SafariSettingsConfiguration
- type ScientificMode
- type SoftwareUpdateSettingsComponent
- type SoftwareUpdateSettingsComponentIdentifier
- type SoftwareUpdateSettingsConfiguration
- type StorageMode
- type StorageModeValue
- type SupportedOs
- type SwUpdateAutomaticConfiguration
- type SwUpdateAutomaticConfigurationStrategy
- type SwUpdateComponent
- type SwUpdateComponentIdentifier
- type SwUpdateConfiguration
- type SwUpdateConfigurationEnforcementType
- type SwUpdateLatestConfiguration
- type SwUpdateLatestConfigurationEnforcementType
- type SwUpdateLatestConfigurationStrategy
- type SwUpdateManualConfiguration
- type SwUpdateManualConfigurationEnforcementType
- type SwUpdateSemanticConfiguration
- type SwUpdateSemanticConfigurationEnforcementType
- type SwUpdateSemanticConfigurationStrategy
- type SystemBehavior
- type TemporaryPairing
- type TemporaryPairingConfig
- type URLBookmarkItem
- type URLBookmarkItemType
- type UnpairingTime
- type UnpairingTimePolicy
- type UpdateBlueprintRequest
- type UpdateRule
- type UpdateRules
Constants ¶
This section is empty.
Variables ¶
var Privileges = map[string]jamfplatform.MethodPrivileges{ "CreateBlueprint": {Method: "CreateBlueprint", HTTPMethod: "POST", Path: "/v1/blueprints", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:create"}, Legacy: nil, Source: "spec"}, "DeleteBlueprint": {Method: "DeleteBlueprint", HTTPMethod: "DELETE", Path: "/v1/blueprints/{blueprintId}", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:delete"}, Legacy: nil, Source: "spec"}, "DeployBlueprint": {Method: "DeployBlueprint", HTTPMethod: "POST", Path: "/v1/blueprints/{blueprintId}/deploy", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:deploy"}, Legacy: nil, Source: "spec"}, "GetBlueprint": {Method: "GetBlueprint", HTTPMethod: "GET", Path: "/v1/blueprints/{blueprintId}", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:read"}, Legacy: nil, Source: "spec"}, "GetBlueprintComponent": {Method: "GetBlueprintComponent", HTTPMethod: "GET", Path: "/v1/blueprint-components/{identifier}", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:read"}, Legacy: nil, Source: "spec"}, "GetBlueprintReport": {Method: "GetBlueprintReport", HTTPMethod: "GET", Path: "/v1/blueprints/{blueprintId}/report", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:read"}, Legacy: nil, Source: "spec"}, "ListBlueprintComponents": {Method: "ListBlueprintComponents", HTTPMethod: "GET", Path: "/v1/blueprint-components", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:read"}, Legacy: nil, Source: "spec"}, "ListBlueprints": {Method: "ListBlueprints", HTTPMethod: "GET", Path: "/v1/blueprints", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:read"}, Legacy: nil, Source: "spec"}, "UndeployBlueprint": {Method: "UndeployBlueprint", HTTPMethod: "POST", Path: "/v1/blueprints/{blueprintId}/undeploy", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:deploy"}, Legacy: nil, Source: "spec"}, "UpdateBlueprint": {Method: "UpdateBlueprint", HTTPMethod: "PATCH", Path: "/v1/blueprints/{blueprintId}", Scopes: []jamfplatform.ScopeKind{jamfplatform.ScopeEnvironment}, ScopesSource: "spec", Scoped: []string{"blueprints:update"}, Legacy: nil, Source: "spec"}, }
Privileges maps each blueprints 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 AcceptCookies ¶
type AcceptCookies 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.
Included *bool `json:"Included,omitempty"`
// The policy Safari uses for managing cookies.
// Allowed values: see the AcceptCookiesValue constants.
Value *string `json:"Value,omitempty"`
}
AcceptCookies represents a accept cookies.
func (*AcceptCookies) UnmarshalJSON ¶
func (s *AcceptCookies) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AcceptCookiesValue ¶
type AcceptCookiesValue = string
AcceptCookiesValue is the set of values accepted by AcceptCookies.Value.
const ( AcceptCookiesValueNever AcceptCookiesValue = "Never" AcceptCookiesValueCurrentWebsite AcceptCookiesValue = "CurrentWebsite" AcceptCookiesValueVisitedWebsites AcceptCookiesValue = "VisitedWebsites" AcceptCookiesValueAlways AcceptCookiesValue = "Always" )
AcceptCookiesValue 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 AcceptCookiesValueValues ¶
func AcceptCookiesValueValues() []AcceptCookiesValue
AcceptCookiesValueValues returns every value the Jamf API accepts for AcceptCookiesValue, 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 AllowDisablingFraudWarning ¶
type AllowDisablingFraudWarning 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.
Included *bool `json:"Included,omitempty"`
// If false, the system forces fraud warnings on in Safari.
Value *bool `json:"Value,omitempty"`
}
AllowDisablingFraudWarning represents a allow disabling fraud warning.
func (*AllowDisablingFraudWarning) UnmarshalJSON ¶
func (s *AllowDisablingFraudWarning) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AllowHistoryClearing ¶
type AllowHistoryClearing 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.
Included *bool `json:"Included,omitempty"`
// If false, the system disables clearing history in Safari.
Value *bool `json:"Value,omitempty"`
}
AllowHistoryClearing represents a allow history clearing.
func (*AllowHistoryClearing) UnmarshalJSON ¶
func (s *AllowHistoryClearing) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AllowJavaScript ¶
type AllowJavaScript 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.
Included *bool `json:"Included,omitempty"`
// If false, the system disables JavaScript in Safari.
Value *bool `json:"Value,omitempty"`
}
AllowJavaScript represents a allow java script.
func (*AllowJavaScript) UnmarshalJSON ¶
func (s *AllowJavaScript) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AllowPopups ¶
type AllowPopups 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.
Included *bool `json:"Included,omitempty"`
// If false, the system disables popups in Safari.
Value *bool `json:"Value,omitempty"`
}
AllowPopups represents a allow popups.
func (*AllowPopups) UnmarshalJSON ¶
func (s *AllowPopups) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AllowPrivateBrowsing ¶
type AllowPrivateBrowsing 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.
Included *bool `json:"Included,omitempty"`
// If false, the system disables private browsing in Safari.
Value *bool `json:"Value,omitempty"`
}
AllowPrivateBrowsing represents a allow private browsing.
func (*AllowPrivateBrowsing) UnmarshalJSON ¶
func (s *AllowPrivateBrowsing) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AllowSummary ¶
type AllowSummary 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.
Included *bool `json:"Included,omitempty"`
// If false, the system disables summarization of content in Safari.
Value *bool `json:"Value,omitempty"`
}
AllowSummary represents a allow summary.
func (*AllowSummary) UnmarshalJSON ¶
func (s *AllowSummary) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ApiError ¶
type ApiError struct {
Errors *Error `json:"errors,omitempty"`
// HTTP status of the response.
HttpStatus int `json:"httpStatus"`
// Trace ID.
TraceID string `json:"traceId"`
}
ApiError represents a api error.
type AudioAccessorySettingsComponent ¶
type AudioAccessorySettingsComponent struct {
// Audio accessory settings configuration.
// Configures audio accessory temporary pairing behavior.
Configuration AudioAccessorySettingsConfiguration `json:"configuration"`
// Allowed values: see the AudioAccessorySettingsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
AudioAccessorySettingsComponent represents a audio accessory settings component.
func (*AudioAccessorySettingsComponent) UnmarshalJSON ¶
func (s *AudioAccessorySettingsComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AudioAccessorySettingsComponentIdentifier ¶
type AudioAccessorySettingsComponentIdentifier = string
AudioAccessorySettingsComponentIdentifier is the set of values accepted by AudioAccessorySettingsComponent.Identifier.
const (
AudioAccessorySettingsComponentIdentifierComJamfDdmAudioAccessorySettings AudioAccessorySettingsComponentIdentifier = "com.jamf.ddm.audio-accessory-settings"
)
AudioAccessorySettingsComponentIdentifier 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 AudioAccessorySettingsComponentIdentifierValues ¶
func AudioAccessorySettingsComponentIdentifierValues() []AudioAccessorySettingsComponentIdentifier
AudioAccessorySettingsComponentIdentifierValues returns every value the Jamf API accepts for AudioAccessorySettingsComponentIdentifier, 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 AudioAccessorySettingsConfiguration ¶
type AudioAccessorySettingsConfiguration struct {
// Temporary pairing configuration.
TemporaryPairing *TemporaryPairing `json:"TemporaryPairing,omitempty"`
}
AudioAccessorySettingsConfiguration Audio accessory settings configuration. Configures audio accessory temporary pairing behavior.
func (*AudioAccessorySettingsConfiguration) UnmarshalJSON ¶
func (s *AudioAccessorySettingsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AutomaticAction ¶
type AutomaticAction struct {
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
// Allowed values: see the AutomaticActionValue constants.
Value string `json:"Value"`
}
AutomaticAction represents a automatic action.
func (*AutomaticAction) UnmarshalJSON ¶
func (s *AutomaticAction) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type AutomaticActionValue ¶
type AutomaticActionValue = string
AutomaticActionValue is the set of values accepted by AutomaticAction.Value.
const ( AutomaticActionValueAllowed AutomaticActionValue = "Allowed" AutomaticActionValueAlwaysOn AutomaticActionValue = "AlwaysOn" AutomaticActionValueAlwaysOff AutomaticActionValue = "AlwaysOff" )
AutomaticActionValue 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 AutomaticActionValueValues ¶
func AutomaticActionValueValues() []AutomaticActionValue
AutomaticActionValueValues returns every value the Jamf API accepts for AutomaticActionValue, 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 AutomaticActions ¶
type AutomaticActions struct {
Download *AutomaticAction `json:"Download,omitempty"`
InstallOSUpdates *AutomaticAction `json:"InstallOSUpdates,omitempty"`
InstallSecurityUpdate *AutomaticAction `json:"InstallSecurityUpdate,omitempty"`
}
AutomaticActions represents a automatic actions.
func (*AutomaticActions) UnmarshalJSON ¶
func (s *AutomaticActions) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type BasicMode ¶
type BasicMode struct {
// Add the square root button to the basic calculator by replacing the +/- button.
AddSquareRoot bool `json:"AddSquareRoot"`
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
}
BasicMode represents a basic mode.
func (*BasicMode) UnmarshalJSON ¶
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type Beta ¶
type Beta struct {
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
Value *BetaSettings `json:"Value,omitempty"`
}
Beta represents a beta.
func (*Beta) UnmarshalJSON ¶
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type BetaProgram ¶
type BetaProgram struct {
Description *string `json:"Description,omitempty"`
Token *string `json:"Token,omitempty"`
}
BetaProgram represents a beta program.
type BetaSettings ¶
type BetaSettings struct {
OfferPrograms *[]BetaProgram `json:"OfferPrograms,omitempty"`
// Allowed values: see the BetaSettingsProgramEnrollment constants.
ProgramEnrollment string `json:"ProgramEnrollment"`
RequireProgram *BetaProgram `json:"RequireProgram,omitempty"`
}
BetaSettings represents a beta settings.
type BetaSettingsProgramEnrollment ¶
type BetaSettingsProgramEnrollment = string
BetaSettingsProgramEnrollment is the set of values accepted by BetaSettings.ProgramEnrollment.
const ( BetaSettingsProgramEnrollmentAllowed BetaSettingsProgramEnrollment = "Allowed" BetaSettingsProgramEnrollmentAlwaysOn BetaSettingsProgramEnrollment = "AlwaysOn" BetaSettingsProgramEnrollmentAlwaysOff BetaSettingsProgramEnrollment = "AlwaysOff" )
BetaSettingsProgramEnrollment 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 BetaSettingsProgramEnrollmentValues ¶
func BetaSettingsProgramEnrollmentValues() []BetaSettingsProgramEnrollment
BetaSettingsProgramEnrollmentValues returns every value the Jamf API accepts for BetaSettingsProgramEnrollment, 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 BlueprintDetail ¶
type BlueprintDetail struct {
// Creation date.
Created time.Time `json:"created"`
// Blueprint deployment state.
DeploymentState *DeploymentState `json:"deploymentState,omitempty"`
// Description of the blueprint.
Description *string `json:"description,omitempty"`
// ID of the blueprint.
ID string `json:"id"`
// Name of the blueprint.
Name string `json:"name"`
// Device groups.
Scope *BlueprintScope `json:"scope,omitempty"`
// Array of blueprint steps.
Steps []BlueprintStep `json:"steps"`
// Last modification date.
Updated time.Time `json:"updated"`
}
BlueprintDetail represents a blueprint detail.
type BlueprintOverview ¶
type BlueprintOverview struct {
// Creation date.
Created time.Time `json:"created"`
// Blueprint deployment state.
DeploymentState *DeploymentState `json:"deploymentState,omitempty"`
// Description of the blueprint.
Description *string `json:"description,omitempty"`
// ID of the blueprint.
ID string `json:"id"`
// Name of the blueprint.
Name string `json:"name"`
// Last modification date.
Updated time.Time `json:"updated"`
}
BlueprintOverview Array of result items.
type BlueprintScope ¶
type BlueprintScope struct {
// Device groups.
DeviceGroups []string `json:"deviceGroups"`
}
BlueprintScope Device groups.
type BlueprintStatusDetail ¶
type BlueprintStatusDetail struct {
// Number of devices in failed state.
Failed int `json:"failed"`
// Number of devices in pending state.
Pending int `json:"pending"`
// Number of devices in successful state.
Succeeded int `json:"succeeded"`
}
BlueprintStatusDetail represents a blueprint status detail.
type BlueprintStep ¶
type BlueprintStep struct {
// Declarative activation predicate.
ActivationPredicate *string `json:"activationPredicate,omitempty"`
// Array of components included in the step.
Components []Component `json:"components"`
// Name of the step.
Name *string `json:"name,omitempty"`
}
BlueprintStep Array of blueprint steps.
type BookmarkGroup ¶
type BookmarkGroup struct {
// A list of bookmarks.
Bookmarks []BookmarkItem `json:"Bookmarks"`
// A string that specifies the unique identifier for this group of managed bookmarks.
GroupIdentifier string `json:"GroupIdentifier"`
// The name of the bookmarks folder.
Title string `json:"Title"`
}
BookmarkGroup represents a bookmark group.
type BookmarkItem ¶
type BookmarkItem struct {
// Allowed values: see the BookmarkItemType constants.
Type string `json:"Type"`
BOOKMARK *URLBookmarkItem `json:"-"`
FOLDER *FolderBookmarkItem `json:"-"`
}
BookmarkItem is a polymorphic response keyed by Type. Exactly one variant pointer is populated after unmarshaling.
func (BookmarkItem) MarshalJSON ¶
func (m BookmarkItem) 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 (*BookmarkItem) UnmarshalJSON ¶
func (m *BookmarkItem) UnmarshalJSON(data []byte) error
UnmarshalJSON dispatches the payload to the variant matching the Type discriminator. Unknown values leave the variant pointers nil but preserve the discriminator string.
type BookmarkItemType ¶
type BookmarkItemType = string
BookmarkItemType is the set of values accepted by BookmarkItem.Type.
const ( BookmarkItemTypeBookmark BookmarkItemType = "BOOKMARK" BookmarkItemTypeFolder BookmarkItemType = "FOLDER" )
BookmarkItemType 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 BookmarkItemTypeValues ¶
func BookmarkItemTypeValues() []BookmarkItemType
BookmarkItemTypeValues returns every value the Jamf API accepts for BookmarkItemType, 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 Calculator ¶
type Calculator struct {
// If present, configures the basic mode of the calculator. Basic mode is always enabled.
BasicMode *BasicMode `json:"BasicMode,omitempty"`
// If present, controls global input options of the calculator. If not present, all input modes are
// enabled.
InputModes *InputModes `json:"InputModes,omitempty"`
// If present, configures the Math Notes mode of the calculator. If not present, math notes mode is
// enabled.
MathNotesMode *MathNotesMode `json:"MathNotesMode,omitempty"`
// If present, configures the programmer mode of the calculator. If not present, programmer mode is
// enabled.
ProgrammerMode *ProgrammerMode `json:"ProgrammerMode,omitempty"`
// If present, configures the scientific mode of the calculator. If not present, scientific mode is
// enabled.
ScientificMode *ScientificMode `json:"ScientificMode,omitempty"`
}
Calculator represents a calculator.
func (*Calculator) UnmarshalJSON ¶
func (s *Calculator) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ChangeAtNextAuth ¶
type ChangeAtNextAuth 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.
Included *bool `json:"Included,omitempty"`
// Change at next auth.
Value *bool `json:"Value,omitempty"`
}
ChangeAtNextAuth represents a change at next auth.
func (*ChangeAtNextAuth) UnmarshalJSON ¶
func (s *ChangeAtNextAuth) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides typed methods for blueprints operations.
func New ¶
func New(base *jamfplatform.Client) *Client
New creates a blueprints client that shares the authenticated transport of the given root client.
func (*Client) CreateBlueprint ¶
func (c *Client) CreateBlueprint(ctx context.Context, request *CreateBlueprintRequest) (*CreateResponse, error)
CreateBlueprint create a new blueprint.
Required privileges: blueprints:create.
func (*Client) DeleteBlueprint ¶
DeleteBlueprint delete a blueprint.
Required privileges: blueprints:delete.
Parameters:
- blueprintID: Blueprint ID.
func (*Client) DeployBlueprint ¶
DeployBlueprint deploy blueprint.
Required privileges: blueprints:deploy.
Parameters:
- blueprintID: Blueprint ID.
func (*Client) GetBlueprint ¶
GetBlueprint get a blueprint.
Required privileges: blueprints:read.
Parameters:
- blueprintID: Blueprint ID.
func (*Client) GetBlueprintComponent ¶
func (c *Client) GetBlueprintComponent(ctx context.Context, identifier string) (*ComponentDescription, error)
GetBlueprintComponent get component.
Required privileges: blueprints:read.
Parameters:
- identifier: Identifier of the component.
func (*Client) GetBlueprintReport ¶
func (c *Client) GetBlueprintReport(ctx context.Context, blueprintID string) (*BlueprintStatusDetail, error)
GetBlueprintReport get blueprint status report.
Required privileges: blueprints:read.
Parameters:
- blueprintID: Blueprint ID.
func (*Client) ListBlueprintComponents ¶
func (c *Client) ListBlueprintComponents(ctx context.Context) ([]ComponentDescription, error)
ListBlueprintComponents list available blueprint components.
Required privileges: blueprints:read.
func (*Client) ListBlueprints ¶
func (c *Client) ListBlueprints(ctx context.Context, sort []string, search string) ([]BlueprintOverview, error)
ListBlueprints list blueprints.
Required privileges: blueprints:read.
Parameters:
- sort: Sorting criteria in the format: `<field_name>[:sort_direction][,<secondary_sort_field_name>[:sort_direction]]*`. Default sort direction is `asc` (Ascending). Use `desc` for Descending ordering. Additional sort parameters are supported and determine order of results that have equivalent values for previous sort parameters.
- search: Search query to match against `name` and `description` properties.
func (*Client) ResolveBlueprintByName ¶
func (c *Client) ResolveBlueprintByName(ctx context.Context, name string) (*BlueprintOverview, error)
ResolveBlueprintByName looks up a Blueprint 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) ResolveBlueprintComponentByName ¶
func (c *Client) ResolveBlueprintComponentByName(ctx context.Context, name string) (*ComponentDescription, error)
ResolveBlueprintComponentByName looks up a BlueprintComponent 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) ResolveBlueprintComponentIDByName ¶
func (c *Client) ResolveBlueprintComponentIDByName(ctx context.Context, name string) (string, error)
ResolveBlueprintComponentIDByName looks up a BlueprintComponent 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) ResolveBlueprintIDByName ¶
ResolveBlueprintIDByName looks up a Blueprint 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) UndeployBlueprint ¶
UndeployBlueprint undeploy blueprint.
Required privileges: blueprints:deploy.
Parameters:
- blueprintID: Blueprint ID.
func (*Client) UpdateBlueprint ¶
func (c *Client) UpdateBlueprint(ctx context.Context, blueprintID string, request *UpdateBlueprintRequest) error
UpdateBlueprint updates a blueprint configuration.
Required privileges: blueprints:update.
Parameters:
- blueprintID: Blueprint ID.
type Component ¶
type Component struct {
Configuration json.RawMessage `json:"configuration"`
Identifier string `json:"identifier"`
}
Component A blueprint component.
type ComponentDescription ¶
type ComponentDescription struct {
// Description of the component.
Description *string `json:"description,omitempty"`
// Blueprint component identifier.
Identifier string `json:"identifier"`
// Meta object containing additional information about component.
Meta *Meta `json:"meta,omitempty"`
// Name of the component.
Name string `json:"name"`
}
ComponentDescription Array of result items.
type ConfigurationProfile ¶
type ConfigurationProfile struct {
// Configuration wrapper for one or more Apple MDM profile payloads.
// ### Example — `com.apple.domains`.
// Using the payload defined in
// [com.apple.domains.yaml](https://github.com/apple/device-management/blob/release/mdm/profiles/com.apple.domains.yaml),
// its `payloadkeys` are `EmailDomains`, `WebDomains`, `SafariPasswordAutoFillDomains`,
// `CrossSiteTrackingPreventionRelaxedDomains`, and `CrossSiteTrackingPreventionRelaxedApps` — all
// optional arrays of strings.
// “`json { "payloadDisplayName": "Managed Domains", "payloadContent": [ { "payloadType":
// "com.apple.domains", "EmailDomains": ["example.com", "private.example.com"], "WebDomains":
// ["*.example.com"], "SafariPasswordAutoFillDomains": ["login.example.com"] } ] } “`.
// ### Example — `com.apple.wifi.managed`.
// The same pattern works for any payload. For
// [com.apple.wifi.managed](https://github.com/apple/device-management/blob/release/mdm/profiles/com.apple.wifi.managed.yaml),
// look up its `payloadkeys` and send:
// “`json { "payloadDisplayName": "Corporate Wi-Fi", "payloadContent": [ { "payloadType":
// "com.apple.wifi.managed", "SSID_STR": "Corporate-WiFi", "EncryptionType": "WPA2", "AutoJoin": true,
// "IsHotspot": false } ] } “`.
// ### Combining multiple Apple payloads in one component.
// A single `com.jamf.ddm-configuration-profile` component can contain multiple Apple payloads in the
// `payloadContent` array:
// “`json { "payloadDisplayName": "Network & Domains", "payloadContent": [ { "payloadType":
// "com.apple.domains", "WebDomains": ["*.corp.example.com"], "EmailDomains": ["corp.example.com"] }, {
// "payloadType": "com.apple.wifi.managed", "SSID_STR": "CorpNet", "EncryptionType": "WPA3" } ] } “`.
// You can also place multiple `com.jamf.ddm-configuration-profile` components in the same blueprint
// step alongside other component types.
Configuration ConfigurationProfileConfiguration `json:"configuration"`
// ## Using Apple MDM profile payloads as blueprint components.
// The API accepts **any** Apple MDM configuration profile payload as a blueprint component — not
// only the ones explicitly listed in this specification. Use the `com.jamf.ddm-configuration-profile`
// identifier with the pattern described here to send one or more Apple payloads.
// Apple publishes all payload definitions at
// [apple/device-management/mdm/profiles](https://github.com/apple/device-management/tree/release/mdm/profiles).
// ### Step 1 — Choose the Apple payload(s).
// Find the payload YAML in the Apple repository. The `payloadtype` field (e.g., `com.apple.domains`,
// `com.apple.wifi.managed`, `com.apple.applicationaccess`) identifies each payload.
// > **Unsupported payload types:** Blueprints with > `com.apple.font` or `com.apple.webClip.managed`
// payloads > cannot be created.
// ### Step 2 — Build the `configuration` object.
// The `configuration` has two mandatory fields:
// | Field | Type | Description |
// |---|---|---|
// | `payloadDisplayName` | string | A human-readable name shown on the device (e.g., `"Managed Domains"`) |
// | `payloadContent` | array | An array of payload objects — each one represents a single Apple payload |
// Each entry in `payloadContent` **must** contain:
// | Field | Type | Description |
// |---|---|---|
// | `payloadType` | string | The Apple payload type identifier (e.g., `com.apple.domains`) |
// In addition to `payloadType`, include the payload-specific keys from the `payloadkeys` section of
// the Apple payload YAML.
// ### Apple type → JSON type mapping.
// | Apple type | JSON value type | Example |
// |---|---|---|
// | `<string>` | string | `"example.com"` |
// | `<integer>` | number | `42` |
// | `<real>` | number | `3.14` |
// | `<boolean>` | boolean | `true` |
// | `<data>` | string (Base64-encoded) | `"SGVsbG8="` |
// | `<date>` | string (ISO 8601) | `"2026-01-15T00:00:00Z"` |
// | `<array>` | array | `["a", "b"]` |
// | `<dictionary>` | object | `{ "key": "value" }` |
// Only include the keys you want to configure. Keys marked `presence: optional` in the Apple YAML can
// be omitted; keys marked `presence: required` must be present.
// ### Reference.
// - Apple payload definitions: https://github.com/apple/device-management/tree/release/mdm/profiles -
// Apple Configuration Profile reference:
// https://developer.apple.com/documentation/devicemanagement/profile-specific-payload-keys.
// Allowed values: see the ConfigurationProfileIdentifier constants.
Identifier string `json:"identifier"`
}
ConfigurationProfile Component for sending any Apple MDM configuration profile payload as a blueprint component.
type ConfigurationProfileConfiguration ¶
type ConfigurationProfileConfiguration struct {
// An array of Apple payload objects. Each entry represents a single Apple MDM payload and **must**
// include a `payloadType` field set to the Apple payload type identifier (e.g., `com.apple.domains`,
// `com.apple.wifi.managed`, `com.apple.applicationaccess`).
// In addition to `payloadType`, include any payload-specific keys from the `payloadkeys` section of
// the corresponding Apple payload YAML definition. Any additional properties beyond `payloadType` are
// accepted to accommodate any Apple payload schema.
PayloadContent []json.RawMessage `json:"payloadContent"`
// A human-readable name for this configuration profile, displayed on the device.
PayloadDisplayName string `json:"payloadDisplayName"`
}
ConfigurationProfileConfiguration Configuration wrapper for one or more Apple MDM profile payloads. ### Example — `com.apple.domains` Using the payload defined in [com.apple.domains.yaml](https://github.com/apple/device-management/blob/release/mdm/profiles/com.apple.domains.yaml), its `payloadkeys` are `EmailDomains`, `WebDomains`, `SafariPasswordAutoFillDomains`, `CrossSiteTrackingPreventionRelaxedDomains`, and `CrossSiteTrackingPreventionRelaxedApps` — all optional arrays of strings. ```json { "payloadDisplayName": "Managed Domains", "payloadContent": [ { "payloadType": "com.apple.domains", "EmailDomains": ["example.com", "private.example.com"], "WebDomains": ["*.example.com"], "SafariPasswordAutoFillDomains": ["login.example.com"] } ] } ``` ### Example — `com.apple.wifi.managed` The same pattern works for any payload. For [com.apple.wifi.managed](https://github.com/apple/device-management/blob/release/mdm/profiles/com.apple.wifi.managed.yaml), look up its `payloadkeys` and send: ```json { "payloadDisplayName": "Corporate Wi-Fi", "payloadContent": [ { "payloadType": "com.apple.wifi.managed", "SSID_STR": "Corporate-WiFi", "EncryptionType": "WPA2", "AutoJoin": true, "IsHotspot": false } ] } ``` ### Combining multiple Apple payloads in one component A single `com.jamf.ddm-configuration-profile` component can contain multiple Apple payloads in the `payloadContent` array: ```json { "payloadDisplayName": "Network & Domains", "payloadContent": [ { "payloadType": "com.apple.domains", "WebDomains": ["*.corp.example.com"], "EmailDomains": ["corp.example.com"] }, { "payloadType": "com.apple.wifi.managed", "SSID_STR": "CorpNet", "EncryptionType": "WPA3" } ] } ``` You can also place multiple `com.jamf.ddm-configuration-profile` components in the same blueprint step alongside other component types.
type ConfigurationProfileContentItem ¶
type ConfigurationProfileContentItem struct {
// The Apple payload type identifier (e.g., `com.apple.domains`, `com.apple.wifi.managed`,
// `com.apple.applicationaccess`).
PayloadType string `json:"payloadType"`
}
ConfigurationProfileContentItem A single Apple MDM payload entry. Must contain `payloadType` to identify the Apple payload, plus any payload-specific keys.
type ConfigurationProfileIdentifier ¶
type ConfigurationProfileIdentifier = string
ConfigurationProfileIdentifier is the set of values accepted by ConfigurationProfile.Identifier.
const (
ConfigurationProfileIdentifierComJamfDdmConfigurationProfile ConfigurationProfileIdentifier = "com.jamf.ddm-configuration-profile"
)
ConfigurationProfileIdentifier 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 ConfigurationProfileIdentifierValues ¶
func ConfigurationProfileIdentifierValues() []ConfigurationProfileIdentifier
ConfigurationProfileIdentifierValues returns every value the Jamf API accepts for ConfigurationProfileIdentifier, 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 CreateBlueprintRequest ¶
type CreateBlueprintRequest struct {
// Description of the blueprint.
Description *string `json:"description,omitempty"`
// Name of the blueprint.
Name string `json:"name"`
// Scope of the blueprint.
Scope CreateScope `json:"scope"`
// Array of blueprint steps.
Steps []BlueprintStep `json:"steps"`
}
CreateBlueprintRequest represents a create blueprint request.
type CreateResponse ¶
CreateResponse represents a create response.
type CreateScope ¶
type CreateScope struct {
// Device groups.
DeviceGroups []string `json:"deviceGroups"`
}
CreateScope Scope of the blueprint.
type CustomDeclaration ¶
type CustomDeclaration struct {
// The channel to which the declaration applies: - `SYSTEM` — applies to the system (device) channel
// - `USER` — applies to the user channel.
ChannelType DeclarationChannelType `json:"channelType"`
// The declaration group, determined by the Apple declaration type prefix: - `CONFIGURATION` — for
// `com.apple.configuration.*` types - `ASSET` — for `com.apple.asset.*` types.
Kind DeclarationKind `json:"kind"`
// A JSON object containing the declaration-specific keys from the Apple declaration schema. Include
// the `payloadkeys` fields from the corresponding Apple declaration YAML. Additional properties are
// accepted to accommodate any Apple declaration schema.
Payload map[string]any `json:"payload"`
// An integer that identifies this declaration within the `declarations` list of this request. Use this
// value to cross-reference declarations in other payload fields via the `$PAYLOAD_<payloadKey>`
// placeholder, which is substituted at deploy time with the generated declaration identifier. The
// value is local to the current request. It does not need to be globally unique or consistent across
// requests.
PayloadKey int `json:"payloadKey"`
// The Apple declarative device management declaration type identifier (e.g.,
// `com.apple.configuration.passcode.settings`, `com.apple.asset.useridentity`).
Type string `json:"type"`
}
CustomDeclaration A single Apple declarative device management declaration entry.
func (*CustomDeclaration) UnmarshalJSON ¶
func (s *CustomDeclaration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type CustomDeclarationsComponent ¶
type CustomDeclarationsComponent struct {
// Configuration object containing one or more Apple declarative device management declarations.
// ### Example — single configuration declaration.
// “`json { "declarations": [ { "type": "com.apple.configuration.passcode.settings", "channelType":
// "SYSTEM", "kind": "CONFIGURATION", "payload": { "RequirePasscode": true, "MinimumLength": 8,
// "MaximumFailedAttempts": 10 }, "payloadKey": 1 } ] } “`.
// ### Example — configuration declaration referencing an asset.
// A configuration declaration can reference an asset declaration defined in the same `declarations`
// array using the `$PAYLOAD_<payloadKey>` placeholder. The `payloadKey` values are local to the
// declarations list in this request — they do not need to be globally unique or consistent across
// requests:
// “`json { "declarations": [ { "type": "com.apple.asset.credential.userpassword", "channelType":
// "SYSTEM", "kind": "ASSET", "payload": { "Reference": { "DataURL":
// "https://example.com/asset-data/credential.json", "ContentType": "application/json" } },
// "payloadKey": 1 }, { "type": "com.apple.configuration.account.caldav", "channelType": "SYSTEM",
// "kind": "CONFIGURATION", "payload": { "HostName": "caldav.example.com", "VisibleName": "Work
// Calendar", "AuthenticationCredentialsAssetReference": "$PAYLOAD_1" }, "payloadKey": 2 } ] } “`.
Configuration CustomDeclarationsConfiguration `json:"configuration"`
// ## Use Apple declarative device management declarations as blueprint components.
// The API accepts any Apple declarative device management configuration or asset declaration as a
// blueprint component, not only the ones explicitly listed in this specification. Use the
// `com.jamf.ddm.custom-declarations` identifier with the pattern described here to send one or more
// Apple declarative device management declarations.
// Apple publishes all declaration definitions at
// [apple/device-management/declarative/declarations](https://github.com/apple/device-management/tree/release/declarative/declarations).
// ### Step 1 — Choose the Apple declaration type.
// Find the declaration YAML in the Apple repository. The `declarationtype` field (e.g.,
// `com.apple.configuration.passcode.settings`, `com.apple.asset.useridentity`) identifies each
// declaration.
// ### Step 2 — Set the `kind` field.
// The `kind` maps to the declaration group, derived from the Apple declaration type prefix:
// | `kind` | Apple declaration type prefix |
// |---|---|
// | `CONFIGURATION` | `com.apple.configuration.` |
// | `ASSET` | `com.apple.asset.` |
// ### Step 3 — Set the `channelType` field.
// | `channelType` | Description |
// |---|---|
// | `SYSTEM` | Applies the declaration to the system (device) channel |
// | `USER` | Applies the declaration to the user channel |
// ### Step 4 — Build the `payload` object.
// The `payload` is a JSON object containing the declaration-specific keys from the `payloadkeys`
// section of the corresponding Apple declaration YAML.
// Only include the keys you want to configure. Keys marked `presence: optional` in the Apple YAML can
// be omitted; keys marked `presence: required` must be present.
// ### Step 5 — Use `payloadKey` for cross-declaration references.
// Each declaration in the array has an integer `payloadKey` that identifies it within the
// `declarations` list of this request. To reference another declaration's generated identifier in a
// payload field, use the placeholder `$PAYLOAD_<payloadKey>`. This placeholder is substituted at
// deploy time with the actual declaration identifier of the referenced declaration.
// The `payloadKey` value is local to the declarations in this request — it does not need to be
// globally unique or consistent across requests. This is useful when a configuration declaration must
// reference an asset declaration defined in the same component.
// Allowed values: see the CustomDeclarationsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
CustomDeclarationsComponent Blueprint component that delivers any Apple declarative device management declarations to managed devices.
func (*CustomDeclarationsComponent) UnmarshalJSON ¶
func (s *CustomDeclarationsComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type CustomDeclarationsComponentIdentifier ¶
type CustomDeclarationsComponentIdentifier = string
CustomDeclarationsComponentIdentifier is the set of values accepted by CustomDeclarationsComponent.Identifier.
const (
CustomDeclarationsComponentIdentifierComJamfDdmCustomDeclarations CustomDeclarationsComponentIdentifier = "com.jamf.ddm.custom-declarations"
)
CustomDeclarationsComponentIdentifier 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 CustomDeclarationsComponentIdentifierValues ¶
func CustomDeclarationsComponentIdentifierValues() []CustomDeclarationsComponentIdentifier
CustomDeclarationsComponentIdentifierValues returns every value the Jamf API accepts for CustomDeclarationsComponentIdentifier, 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 CustomDeclarationsConfiguration ¶
type CustomDeclarationsConfiguration struct {
// An array of Apple declarative device management declaration objects to include in this component.
Declarations []CustomDeclaration `json:"declarations"`
}
CustomDeclarationsConfiguration Configuration object containing one or more Apple declarative device management declarations. ### Example — single configuration declaration ```json { "declarations": [ { "type": "com.apple.configuration.passcode.settings", "channelType": "SYSTEM", "kind": "CONFIGURATION", "payload": { "RequirePasscode": true, "MinimumLength": 8, "MaximumFailedAttempts": 10 }, "payloadKey": 1 } ] } ``` ### Example — configuration declaration referencing an asset A configuration declaration can reference an asset declaration defined in the same `declarations` array using the `$PAYLOAD_<payloadKey>` placeholder. The `payloadKey` values are local to the declarations list in this request — they do not need to be globally unique or consistent across requests: ```json { "declarations": [ { "type": "com.apple.asset.credential.userpassword", "channelType": "SYSTEM", "kind": "ASSET", "payload": { "Reference": { "DataURL": "https://example.com/asset-data/credential.json", "ContentType": "application/json" } }, "payloadKey": 1 }, { "type": "com.apple.configuration.account.caldav", "channelType": "SYSTEM", "kind": "CONFIGURATION", "payload": { "HostName": "caldav.example.com", "VisibleName": "Work Calendar", "AuthenticationCredentialsAssetReference": "$PAYLOAD_1" }, "payloadKey": 2 } ] } ```.
func (*CustomDeclarationsConfiguration) UnmarshalJSON ¶
func (s *CustomDeclarationsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type CustomRegex ¶
type CustomRegex struct {
// Map of OS language ID to a localized description. Use the special `default` key for languages that
// the dictionary doesn't contain.
Description *map[string]string `json:"Description,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.
Included *bool `json:"Included,omitempty"`
// Regular expression.
Regex *string `json:"Regex,omitempty"`
}
CustomRegex represents a custom regex.
func (*CustomRegex) UnmarshalJSON ¶
func (s *CustomRegex) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type DeclarationChannelType ¶
type DeclarationChannelType = string
DeclarationChannelType represents a declaration channel type value.
const ( DeclarationChannelTypeSystem DeclarationChannelType = "SYSTEM" DeclarationChannelTypeUser DeclarationChannelType = "USER" )
DeclarationChannelType 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 DeclarationChannelTypeValues ¶
func DeclarationChannelTypeValues() []DeclarationChannelType
DeclarationChannelTypeValues returns every value the Jamf API accepts for DeclarationChannelType, 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 DeclarationKind ¶
type DeclarationKind = string
DeclarationKind represents a declaration kind value.
const ( DeclarationKindConfiguration DeclarationKind = "CONFIGURATION" DeclarationKindAsset DeclarationKind = "ASSET" )
DeclarationKind 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 DeclarationKindValues ¶
func DeclarationKindValues() []DeclarationKind
DeclarationKindValues returns every value the Jamf API accepts for DeclarationKind, 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 Deferrals ¶
type Deferrals struct {
CombinedPeriodInDays *OptionalPeriodInDays `json:"CombinedPeriodInDays,omitempty"`
MajorPeriodInDays *OptionalPeriodInDays `json:"MajorPeriodInDays,omitempty"`
MinorPeriodInDays *OptionalPeriodInDays `json:"MinorPeriodInDays,omitempty"`
SystemPeriodInDays *OptionalPeriodInDays `json:"SystemPeriodInDays,omitempty"`
}
Deferrals represents a deferrals.
func (*Deferrals) UnmarshalJSON ¶
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type Deployment ¶
type Deployment struct {
// Date when deployment job started.
Started time.Time `json:"started"`
// Deployment job state.
// Allowed values: "PENDING", "DEPLOYING", "SUCCEEDED", "FAILED".
State string `json:"state"`
}
Deployment Information about last deployment job.
type DeploymentState ¶
type DeploymentState struct {
// Information about last deployment job.
LastDeployment *Deployment `json:"lastDeployment,omitempty"`
// Blueprint state.
// Allowed values: see the DeploymentStateState constants.
State string `json:"state"`
}
DeploymentState Blueprint deployment state.
type DeploymentStateState ¶
type DeploymentStateState = string
DeploymentStateState is the set of values accepted by DeploymentState.State.
const ( DeploymentStateStateNotDeployed DeploymentStateState = "NOT_DEPLOYED" DeploymentStateStateDeployed DeploymentStateState = "DEPLOYED" DeploymentStateStateOutOfDate DeploymentStateState = "OUT_OF_DATE" )
DeploymentStateState 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 DeploymentStateStateValues ¶
func DeploymentStateStateValues() []DeploymentStateState
DeploymentStateStateValues returns every value the Jamf API accepts for DeploymentStateState, 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 DetailsURL ¶
type DetailsURL struct {
// Controls whether this setting should be used.
Included *bool `json:"Included,omitempty"`
// URL of a web page with the details about the enforced update.
Value *string `json:"Value,omitempty"`
}
DetailsURL Optional URL with details about the enforced update.
func (*DetailsURL) UnmarshalJSON ¶
func (s *DetailsURL) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type DiskManagementComponent ¶
type DiskManagementComponent struct {
// Disk management settings configuration.
// Configures restrictions for external and network storage access.
Configuration DiskManagementSettingsConfiguration `json:"configuration"`
// Allowed values: see the DiskManagementComponentIdentifier constants.
Identifier string `json:"identifier"`
}
DiskManagementComponent represents a disk management component.
func (*DiskManagementComponent) UnmarshalJSON ¶
func (s *DiskManagementComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type DiskManagementComponentIdentifier ¶
type DiskManagementComponentIdentifier = string
DiskManagementComponentIdentifier is the set of values accepted by DiskManagementComponent.Identifier.
const (
DiskManagementComponentIdentifierComJamfDdmDiskManagement DiskManagementComponentIdentifier = "com.jamf.ddm.disk-management"
)
DiskManagementComponentIdentifier 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 DiskManagementComponentIdentifierValues ¶
func DiskManagementComponentIdentifierValues() []DiskManagementComponentIdentifier
DiskManagementComponentIdentifierValues returns every value the Jamf API accepts for DiskManagementComponentIdentifier, 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 DiskManagementSettingsConfiguration ¶
type DiskManagementSettingsConfiguration struct {
// Storage restrictions configuration.
Restrictions *Restrictions `json:"Restrictions,omitempty"`
// Configuration version.
// Allowed values: see the DiskManagementSettingsConfigurationVersion constants.
Version int `json:"version"`
}
DiskManagementSettingsConfiguration Disk management settings configuration. Configures restrictions for external and network storage access.
func (*DiskManagementSettingsConfiguration) UnmarshalJSON ¶
func (s *DiskManagementSettingsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type DiskManagementSettingsConfigurationVersion ¶
type DiskManagementSettingsConfigurationVersion = int
DiskManagementSettingsConfigurationVersion is the set of values accepted by DiskManagementSettingsConfiguration.Version.
const (
DiskManagementSettingsConfigurationVersion2 DiskManagementSettingsConfigurationVersion = 2
)
DiskManagementSettingsConfigurationVersion 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 DiskManagementSettingsConfigurationVersionValues ¶
func DiskManagementSettingsConfigurationVersionValues() []DiskManagementSettingsConfigurationVersion
DiskManagementSettingsConfigurationVersionValues returns every value the Jamf API accepts for DiskManagementSettingsConfigurationVersion, 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 Error ¶
type Error 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,omitempty"`
// id of object with error.
ID *string `json:"id,omitempty"`
}
Error represents a error.
type FailedAttemptsResetInMinutes ¶
type FailedAttemptsResetInMinutes 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.
Included *bool `json:"Included,omitempty"`
// Failed attempts reset in minutes.
Value *int `json:"Value,omitempty"`
}
FailedAttemptsResetInMinutes represents a failed attempts reset in minutes.
func (*FailedAttemptsResetInMinutes) UnmarshalJSON ¶
func (s *FailedAttemptsResetInMinutes) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type FolderBookmarkItem ¶
type FolderBookmarkItem struct {
// An array of bookmarks for each bookmark in the folder.
Folder *[]URLBookmarkItem `json:"Folder,omitempty"`
// The title of the folder shown in Safari.
Title string `json:"Title"`
// Allowed values: see the FolderBookmarkItemType constants.
Type string `json:"Type"`
}
FolderBookmarkItem represents a folder bookmark item.
type FolderBookmarkItemType ¶
type FolderBookmarkItemType = string
FolderBookmarkItemType is the set of values accepted by FolderBookmarkItem.Type.
const (
FolderBookmarkItemTypeFolder FolderBookmarkItemType = "FOLDER"
)
FolderBookmarkItemType 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 FolderBookmarkItemTypeValues ¶
func FolderBookmarkItemTypeValues() []FolderBookmarkItemType
FolderBookmarkItemTypeValues returns every value the Jamf API accepts for FolderBookmarkItemType, 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 InputModes ¶
type InputModes struct {
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
// Configures whether RPN input is enabled.
RPN bool `json:"RPN"`
// Configures whether unit conversions are enabled.
UnitConversion bool `json:"UnitConversion"`
}
InputModes represents a input modes.
func (*InputModes) UnmarshalJSON ¶
func (s *InputModes) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ManagedAppAttributes ¶
type ManagedAppAttributes struct {
// Associated domains for the app.
AssociatedDomains *[]string `json:"AssociatedDomains,omitempty"`
// Enable direct downloads for the app's associated domains.
AssociatedDomainsEnableDirectDownloads *bool `json:"AssociatedDomainsEnableDirectDownloads,omitempty"`
// UUID of the network slice to use for the app's cellular connection.
CellularSliceUUID *string `json:"CellularSliceUUID,omitempty"`
// UUID of the DNS proxy configuration to apply to the app.
DNSProxyUUID *string `json:"DNSProxyUUID,omitempty"`
// Allow the user to hide the app from the home screen (requires iOS 18.1 or later). When `Lockable` is
// `false`, this must also be `false`.
Hideable *bool `json:"Hideable,omitempty"`
// Allow the user to lock the app behind Face ID or Touch ID (requires iOS 18.1 or later).
Lockable *bool `json:"Lockable,omitempty"`
// Require screen lock when the app uses Tap to Pay.
TapToPayScreenLock *bool `json:"TapToPayScreenLock,omitempty"`
}
ManagedAppAttributes Fine-grained app behavior settings. All fields are optional. **iOS 18.1+ note:** `Hideable` and `Lockable` require iOS 18.1 or later. When `Lockable` is `false`, `Hideable` is required and must also be `false`.
func (*ManagedAppAttributes) UnmarshalJSON ¶
func (s *ManagedAppAttributes) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ManagedAppComponent ¶
type ManagedAppComponent struct {
// Configuration for one or more volume purchasing apps.
// ### Example — single required app.
// “`json { "apps": [ { "AssetId": "019a8082-19ba-794c-91f4-2cd5a02b0c72", "AppAndBookTokenId":
// "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Excel", "Install": "Required",
// "AutomaticAppUpdates": "AlwaysOn" } ] } “`.
// ### Example — app with attributes (iOS 18.1+).
// “`json { "apps": [ { "AssetId": "019a8082-19ba-794c-91f4-2cd5a02b0c72", "AppAndBookTokenId":
// "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Excel", "Install": "Required",
// "AllowDownloadsOverCellular": "AlwaysOff", "AutomaticAppUpdates": "AlwaysOn", "IncludeInBackup":
// true, "Attributes": { "Hideable": true, "Lockable": true, "AssociatedDomains": ["corp.example.com"],
// "AssociatedDomainsEnableDirectDownloads": false } } ] } “`.
// ### Example — multiple apps in one component.
// “`json { "apps": [ { "AssetId": "019a8082-19ba-794c-91f4-2cd5a02b0c72", "AppAndBookTokenId":
// "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Excel", "Install": "Required" }, {
// "AssetId": "12345678-0000-0000-0000-000000000001", "AppAndBookTokenId":
// "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Word", "Install": "Optional",
// "AutomaticAppUpdates": "StoreSettings" } ] } “`.
Configuration ManagedAppConfiguration `json:"configuration"`
// ## Using volume purchasing apps as blueprint components.
// The `com.jamf.ddm.app-managed` component installs and manages Apple volume purchasing apps on
// devices. Each component contains one or more app configurations in the `apps` array.
// ### Prerequisites.
// Apps must be available in your Jamf organization's volume purchasing token. The `AssetId` and
// `AppAndBookTokenId` values come from your volume purchasing integration in Jamf — use the [List
// available blueprint components](../listComponents) endpoint (`GET /v1/blueprint-components`) to
// discover apps available to your organization and retrieve their identifiers.
// ### Required fields per app.
// | Field | Type | Description |
// |---|---|---|
// | `AssetId` | string | volume purchasing asset identifier for the app |
// | `AppAndBookTokenId` | string | Identifier of the volume purchasing token that licenses the app |
// | `AppId` | string | App bundle identifier (e.g., `com.microsoft.Excel`) |
// ### Optional management fields.
// | Field | Type | Values | Description |
// |---|---|---|---|
// | `Install` | string | `Required`, `Optional` | Whether the app must be installed. Defaults to `Required`. |
// | `AllowDownloadsOverCellular` | string | `AlwaysOn`, `AlwaysOff`, `StoreSettings` | Controls cellular downloads. Defaults to `StoreSettings`. |
// | `AutomaticAppUpdates` | string | `AlwaysOn`, `AlwaysOff`, `StoreSettings` | Controls automatic updates. Defaults to `StoreSettings`. |
// | `IncludeInBackup` | boolean | `true`, `false` | Whether app data is included in device backups. |
// | `Attributes` | object | — | Fine-grained app behavior settings. See `Attributes` fields below. |
// ### `Attributes` fields (all optional).
// | Field | Type | Description |
// |---|---|---|
// | `Hideable` | boolean | Allow the user to hide the app (requires iOS 18.1 or later). When `Lockable` is `false`, `Hideable` must also be `false`. |
// | `Lockable` | boolean | Allow the user to lock the app behind Face ID / Touch ID (requires iOS 18.1 or later). |
// | `TapToPayScreenLock` | boolean | Require screen lock when Tap to Pay is used. |
// | `AssociatedDomains` | array of strings | Associated domains for the app (e.g., `["example.com"]`). |
// | `AssociatedDomainsEnableDirectDownloads` | boolean | Enable direct downloads for the associated domains. |
// | `CellularSliceUUID` | string (UUID) | Network slicing UUID for the app's cellular connection. |
// | `DNSProxyUUID` | string (UUID) | UUID of the DNS proxy configuration to apply to the app. |
// > **Validation rule:** When `Lockable` is `false`, `Hideable` is required and must also be `false`.
// Allowed values: see the ManagedAppComponentIdentifier constants.
Identifier string `json:"identifier"`
}
ManagedAppComponent Blueprint component that installs and manages volume purchasing apps on managed devices.
func (*ManagedAppComponent) UnmarshalJSON ¶
func (s *ManagedAppComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ManagedAppComponentIdentifier ¶
type ManagedAppComponentIdentifier = string
ManagedAppComponentIdentifier is the set of values accepted by ManagedAppComponent.Identifier.
const (
ManagedAppComponentIdentifierComJamfDdmAppManaged ManagedAppComponentIdentifier = "com.jamf.ddm.app-managed"
)
ManagedAppComponentIdentifier 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 ManagedAppComponentIdentifierValues ¶
func ManagedAppComponentIdentifierValues() []ManagedAppComponentIdentifier
ManagedAppComponentIdentifierValues returns every value the Jamf API accepts for ManagedAppComponentIdentifier, 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 ManagedAppConfiguration ¶
type ManagedAppConfiguration struct {
// One or more volume purchasing app configurations to include in this component.
Apps []ManagedAppEntry `json:"apps"`
}
ManagedAppConfiguration Configuration for one or more volume purchasing apps. ### Example — single required app ```json { "apps": [ { "AssetId": "019a8082-19ba-794c-91f4-2cd5a02b0c72", "AppAndBookTokenId": "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Excel", "Install": "Required", "AutomaticAppUpdates": "AlwaysOn" } ] } ``` ### Example — app with attributes (iOS 18.1+) ```json { "apps": [ { "AssetId": "019a8082-19ba-794c-91f4-2cd5a02b0c72", "AppAndBookTokenId": "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Excel", "Install": "Required", "AllowDownloadsOverCellular": "AlwaysOff", "AutomaticAppUpdates": "AlwaysOn", "IncludeInBackup": true, "Attributes": { "Hideable": true, "Lockable": true, "AssociatedDomains": ["corp.example.com"], "AssociatedDomainsEnableDirectDownloads": false } } ] } ``` ### Example — multiple apps in one component ```json { "apps": [ { "AssetId": "019a8082-19ba-794c-91f4-2cd5a02b0c72", "AppAndBookTokenId": "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Excel", "Install": "Required" }, { "AssetId": "12345678-0000-0000-0000-000000000001", "AppAndBookTokenId": "099a8082-ae9d-70be-b377-84e4ba7459c4", "AppId": "com.microsoft.Word", "Install": "Optional", "AutomaticAppUpdates": "StoreSettings" } ] } ```.
func (*ManagedAppConfiguration) UnmarshalJSON ¶
func (s *ManagedAppConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ManagedAppEntry ¶
type ManagedAppEntry struct {
// Controls whether the app can be downloaded over a cellular connection.
// Allowed values: see the ManagedAppEntryAllowDownloadsOverCellular constants.
AllowDownloadsOverCellular *string `json:"AllowDownloadsOverCellular,omitempty"`
// Identifier of the volume purchasing token that licenses this app.
AppAndBookTokenID string `json:"AppAndBookTokenId"`
// App bundle identifier.
AppID string `json:"AppId"`
// volume purchasing asset identifier for the app.
AssetID string `json:"AssetId"`
// Fine-grained app behavior settings. All fields are optional.
// **iOS 18.1+ note:** `Hideable` and `Lockable` require iOS 18.1 or later. When `Lockable` is `false`,
// `Hideable` is required and must also be `false`.
Attributes *ManagedAppAttributes `json:"Attributes,omitempty"`
// Controls whether the app updates automatically.
// Allowed values: see the ManagedAppEntryAutomaticAppUpdates constants.
AutomaticAppUpdates *string `json:"AutomaticAppUpdates,omitempty"`
// Whether the app's data is included in device backups.
IncludeInBackup *bool `json:"IncludeInBackup,omitempty"`
// Whether the app must be installed on devices in scope.
// Allowed values: see the ManagedAppEntryInstall constants.
Install *string `json:"Install,omitempty"`
}
ManagedAppEntry Configuration for a single volume purchasing app.
func (*ManagedAppEntry) UnmarshalJSON ¶
func (s *ManagedAppEntry) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ManagedAppEntryAllowDownloadsOverCellular ¶
type ManagedAppEntryAllowDownloadsOverCellular = string
ManagedAppEntryAllowDownloadsOverCellular is the set of values accepted by ManagedAppEntry.AllowDownloadsOverCellular.
const ( ManagedAppEntryAllowDownloadsOverCellularAlwaysOn ManagedAppEntryAllowDownloadsOverCellular = "AlwaysOn" ManagedAppEntryAllowDownloadsOverCellularAlwaysOff ManagedAppEntryAllowDownloadsOverCellular = "AlwaysOff" ManagedAppEntryAllowDownloadsOverCellularStoreSettings ManagedAppEntryAllowDownloadsOverCellular = "StoreSettings" )
ManagedAppEntryAllowDownloadsOverCellular 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 ManagedAppEntryAllowDownloadsOverCellularValues ¶
func ManagedAppEntryAllowDownloadsOverCellularValues() []ManagedAppEntryAllowDownloadsOverCellular
ManagedAppEntryAllowDownloadsOverCellularValues returns every value the Jamf API accepts for ManagedAppEntryAllowDownloadsOverCellular, 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 ManagedAppEntryAutomaticAppUpdates ¶
type ManagedAppEntryAutomaticAppUpdates = string
ManagedAppEntryAutomaticAppUpdates is the set of values accepted by ManagedAppEntry.AutomaticAppUpdates.
const ( ManagedAppEntryAutomaticAppUpdatesAlwaysOn ManagedAppEntryAutomaticAppUpdates = "AlwaysOn" ManagedAppEntryAutomaticAppUpdatesAlwaysOff ManagedAppEntryAutomaticAppUpdates = "AlwaysOff" ManagedAppEntryAutomaticAppUpdatesStoreSettings ManagedAppEntryAutomaticAppUpdates = "StoreSettings" )
ManagedAppEntryAutomaticAppUpdates 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 ManagedAppEntryAutomaticAppUpdatesValues ¶
func ManagedAppEntryAutomaticAppUpdatesValues() []ManagedAppEntryAutomaticAppUpdates
ManagedAppEntryAutomaticAppUpdatesValues returns every value the Jamf API accepts for ManagedAppEntryAutomaticAppUpdates, 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 ManagedAppEntryInstall ¶
type ManagedAppEntryInstall = string
ManagedAppEntryInstall is the set of values accepted by ManagedAppEntry.Install.
const ( ManagedAppEntryInstallRequired ManagedAppEntryInstall = "Required" ManagedAppEntryInstallOptional ManagedAppEntryInstall = "Optional" )
ManagedAppEntryInstall 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 ManagedAppEntryInstallValues ¶
func ManagedAppEntryInstallValues() []ManagedAppEntryInstall
ManagedAppEntryInstallValues returns every value the Jamf API accepts for ManagedAppEntryInstall, 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 ManagedExtension ¶
type ManagedExtension struct {
// Allowed domains.
AllowedDomains *[]ManagedExtensionDomain `json:"AllowedDomains,omitempty"`
// Denied domains.
DeniedDomains *[]ManagedExtensionDomain `json:"DeniedDomains,omitempty"`
// Private Browsing state.
// Allowed values: see the ManagedExtensionPrivateBrowsing constants.
PrivateBrowsing *string `json:"PrivateBrowsing,omitempty"`
// Extension state.
// Allowed values: see the ManagedExtensionState constants.
State *string `json:"State,omitempty"`
}
ManagedExtension represents a managed extension.
type ManagedExtensionDomain ¶
type ManagedExtensionDomain struct {
// Domain.
Domain string `json:"Domain"`
}
ManagedExtensionDomain represents a managed extension domain.
type ManagedExtensionPrivateBrowsing ¶
type ManagedExtensionPrivateBrowsing = string
ManagedExtensionPrivateBrowsing is the set of values accepted by ManagedExtension.PrivateBrowsing.
const ( ManagedExtensionPrivateBrowsingAllowed ManagedExtensionPrivateBrowsing = "Allowed" ManagedExtensionPrivateBrowsingAlwaysOn ManagedExtensionPrivateBrowsing = "AlwaysOn" ManagedExtensionPrivateBrowsingAlwaysOff ManagedExtensionPrivateBrowsing = "AlwaysOff" )
ManagedExtensionPrivateBrowsing 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 ManagedExtensionPrivateBrowsingValues ¶
func ManagedExtensionPrivateBrowsingValues() []ManagedExtensionPrivateBrowsing
ManagedExtensionPrivateBrowsingValues returns every value the Jamf API accepts for ManagedExtensionPrivateBrowsing, 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 ManagedExtensionState ¶
type ManagedExtensionState = string
ManagedExtensionState is the set of values accepted by ManagedExtension.State.
const ( ManagedExtensionStateAllowed ManagedExtensionState = "Allowed" ManagedExtensionStateAlwaysOn ManagedExtensionState = "AlwaysOn" ManagedExtensionStateAlwaysOff ManagedExtensionState = "AlwaysOff" )
ManagedExtensionState 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 ManagedExtensionStateValues ¶
func ManagedExtensionStateValues() []ManagedExtensionState
ManagedExtensionStateValues returns every value the Jamf API accepts for ManagedExtensionState, 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 MathNotesMode ¶
type MathNotesMode struct {
// Controls whether the mode is enabled.
Enabled bool `json:"Enabled"`
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
}
MathNotesMode represents a math notes mode.
func (*MathNotesMode) UnmarshalJSON ¶
func (s *MathNotesMode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MathSettingsComponent ¶
type MathSettingsComponent struct {
// Math settings configuration.
// Configures Calculator app modes and system-wide math behavior including keyboard suggestions and
// Math Notes.
Configuration MathSettingsConfiguration `json:"configuration"`
// Allowed values: see the MathSettingsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
MathSettingsComponent represents a math settings component.
func (*MathSettingsComponent) UnmarshalJSON ¶
func (s *MathSettingsComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MathSettingsComponentIdentifier ¶
type MathSettingsComponentIdentifier = string
MathSettingsComponentIdentifier is the set of values accepted by MathSettingsComponent.Identifier.
const (
MathSettingsComponentIdentifierComJamfDdmMathSettings MathSettingsComponentIdentifier = "com.jamf.ddm.math-settings"
)
MathSettingsComponentIdentifier 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 MathSettingsComponentIdentifierValues ¶
func MathSettingsComponentIdentifierValues() []MathSettingsComponentIdentifier
MathSettingsComponentIdentifierValues returns every value the Jamf API accepts for MathSettingsComponentIdentifier, 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 MathSettingsConfiguration ¶
type MathSettingsConfiguration struct {
// If present, configures the built-in Calculator app.
Calculator *Calculator `json:"Calculator,omitempty"`
// If present, configures math behavior in the system.
SystemBehavior *SystemBehavior `json:"SystemBehavior,omitempty"`
}
MathSettingsConfiguration Math settings configuration. Configures Calculator app modes and system-wide math behavior including keyboard suggestions and Math Notes.
func (*MathSettingsConfiguration) UnmarshalJSON ¶
func (s *MathSettingsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MaximumFailedAttempts ¶
type MaximumFailedAttempts 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.
Included *bool `json:"Included,omitempty"`
// Maximum failed attempts.
Value *int `json:"Value,omitempty"`
}
MaximumFailedAttempts represents a maximum failed attempts.
func (*MaximumFailedAttempts) UnmarshalJSON ¶
func (s *MaximumFailedAttempts) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MaximumGracePeriodInMinutes ¶
type MaximumGracePeriodInMinutes 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.
Included *bool `json:"Included,omitempty"`
// Maximum grace period in minutes.
Value *int `json:"Value,omitempty"`
}
MaximumGracePeriodInMinutes represents a maximum grace period in minutes.
func (*MaximumGracePeriodInMinutes) UnmarshalJSON ¶
func (s *MaximumGracePeriodInMinutes) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MaximumInactivityInMinutes ¶
type MaximumInactivityInMinutes 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.
Included *bool `json:"Included,omitempty"`
// Maximum inactivity in minutes.
Value *int `json:"Value,omitempty"`
}
MaximumInactivityInMinutes represents a maximum inactivity in minutes.
func (*MaximumInactivityInMinutes) UnmarshalJSON ¶
func (s *MaximumInactivityInMinutes) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MaximumPasscodeAgeInDays ¶
type MaximumPasscodeAgeInDays 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.
Included *bool `json:"Included,omitempty"`
// Maximum passcode age in days.
Value *int `json:"Value,omitempty"`
}
MaximumPasscodeAgeInDays represents a maximum passcode age in days.
func (*MaximumPasscodeAgeInDays) UnmarshalJSON ¶
func (s *MaximumPasscodeAgeInDays) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type Meta ¶
type Meta struct {
// Supported version of OS families.
SupportedOs map[string][]SupportedOs `json:"supportedOs"`
}
Meta Meta object containing additional information about component.
type MinimumComplexCharacters ¶
type MinimumComplexCharacters 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.
Included *bool `json:"Included,omitempty"`
// Minimum complex characters.
Value *int `json:"Value,omitempty"`
}
MinimumComplexCharacters represents a minimum complex characters.
func (*MinimumComplexCharacters) UnmarshalJSON ¶
func (s *MinimumComplexCharacters) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type MinimumLength ¶
type MinimumLength 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.
Included *bool `json:"Included,omitempty"`
// Minimum length.
Value *int `json:"Value,omitempty"`
}
MinimumLength represents a minimum length.
func (*MinimumLength) UnmarshalJSON ¶
func (s *MinimumLength) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type NewTabStartPage ¶
type NewTabStartPage struct {
// The composed identifier of the extension that provides the start page.
ExtensionIdentifier *string `json:"ExtensionIdentifier,omitempty"`
// The URL of the homepage which needs to start with https:// or http://.
HomepageURL *string `json:"HomepageURL,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.
Included *bool `json:"Included,omitempty"`
// Sets the start page type in Safari.
// Allowed values: see the NewTabStartPagePageType constants.
PageType *string `json:"PageType,omitempty"`
}
NewTabStartPage represents a new tab start page.
func (*NewTabStartPage) UnmarshalJSON ¶
func (s *NewTabStartPage) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type NewTabStartPagePageType ¶
type NewTabStartPagePageType = string
NewTabStartPagePageType is the set of values accepted by NewTabStartPage.PageType.
const ( NewTabStartPagePageTypeStart NewTabStartPagePageType = "Start" NewTabStartPagePageTypeHome NewTabStartPagePageType = "Home" NewTabStartPagePageTypeExtension NewTabStartPagePageType = "Extension" )
NewTabStartPagePageType 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 NewTabStartPagePageTypeValues ¶
func NewTabStartPagePageTypeValues() []NewTabStartPagePageType
NewTabStartPagePageTypeValues returns every value the Jamf API accepts for NewTabStartPagePageType, 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 OptionalPeriodInDays ¶
type OptionalPeriodInDays struct {
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
Value *int `json:"Value,omitempty"`
}
OptionalPeriodInDays represents a optional period in days.
func (*OptionalPeriodInDays) UnmarshalJSON ¶
func (s *OptionalPeriodInDays) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type OptionallyEnabled ¶
type OptionallyEnabled struct {
Enabled bool `json:"Enabled"`
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
}
OptionallyEnabled represents a optionally enabled.
func (*OptionallyEnabled) UnmarshalJSON ¶
func (s *OptionallyEnabled) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type PagedResponseBlueprintOverview ¶
type PagedResponseBlueprintOverview struct {
// Array of result items.
Results []BlueprintOverview `json:"results"`
// Total number of items matching the filter.
TotalCount int64 `json:"totalCount"`
}
PagedResponseBlueprintOverview represents a paged response blueprint overview.
type PagedResponseComponentDescription ¶
type PagedResponseComponentDescription struct {
// Array of result items.
Results []ComponentDescription `json:"results"`
// Total number of items matching the filter.
TotalCount int64 `json:"totalCount"`
}
PagedResponseComponentDescription represents a paged response component description.
type PasscodeReuseLimit ¶
type PasscodeReuseLimit 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.
Included *bool `json:"Included,omitempty"`
// Passcode reuse limit.
Value *int `json:"Value,omitempty"`
}
PasscodeReuseLimit represents a passcode reuse limit.
func (*PasscodeReuseLimit) UnmarshalJSON ¶
func (s *PasscodeReuseLimit) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type PasscodeSettingsComponent ¶
type PasscodeSettingsComponent struct {
// Passcode settings configuration.
// Configures device passcode requirements including complexity, length, and expiration.
Configuration PasscodeSettingsConfiguration `json:"configuration"`
// Allowed values: see the PasscodeSettingsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
PasscodeSettingsComponent represents a passcode settings component.
func (*PasscodeSettingsComponent) UnmarshalJSON ¶
func (s *PasscodeSettingsComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type PasscodeSettingsComponentIdentifier ¶
type PasscodeSettingsComponentIdentifier = string
PasscodeSettingsComponentIdentifier is the set of values accepted by PasscodeSettingsComponent.Identifier.
const (
PasscodeSettingsComponentIdentifierComJamfDdmPasscodeSettings PasscodeSettingsComponentIdentifier = "com.jamf.ddm.passcode-settings"
)
PasscodeSettingsComponentIdentifier 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 PasscodeSettingsComponentIdentifierValues ¶
func PasscodeSettingsComponentIdentifierValues() []PasscodeSettingsComponentIdentifier
PasscodeSettingsComponentIdentifierValues returns every value the Jamf API accepts for PasscodeSettingsComponentIdentifier, 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 PasscodeSettingsConfiguration ¶
type PasscodeSettingsConfiguration struct {
ChangeAtNextAuth *ChangeAtNextAuth `json:"ChangeAtNextAuth,omitempty"`
CustomRegex *CustomRegex `json:"CustomRegex,omitempty"`
FailedAttemptsResetInMinutes *FailedAttemptsResetInMinutes `json:"FailedAttemptsResetInMinutes,omitempty"`
MaximumFailedAttempts *MaximumFailedAttempts `json:"MaximumFailedAttempts,omitempty"`
MaximumGracePeriodInMinutes *MaximumGracePeriodInMinutes `json:"MaximumGracePeriodInMinutes,omitempty"`
MaximumInactivityInMinutes *MaximumInactivityInMinutes `json:"MaximumInactivityInMinutes,omitempty"`
MaximumPasscodeAgeInDays *MaximumPasscodeAgeInDays `json:"MaximumPasscodeAgeInDays,omitempty"`
MinimumComplexCharacters *MinimumComplexCharacters `json:"MinimumComplexCharacters,omitempty"`
MinimumLength *MinimumLength `json:"MinimumLength,omitempty"`
PasscodeReuseLimit *PasscodeReuseLimit `json:"PasscodeReuseLimit,omitempty"`
RequireAlphanumericPasscode *RequireAlphanumericPasscode `json:"RequireAlphanumericPasscode,omitempty"`
RequireComplexPasscode *RequireComplexPasscode `json:"RequireComplexPasscode,omitempty"`
RequirePasscode *RequirePasscode `json:"RequirePasscode,omitempty"`
// Configuration version.
// Allowed values: see the PasscodeSettingsConfigurationVersion constants.
Version int `json:"version"`
}
PasscodeSettingsConfiguration Passcode settings configuration. Configures device passcode requirements including complexity, length, and expiration.
func (*PasscodeSettingsConfiguration) UnmarshalJSON ¶
func (s *PasscodeSettingsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type PasscodeSettingsConfigurationVersion ¶
type PasscodeSettingsConfigurationVersion = int
PasscodeSettingsConfigurationVersion is the set of values accepted by PasscodeSettingsConfiguration.Version.
const (
PasscodeSettingsConfigurationVersion2 PasscodeSettingsConfigurationVersion = 2
)
PasscodeSettingsConfigurationVersion 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 PasscodeSettingsConfigurationVersionValues ¶
func PasscodeSettingsConfigurationVersionValues() []PasscodeSettingsConfigurationVersion
PasscodeSettingsConfigurationVersionValues returns every value the Jamf API accepts for PasscodeSettingsConfigurationVersion, 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 ProgrammerMode ¶
type ProgrammerMode struct {
// Controls whether the mode is enabled.
Enabled bool `json:"Enabled"`
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
}
ProgrammerMode represents a programmer mode.
func (*ProgrammerMode) UnmarshalJSON ¶
func (s *ProgrammerMode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type RapidSecurityResponse ¶
type RapidSecurityResponse struct {
Enable *OptionallyEnabled `json:"Enable,omitempty"`
EnableRollback *OptionallyEnabled `json:"EnableRollback,omitempty"`
}
RapidSecurityResponse represents a rapid security response.
func (*RapidSecurityResponse) UnmarshalJSON ¶
func (s *RapidSecurityResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type RecommendedCadence ¶
type RecommendedCadence struct {
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
// Allowed values: see the RecommendedCadenceValue constants.
Value string `json:"Value"`
}
RecommendedCadence represents a recommended cadence.
func (*RecommendedCadence) UnmarshalJSON ¶
func (s *RecommendedCadence) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type RecommendedCadenceValue ¶
type RecommendedCadenceValue = string
RecommendedCadenceValue is the set of values accepted by RecommendedCadence.Value.
const ( RecommendedCadenceValueAll RecommendedCadenceValue = "All" RecommendedCadenceValueOldest RecommendedCadenceValue = "Oldest" RecommendedCadenceValueNewest RecommendedCadenceValue = "Newest" )
RecommendedCadenceValue 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 RecommendedCadenceValueValues ¶
func RecommendedCadenceValueValues() []RecommendedCadenceValue
RecommendedCadenceValueValues returns every value the Jamf API accepts for RecommendedCadenceValue, 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 RequireAlphanumericPasscode ¶
type RequireAlphanumericPasscode 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.
Included *bool `json:"Included,omitempty"`
// Require alphanumeric passcode.
Value *bool `json:"Value,omitempty"`
}
RequireAlphanumericPasscode represents a require alphanumeric passcode.
func (*RequireAlphanumericPasscode) UnmarshalJSON ¶
func (s *RequireAlphanumericPasscode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type RequireComplexPasscode ¶
type RequireComplexPasscode 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.
Included *bool `json:"Included,omitempty"`
// Require complex passcode.
Value *bool `json:"Value,omitempty"`
}
RequireComplexPasscode represents a require complex passcode.
func (*RequireComplexPasscode) UnmarshalJSON ¶
func (s *RequireComplexPasscode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type RequirePasscode ¶
type RequirePasscode 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.
Included *bool `json:"Included,omitempty"`
// Require passcode.
Value *bool `json:"Value,omitempty"`
}
RequirePasscode represents a require passcode.
func (*RequirePasscode) UnmarshalJSON ¶
func (s *RequirePasscode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type Restrictions ¶
type Restrictions struct {
// Storage access mode configuration.
ExternalStorage *StorageMode `json:"ExternalStorage,omitempty"`
// Storage access mode configuration.
NetworkStorage *StorageMode `json:"NetworkStorage,omitempty"`
}
Restrictions Storage restrictions configuration.
func (*Restrictions) UnmarshalJSON ¶
func (s *Restrictions) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SafariBookmarksComponent ¶
type SafariBookmarksComponent struct {
// Safari bookmarks configuration.
// Defines managed bookmark groups and folders that appear in Safari across managed devices.
Configuration SafariBookmarksConfiguration `json:"configuration"`
// Allowed values: see the SafariBookmarksComponentIdentifier constants.
Identifier string `json:"identifier"`
}
SafariBookmarksComponent represents a safari bookmarks component.
type SafariBookmarksComponentIdentifier ¶
type SafariBookmarksComponentIdentifier = string
SafariBookmarksComponentIdentifier is the set of values accepted by SafariBookmarksComponent.Identifier.
const (
SafariBookmarksComponentIdentifierComJamfDdmSafariBookmarks SafariBookmarksComponentIdentifier = "com.jamf.ddm.safari-bookmarks"
)
SafariBookmarksComponentIdentifier 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 SafariBookmarksComponentIdentifierValues ¶
func SafariBookmarksComponentIdentifierValues() []SafariBookmarksComponentIdentifier
SafariBookmarksComponentIdentifierValues returns every value the Jamf API accepts for SafariBookmarksComponentIdentifier, 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 SafariBookmarksConfiguration ¶
type SafariBookmarksConfiguration struct {
// A dictionary that specifies a set of managed bookmarks.
ManagedBookmarks []BookmarkGroup `json:"ManagedBookmarks"`
}
SafariBookmarksConfiguration Safari bookmarks configuration. Defines managed bookmark groups and folders that appear in Safari across managed devices.
type SafariExtensionsComponent ¶
type SafariExtensionsComponent struct {
// Safari extensions configuration.
// Manages Safari browser extensions including allowed/denied domains and private browsing settings.
Configuration SafariExtensionsConfiguration `json:"configuration"`
// Allowed values: see the SafariExtensionsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
SafariExtensionsComponent represents a safari extensions component.
type SafariExtensionsComponentIdentifier ¶
type SafariExtensionsComponentIdentifier = string
SafariExtensionsComponentIdentifier is the set of values accepted by SafariExtensionsComponent.Identifier.
const (
SafariExtensionsComponentIdentifierComJamfDdmSafariExtensions SafariExtensionsComponentIdentifier = "com.jamf.ddm.safari-extensions"
)
SafariExtensionsComponentIdentifier 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 SafariExtensionsComponentIdentifierValues ¶
func SafariExtensionsComponentIdentifierValues() []SafariExtensionsComponentIdentifier
SafariExtensionsComponentIdentifierValues returns every value the Jamf API accepts for SafariExtensionsComponentIdentifier, 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 SafariExtensionsConfiguration ¶
type SafariExtensionsConfiguration struct {
ManagedExtensions map[string]ManagedExtension `json:"ManagedExtensions"`
}
SafariExtensionsConfiguration Safari extensions configuration. Manages Safari browser extensions including allowed/denied domains and private browsing settings.
type SafariSettingsComponent ¶
type SafariSettingsComponent struct {
// Safari settings configuration.
// Configures Safari browser behavior including cookies, JavaScript, popups, private browsing, and
// start page settings.
Configuration SafariSettingsConfiguration `json:"configuration"`
// Allowed values: see the SafariSettingsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
SafariSettingsComponent represents a safari settings component.
func (*SafariSettingsComponent) UnmarshalJSON ¶
func (s *SafariSettingsComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SafariSettingsComponentIdentifier ¶
type SafariSettingsComponentIdentifier = string
SafariSettingsComponentIdentifier is the set of values accepted by SafariSettingsComponent.Identifier.
const (
SafariSettingsComponentIdentifierComJamfDdmSafariSettings SafariSettingsComponentIdentifier = "com.jamf.ddm.safari-settings"
)
SafariSettingsComponentIdentifier 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 SafariSettingsComponentIdentifierValues ¶
func SafariSettingsComponentIdentifierValues() []SafariSettingsComponentIdentifier
SafariSettingsComponentIdentifierValues returns every value the Jamf API accepts for SafariSettingsComponentIdentifier, 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 SafariSettingsConfiguration ¶
type SafariSettingsConfiguration struct {
// The policy Safari uses for managing cookies.
AcceptCookies *AcceptCookies `json:"AcceptCookies,omitempty"`
// If false, the system forces fraud warnings on in Safari.
AllowDisablingFraudWarning *AllowDisablingFraudWarning `json:"AllowDisablingFraudWarning,omitempty"`
// If false, the system disables clearing history in Safari.
AllowHistoryClearing *AllowHistoryClearing `json:"AllowHistoryClearing,omitempty"`
// If false, the system disables JavaScript in Safari.
AllowJavaScript *AllowJavaScript `json:"AllowJavaScript,omitempty"`
// If false, the system disables popups in Safari.
AllowPopups *AllowPopups `json:"AllowPopups,omitempty"`
// If false, the system disables private browsing in Safari.
AllowPrivateBrowsing *AllowPrivateBrowsing `json:"AllowPrivateBrowsing,omitempty"`
// If false, the system disables summarization of content in Safari.
AllowSummary *AllowSummary `json:"AllowSummary,omitempty"`
// Sets the start page for new tabs in Safari.
NewTabStartPage *NewTabStartPage `json:"NewTabStartPage,omitempty"`
}
SafariSettingsConfiguration Safari settings configuration. Configures Safari browser behavior including cookies, JavaScript, popups, private browsing, and start page settings.
func (*SafariSettingsConfiguration) UnmarshalJSON ¶
func (s *SafariSettingsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type ScientificMode ¶
type ScientificMode struct {
// Controls whether the mode is enabled.
Enabled bool `json:"Enabled"`
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
}
ScientificMode represents a scientific mode.
func (*ScientificMode) UnmarshalJSON ¶
func (s *ScientificMode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SoftwareUpdateSettingsComponent ¶
type SoftwareUpdateSettingsComponent struct {
// Software update settings configuration.
// Configures OS update behavior including notifications, automatic actions, deferrals, and rapid
// security responses.
Configuration SoftwareUpdateSettingsConfiguration `json:"configuration"`
// Allowed values: see the SoftwareUpdateSettingsComponentIdentifier constants.
Identifier string `json:"identifier"`
}
SoftwareUpdateSettingsComponent represents a software update settings component.
func (*SoftwareUpdateSettingsComponent) UnmarshalJSON ¶
func (s *SoftwareUpdateSettingsComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SoftwareUpdateSettingsComponentIdentifier ¶
type SoftwareUpdateSettingsComponentIdentifier = string
SoftwareUpdateSettingsComponentIdentifier is the set of values accepted by SoftwareUpdateSettingsComponent.Identifier.
const (
SoftwareUpdateSettingsComponentIdentifierComJamfDdmSoftwareUpdateSettings SoftwareUpdateSettingsComponentIdentifier = "com.jamf.ddm.software-update-settings"
)
SoftwareUpdateSettingsComponentIdentifier 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 SoftwareUpdateSettingsComponentIdentifierValues ¶
func SoftwareUpdateSettingsComponentIdentifierValues() []SoftwareUpdateSettingsComponentIdentifier
SoftwareUpdateSettingsComponentIdentifierValues returns every value the Jamf API accepts for SoftwareUpdateSettingsComponentIdentifier, 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 SoftwareUpdateSettingsConfiguration ¶
type SoftwareUpdateSettingsConfiguration struct {
AllowStandardUserOSUpdates *OptionallyEnabled `json:"AllowStandardUserOSUpdates,omitempty"`
AutomaticActions *AutomaticActions `json:"AutomaticActions,omitempty"`
Beta *Beta `json:"Beta,omitempty"`
Deferrals *Deferrals `json:"Deferrals,omitempty"`
Notifications *OptionallyEnabled `json:"Notifications,omitempty"`
RapidSecurityResponse *RapidSecurityResponse `json:"RapidSecurityResponse,omitempty"`
RecommendedCadence *RecommendedCadence `json:"RecommendedCadence,omitempty"`
}
SoftwareUpdateSettingsConfiguration Software update settings configuration. Configures OS update behavior including notifications, automatic actions, deferrals, and rapid security responses.
func (*SoftwareUpdateSettingsConfiguration) UnmarshalJSON ¶
func (s *SoftwareUpdateSettingsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type StorageMode ¶
type StorageMode struct {
// Controls whether this setting should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
// Controls whether the mode is enabled.
// Allowed values: see the StorageModeValue constants.
Value string `json:"Value"`
}
StorageMode Storage access mode configuration.
func (*StorageMode) UnmarshalJSON ¶
func (s *StorageMode) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type StorageModeValue ¶
type StorageModeValue = string
StorageModeValue is the set of values accepted by StorageMode.Value.
const ( StorageModeValueAllowed StorageModeValue = "Allowed" StorageModeValueDisallowed StorageModeValue = "Disallowed" StorageModeValueReadOnly StorageModeValue = "ReadOnly" )
StorageModeValue 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 StorageModeValueValues ¶
func StorageModeValueValues() []StorageModeValue
StorageModeValueValues returns every value the Jamf API accepts for StorageModeValue, 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 SupportedOs ¶
type SupportedOs struct {
// Version of the OS family.
Version string `json:"version"`
}
SupportedOs Supported version of OS families.
type SwUpdateAutomaticConfiguration ¶
type SwUpdateAutomaticConfiguration struct {
// Allowed values: see the SwUpdateAutomaticConfigurationStrategy constants.
Strategy string `json:"strategy"`
LATEST *SwUpdateLatestConfiguration `json:"-"`
SEMANTIC *SwUpdateSemanticConfiguration `json:"-"`
}
SwUpdateAutomaticConfiguration Automatic software update enforcement configuration. Automatically enforces updates based on strategy (LATEST or SEMANTIC).
func (SwUpdateAutomaticConfiguration) MarshalJSON ¶
func (m SwUpdateAutomaticConfiguration) 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 (*SwUpdateAutomaticConfiguration) UnmarshalJSON ¶
func (m *SwUpdateAutomaticConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON dispatches the payload to the variant matching the strategy discriminator. Unknown values leave the variant pointers nil but preserve the discriminator string.
type SwUpdateAutomaticConfigurationStrategy ¶
type SwUpdateAutomaticConfigurationStrategy = string
SwUpdateAutomaticConfigurationStrategy is the set of values accepted by SwUpdateAutomaticConfiguration.Strategy.
const ( SwUpdateAutomaticConfigurationStrategyLatest SwUpdateAutomaticConfigurationStrategy = "LATEST" SwUpdateAutomaticConfigurationStrategySemantic SwUpdateAutomaticConfigurationStrategy = "SEMANTIC" )
SwUpdateAutomaticConfigurationStrategy 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 SwUpdateAutomaticConfigurationStrategyValues ¶
func SwUpdateAutomaticConfigurationStrategyValues() []SwUpdateAutomaticConfigurationStrategy
SwUpdateAutomaticConfigurationStrategyValues returns every value the Jamf API accepts for SwUpdateAutomaticConfigurationStrategy, 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 SwUpdateComponent ¶
type SwUpdateComponent struct {
// Software update enforcement configuration.
// Configures OS update enforcement using either manual (specific version by date) or automatic
// strategies.
Configuration SwUpdateConfiguration `json:"configuration"`
// Allowed values: see the SwUpdateComponentIdentifier constants.
Identifier string `json:"identifier"`
}
SwUpdateComponent represents a sw update component.
func (*SwUpdateComponent) UnmarshalJSON ¶
func (s *SwUpdateComponent) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SwUpdateComponentIdentifier ¶
type SwUpdateComponentIdentifier = string
SwUpdateComponentIdentifier is the set of values accepted by SwUpdateComponent.Identifier.
const (
SwUpdateComponentIdentifierComJamfDdmSwUpdates SwUpdateComponentIdentifier = "com.jamf.ddm.sw-updates"
)
SwUpdateComponentIdentifier 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 SwUpdateComponentIdentifierValues ¶
func SwUpdateComponentIdentifierValues() []SwUpdateComponentIdentifier
SwUpdateComponentIdentifierValues returns every value the Jamf API accepts for SwUpdateComponentIdentifier, 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 SwUpdateConfiguration ¶
type SwUpdateConfiguration struct {
// Allowed values: see the SwUpdateConfigurationEnforcementType constants.
EnforcementType string `json:"enforcementType"`
AUTOMATIC *SwUpdateAutomaticConfiguration `json:"-"`
MANUAL *SwUpdateManualConfiguration `json:"-"`
}
SwUpdateConfiguration Software update enforcement configuration. Configures OS update enforcement using either manual (specific version by date) or automatic strategies.
func (SwUpdateConfiguration) MarshalJSON ¶
func (m SwUpdateConfiguration) 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 (*SwUpdateConfiguration) UnmarshalJSON ¶
func (m *SwUpdateConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON dispatches the payload to the variant matching the enforcementType discriminator. Unknown values leave the variant pointers nil but preserve the discriminator string.
type SwUpdateConfigurationEnforcementType ¶
type SwUpdateConfigurationEnforcementType = string
SwUpdateConfigurationEnforcementType is the set of values accepted by SwUpdateConfiguration.EnforcementType.
const ( SwUpdateConfigurationEnforcementTypeAutomatic SwUpdateConfigurationEnforcementType = "AUTOMATIC" SwUpdateConfigurationEnforcementTypeManual SwUpdateConfigurationEnforcementType = "MANUAL" )
SwUpdateConfigurationEnforcementType 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 SwUpdateConfigurationEnforcementTypeValues ¶
func SwUpdateConfigurationEnforcementTypeValues() []SwUpdateConfigurationEnforcementType
SwUpdateConfigurationEnforcementTypeValues returns every value the Jamf API accepts for SwUpdateConfigurationEnforcementType, 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 SwUpdateLatestConfiguration ¶
type SwUpdateLatestConfiguration struct {
// The device local time (HH:MM) when the update should be installed.
DeploymentTime string `json:"deploymentTime"`
// Optional URL with details about the enforced update.
DetailsURL *DetailsURL `json:"detailsURL,omitempty"`
// The number of days after the OS update release.
EnforceAfterDays int `json:"enforceAfterDays"`
// Allowed values: see the SwUpdateLatestConfigurationEnforcementType constants.
EnforcementType string `json:"enforcementType"`
// Allowed values: see the SwUpdateLatestConfigurationStrategy constants.
Strategy string `json:"strategy"`
}
SwUpdateLatestConfiguration Automatic software update with LATEST strategy. Enforces the newest available OS version a specified number of days after release.
func (*SwUpdateLatestConfiguration) UnmarshalJSON ¶
func (s *SwUpdateLatestConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SwUpdateLatestConfigurationEnforcementType ¶
type SwUpdateLatestConfigurationEnforcementType = string
SwUpdateLatestConfigurationEnforcementType is the set of values accepted by SwUpdateLatestConfiguration.EnforcementType.
const (
SwUpdateLatestConfigurationEnforcementTypeAutomatic SwUpdateLatestConfigurationEnforcementType = "AUTOMATIC"
)
SwUpdateLatestConfigurationEnforcementType 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 SwUpdateLatestConfigurationEnforcementTypeValues ¶
func SwUpdateLatestConfigurationEnforcementTypeValues() []SwUpdateLatestConfigurationEnforcementType
SwUpdateLatestConfigurationEnforcementTypeValues returns every value the Jamf API accepts for SwUpdateLatestConfigurationEnforcementType, 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 SwUpdateLatestConfigurationStrategy ¶
type SwUpdateLatestConfigurationStrategy = string
SwUpdateLatestConfigurationStrategy is the set of values accepted by SwUpdateLatestConfiguration.Strategy.
const (
SwUpdateLatestConfigurationStrategyLatest SwUpdateLatestConfigurationStrategy = "LATEST"
)
SwUpdateLatestConfigurationStrategy 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 SwUpdateLatestConfigurationStrategyValues ¶
func SwUpdateLatestConfigurationStrategyValues() []SwUpdateLatestConfigurationStrategy
SwUpdateLatestConfigurationStrategyValues returns every value the Jamf API accepts for SwUpdateLatestConfigurationStrategy, 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 SwUpdateManualConfiguration ¶
type SwUpdateManualConfiguration struct {
// Optional URL with details about the enforced update.
DetailsURL *DetailsURL `json:"detailsURL,omitempty"`
// Allowed values: see the SwUpdateManualConfigurationEnforcementType constants.
EnforcementType string `json:"enforcementType"`
// Local time of the device until which update must be performed.
TargetLocalDateTime time.Time `json:"targetLocalDateTime"`
// Target OS version in semantic versioning format.
TargetOSVersion string `json:"targetOSVersion"`
}
SwUpdateManualConfiguration Manual software update enforcement configuration. Enforces a specific OS version by a specific date/time.
func (*SwUpdateManualConfiguration) UnmarshalJSON ¶
func (s *SwUpdateManualConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SwUpdateManualConfigurationEnforcementType ¶
type SwUpdateManualConfigurationEnforcementType = string
SwUpdateManualConfigurationEnforcementType is the set of values accepted by SwUpdateManualConfiguration.EnforcementType.
const (
SwUpdateManualConfigurationEnforcementTypeManual SwUpdateManualConfigurationEnforcementType = "MANUAL"
)
SwUpdateManualConfigurationEnforcementType 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 SwUpdateManualConfigurationEnforcementTypeValues ¶
func SwUpdateManualConfigurationEnforcementTypeValues() []SwUpdateManualConfigurationEnforcementType
SwUpdateManualConfigurationEnforcementTypeValues returns every value the Jamf API accepts for SwUpdateManualConfigurationEnforcementType, 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 SwUpdateSemanticConfiguration ¶
type SwUpdateSemanticConfiguration struct {
// Optional URL with details about the enforced update.
DetailsURL *DetailsURL `json:"detailsURL,omitempty"`
// Allowed values: see the SwUpdateSemanticConfigurationEnforcementType constants.
EnforcementType string `json:"enforcementType"`
// Rules for semantic update strategy.
Rules UpdateRules `json:"rules"`
// Allowed values: see the SwUpdateSemanticConfigurationStrategy constants.
Strategy string `json:"strategy"`
}
SwUpdateSemanticConfiguration Automatic software update with SEMANTIC strategy. Applies semantic versioning rules to determine update enforcement timing.
func (*SwUpdateSemanticConfiguration) UnmarshalJSON ¶
func (s *SwUpdateSemanticConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type SwUpdateSemanticConfigurationEnforcementType ¶
type SwUpdateSemanticConfigurationEnforcementType = string
SwUpdateSemanticConfigurationEnforcementType is the set of values accepted by SwUpdateSemanticConfiguration.EnforcementType.
const (
SwUpdateSemanticConfigurationEnforcementTypeAutomatic SwUpdateSemanticConfigurationEnforcementType = "AUTOMATIC"
)
SwUpdateSemanticConfigurationEnforcementType 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 SwUpdateSemanticConfigurationEnforcementTypeValues ¶
func SwUpdateSemanticConfigurationEnforcementTypeValues() []SwUpdateSemanticConfigurationEnforcementType
SwUpdateSemanticConfigurationEnforcementTypeValues returns every value the Jamf API accepts for SwUpdateSemanticConfigurationEnforcementType, 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 SwUpdateSemanticConfigurationStrategy ¶
type SwUpdateSemanticConfigurationStrategy = string
SwUpdateSemanticConfigurationStrategy is the set of values accepted by SwUpdateSemanticConfiguration.Strategy.
const (
SwUpdateSemanticConfigurationStrategySemantic SwUpdateSemanticConfigurationStrategy = "SEMANTIC"
)
SwUpdateSemanticConfigurationStrategy 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 SwUpdateSemanticConfigurationStrategyValues ¶
func SwUpdateSemanticConfigurationStrategyValues() []SwUpdateSemanticConfigurationStrategy
SwUpdateSemanticConfigurationStrategyValues returns every value the Jamf API accepts for SwUpdateSemanticConfigurationStrategy, 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 SystemBehavior ¶
type SystemBehavior struct {
// Controls whether this control should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
// Controls whether keyboard suggestions include math solutions.
KeyboardSuggestions bool `json:"KeyboardSuggestions"`
// Controls whether Math Notes is allowed in other apps such as Notes.
MathNotes bool `json:"MathNotes"`
}
SystemBehavior represents a system behavior.
func (*SystemBehavior) UnmarshalJSON ¶
func (s *SystemBehavior) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type TemporaryPairing ¶
type TemporaryPairing struct {
// Temporary pairing configuration details.
Configuration *TemporaryPairingConfig `json:"Configuration,omitempty"`
// If true, temporary pairing of audio accessories is disabled.
Disabled *bool `json:"Disabled,omitempty"`
// Controls whether this setting should be used.
// Write-only. Servers MUST NOT return this field in responses; the SDK preserves it only so the caller
// can supply a value on update.
Included *bool `json:"Included,omitempty"`
}
TemporaryPairing Temporary pairing configuration.
func (*TemporaryPairing) UnmarshalJSON ¶
func (s *TemporaryPairing) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type TemporaryPairingConfig ¶
type TemporaryPairingConfig struct {
// Automatic unpairing time configuration.
UnpairingTime UnpairingTime `json:"UnpairingTime"`
}
TemporaryPairingConfig Temporary pairing configuration details.
func (*TemporaryPairingConfig) UnmarshalJSON ¶
func (s *TemporaryPairingConfig) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type URLBookmarkItem ¶
type URLBookmarkItem struct {
// The title of the bookmark shown in Safari.
Title string `json:"Title"`
// Allowed values: see the URLBookmarkItemType constants.
Type string `json:"Type"`
// The URL for the bookmark item.
URL string `json:"URL"`
}
URLBookmarkItem represents a u r l bookmark item.
type URLBookmarkItemType ¶
type URLBookmarkItemType = string
URLBookmarkItemType is the set of values accepted by URLBookmarkItem.Type.
const (
URLBookmarkItemTypeBookmark URLBookmarkItemType = "BOOKMARK"
)
URLBookmarkItemType 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 URLBookmarkItemTypeValues ¶
func URLBookmarkItemTypeValues() []URLBookmarkItemType
URLBookmarkItemTypeValues returns every value the Jamf API accepts for URLBookmarkItemType, 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 UnpairingTime ¶
type UnpairingTime struct {
// Local time hour (24-hour clock) for automatic unpairing. Required when Policy is "Hour".
Hour *int `json:"Hour,omitempty"`
// A string that specifies the device's unpairing policy.
// Allowed values: see the UnpairingTimePolicy constants.
Policy string `json:"Policy"`
}
UnpairingTime Automatic unpairing time configuration.
func (*UnpairingTime) UnmarshalJSON ¶
func (s *UnpairingTime) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type UnpairingTimePolicy ¶
type UnpairingTimePolicy = string
UnpairingTimePolicy is the set of values accepted by UnpairingTime.Policy.
const ( UnpairingTimePolicyNone UnpairingTimePolicy = "None" UnpairingTimePolicyHour UnpairingTimePolicy = "Hour" )
UnpairingTimePolicy 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 UnpairingTimePolicyValues ¶
func UnpairingTimePolicyValues() []UnpairingTimePolicy
UnpairingTimePolicyValues returns every value the Jamf API accepts for UnpairingTimePolicy, 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 UpdateBlueprintRequest ¶
type UpdateBlueprintRequest struct {
// Description of the blueprint.
Description *string `json:"description,omitempty"`
// Name of the blueprint.
Name *string `json:"name,omitempty"`
// Device groups.
Scope *BlueprintScope `json:"scope,omitempty"`
// Array of blueprint steps.
Steps *[]BlueprintStep `json:"steps,omitempty"`
}
UpdateBlueprintRequest represents a update blueprint request.
type UpdateRule ¶
type UpdateRule struct {
// The device local time (HH:MM) when the update should be installed.
DeploymentTime string `json:"deploymentTime"`
// The number of days after the OS update release.
EnforceAfterDays int `json:"enforceAfterDays"`
}
UpdateRule Configuration for a specific update type.
func (*UpdateRule) UnmarshalJSON ¶
func (s *UpdateRule) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.
type UpdateRules ¶
type UpdateRules struct {
// Configuration for a specific update type.
Minor UpdateRule `json:"minor"`
}
UpdateRules Rules for semantic update strategy.
func (*UpdateRules) UnmarshalJSON ¶
func (s *UpdateRules) UnmarshalJSON(data []byte) error
UnmarshalJSON decodes s, accepting a JSON string for any number or boolean it declares, because the store this schema comes from serves back the scalar encoding its writer used. A failure names the field it came from.
Marshalling is unaffected, so writing s back sends the bare number or boolean the spec declares rather than the encoding it was read as.