commands

package
v0.3.2 Latest Latest
Warning

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

Go to latest
Published: Sep 10, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package commands holds the MDM commands and their responses generated from Apple's device management schema: 65 schema files and 220 types.

Design

Apple publishes the wire format of the MDM commands and their responses as YAML in https://github.com/apple/device-management, pinned here as a git submodule. Generating this package from that pinned commit derives the wire types, validation, and support metadata from Apple's schema (decision record 0003). Every type carries plist and json struct tags with Apple's wire keys, a Validate method driven by the schema's constraints, and support metadata queryable through Support(path) or the schema/support package.

Edit the generator to change this package. admgen verify fails when regeneration would change it or drop an exported name (schema/EXPORTED_IDENTIFIERS.lock). Protocol semantics that Apple documents only in prose live in the hand-written packages that import this one.

References

Index

Constants

View Source
const (
	// RequestTypeAccountConfiguration: Account Configuration Command
	RequestTypeAccountConfiguration = "AccountConfiguration"
	// RequestTypeActiveNSExtensions: Active NSExtensions Command
	RequestTypeActiveNSExtensions = "ActiveNSExtensions"
	// RequestTypeNSExtensionMappings: NSExtension Mappings Command
	RequestTypeNSExtensionMappings = "NSExtensionMappings"
	// RequestTypeInstallEnterpriseApplication: Install Enterprise Application Command
	RequestTypeInstallEnterpriseApplication = "InstallEnterpriseApplication"
	// RequestTypeInstallApplication: Install Application Command
	RequestTypeInstallApplication = "InstallApplication"
	// RequestTypeInstalledApplicationList: Installed Application List Command
	RequestTypeInstalledApplicationList = "InstalledApplicationList"
	// RequestTypeInviteToProgram: Invite To Program Command
	RequestTypeInviteToProgram = "InviteToProgram"
	// RequestTypeManagedApplicationList: Managed Application List Command
	RequestTypeManagedApplicationList = "ManagedApplicationList"
	// RequestTypeApplyRedemptionCode: Apply Redemption Code Command
	RequestTypeApplyRedemptionCode = "ApplyRedemptionCode"
	// RequestTypeRemoveApplication: Remove Application Command
	RequestTypeRemoveApplication = "RemoveApplication"
	// RequestTypeValidateApplications: Validate Applications Command
	RequestTypeValidateApplications = "ValidateApplications"
	// RequestTypeCertificateList: Certificate List Command
	RequestTypeCertificateList = "CertificateList"
	// RequestTypeDeclarativeManagement: Declarative Management Command
	RequestTypeDeclarativeManagement = "DeclarativeManagement"
	// RequestTypeActivationLockBypassCode: Activation Lock Bypass Code Command
	RequestTypeActivationLockBypassCode = "ActivationLockBypassCode" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeClearActivationLockBypassCode: Clear Activation Lock Bypass Code Command
	RequestTypeClearActivationLockBypassCode = "ClearActivationLockBypassCode" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeDeviceConfigured: Device Configured Command
	RequestTypeDeviceConfigured = "DeviceConfigured"
	// RequestTypeEraseDevice: Erase Device Command
	RequestTypeEraseDevice = "EraseDevice"
	// RequestTypeRefreshCellularPlans: Refresh Cellular Plans Command
	RequestTypeRefreshCellularPlans = "RefreshCellularPlans"
	// RequestTypeDeviceLock: Device Lock Command
	RequestTypeDeviceLock = "DeviceLock"
	// RequestTypeDisableLostMode: Disable Lost Mode Command
	RequestTypeDisableLostMode = "DisableLostMode"
	// RequestTypeEnableLostMode: Enable Lost Mode Command
	RequestTypeEnableLostMode = "EnableLostMode"
	// RequestTypeDeviceLocation: Device Location Command
	RequestTypeDeviceLocation = "DeviceLocation"
	// RequestTypePlayLostModeSound: Play Lost Mode Sound Command
	RequestTypePlayLostModeSound = "PlayLostModeSound"
	// RequestTypeRestartDevice: Restart Device Command
	RequestTypeRestartDevice = "RestartDevice"
	// RequestTypeClearRestrictionsPassword: Clear Restrictions Password Command
	RequestTypeClearRestrictionsPassword = "ClearRestrictionsPassword" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeRestrictions: Restrictions Command
	RequestTypeRestrictions = "Restrictions"
	// RequestTypeShutDownDevice: Shut Down Device Command
	RequestTypeShutDownDevice = "ShutDownDevice"
	// RequestTypeContentCachingInformation: Content Caching Information Command
	RequestTypeContentCachingInformation = "ContentCachingInformation"
	// RequestTypeDeviceInformation: Device Information Command
	RequestTypeDeviceInformation = "DeviceInformation"
	// RequestTypeSecurityInfo: Security Info Command
	RequestTypeSecurityInfo = "SecurityInfo"
	// RequestTypeLOMDeviceRequest: LOM Device Request Command
	RequestTypeLOMDeviceRequest = "LOMDeviceRequest"
	// RequestTypeLOMSetupRequest: LOM Setup Request Command
	RequestTypeLOMSetupRequest = "LOMSetupRequest"
	// RequestTypeManagedApplicationAttributes: Managed Application Attributes Command
	RequestTypeManagedApplicationAttributes = "ManagedApplicationAttributes"
	// RequestTypeManagedApplicationConfiguration: Managed Application Configuration Command
	RequestTypeManagedApplicationConfiguration = "ManagedApplicationConfiguration"
	// RequestTypeManagedApplicationFeedback: Managed Application Feedback Command
	RequestTypeManagedApplicationFeedback = "ManagedApplicationFeedback"
	// RequestTypeInstallMedia: Install Media Command
	RequestTypeInstallMedia = "InstallMedia"
	// RequestTypeManagedMediaList: Managed Media List Command
	RequestTypeManagedMediaList = "ManagedMediaList"
	// RequestTypeRemoveMedia: Remove Media Command
	RequestTypeRemoveMedia = "RemoveMedia"
	// RequestTypeRequestMirroring: Request Mirroring Command
	RequestTypeRequestMirroring = "RequestMirroring"
	// RequestTypeStopMirroring: Stop Mirroring Command
	RequestTypeStopMirroring = "StopMirroring"
	// RequestTypeClearPasscode: Clear Passcode Command
	RequestTypeClearPasscode = "ClearPasscode" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeSetFirmwarePassword: Set Firmware Password Command
	RequestTypeSetFirmwarePassword = "SetFirmwarePassword" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeVerifyFirmwarePassword: Verify Firmware Password Command
	RequestTypeVerifyFirmwarePassword = "VerifyFirmwarePassword" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeSetRecoveryLock: Set Recovery Lock Command
	RequestTypeSetRecoveryLock = "SetRecoveryLock"
	// RequestTypeVerifyRecoveryLock: Verify Recovery Lock Command
	RequestTypeVerifyRecoveryLock = "VerifyRecoveryLock"
	// RequestTypeInstallProfile: Install Profile Command
	RequestTypeInstallProfile = "InstallProfile"
	// RequestTypeProfileList: Profile List Command
	RequestTypeProfileList = "ProfileList"
	// RequestTypeInstallProvisioningProfile: Install Provisioning Profile Command
	RequestTypeInstallProvisioningProfile = "InstallProvisioningProfile"
	// RequestTypeProvisioningProfileList: Provisioning Profile List Command
	RequestTypeProvisioningProfileList = "ProvisioningProfileList"
	// RequestTypeRemoveProvisioningProfile: Remove Provisioning Profile Command
	RequestTypeRemoveProvisioningProfile = "RemoveProvisioningProfile"
	// RequestTypeRemoveProfile: Remove Profile Command
	RequestTypeRemoveProfile = "RemoveProfile"
	// RequestTypeDisableRemoteDesktop: Disable Remote Desktop Command
	RequestTypeDisableRemoteDesktop = "DisableRemoteDesktop"
	// RequestTypeEnableRemoteDesktop: Enable Remote Desktop Command
	RequestTypeEnableRemoteDesktop = "EnableRemoteDesktop"
	// RequestTypeRotateFileVaultKey: Rotate FileVault Key Command
	RequestTypeRotateFileVaultKey = "RotateFileVaultKey"
	// RequestTypeSetAutoAdminPassword: Set Auto Admin Password Command
	RequestTypeSetAutoAdminPassword = "SetAutoAdminPassword" // #nosec G101 -- Apple wire identifier, not a credential
	// RequestTypeSettings: Settings Command
	RequestTypeSettings = "Settings"
	// RequestTypeAvailableOSUpdates: Available OS Updates Command
	RequestTypeAvailableOSUpdates = "AvailableOSUpdates"
	// RequestTypeScheduleOSUpdateScan: Schedule OS Update Scan Command
	RequestTypeScheduleOSUpdateScan = "ScheduleOSUpdateScan"
	// RequestTypeScheduleOSUpdate: Schedule OS Update Command
	RequestTypeScheduleOSUpdate = "ScheduleOSUpdate"
	// RequestTypeOSUpdateStatus: OS Update Status Command
	RequestTypeOSUpdateStatus = "OSUpdateStatus"
	// RequestTypeUserConfigured: User Configured Command
	RequestTypeUserConfigured = "UserConfigured"
	// RequestTypeDeleteUser: Delete User Command
	RequestTypeDeleteUser = "DeleteUser"
	// RequestTypeUserList: User List Command
	RequestTypeUserList = "UserList"
	// RequestTypeLogOutUser: Log Out User Command
	RequestTypeLogOutUser = "LogOutUser"
	// RequestTypeUnlockUserAccount: Unlock User Account Command
	RequestTypeUnlockUserAccount = "UnlockUserAccount"
)

Wire identifiers.

Variables

View Source
var Registry = map[string]Entry{
	"AccountConfiguration":            {ID: "AccountConfiguration", Schema: "mdm/commands/account.configuration.yaml", Title: "Account Configuration Command", New: func() Command { return new(AccountConfiguration) }, NewResponse: func() Response { return new(AccountConfigurationResponse) }},
	"ActivationLockBypassCode":        {ID: "ActivationLockBypassCode", Schema: "mdm/commands/device.activationlock.bypasscode.yaml", Title: "Activation Lock Bypass Code Command", New: func() Command { return new(ActivationLockBypassCode) }, NewResponse: func() Response { return new(ActivationLockBypassCodeResponse) }},
	"ActiveNSExtensions":              {ID: "ActiveNSExtensions", Schema: "mdm/commands/application.extensions.listactive.yaml", Title: "Active NSExtensions Command", New: func() Command { return new(ActiveNSExtensions) }, NewResponse: func() Response { return new(ActiveNSExtensionsResponse) }},
	"ApplyRedemptionCode":             {ID: "ApplyRedemptionCode", Schema: "mdm/commands/application.redemptioncode.yaml", Title: "Apply Redemption Code Command", New: func() Command { return new(ApplyRedemptionCode) }, NewResponse: func() Response { return new(ApplyRedemptionCodeResponse) }},
	"AvailableOSUpdates":              {ID: "AvailableOSUpdates", Schema: "mdm/commands/system.update.available.yaml", Title: "Available OS Updates Command", New: func() Command { return new(AvailableOSUpdates) }, NewResponse: func() Response { return new(AvailableOSUpdatesResponse) }},
	"CertificateList":                 {ID: "CertificateList", Schema: "mdm/commands/certificate.list.yaml", Title: "Certificate List Command", New: func() Command { return new(CertificateList) }, NewResponse: func() Response { return new(CertificateListResponse) }},
	"ClearActivationLockBypassCode":   {ID: "ClearActivationLockBypassCode", Schema: "mdm/commands/device.activationlock.clearbypasscode.yaml", Title: "Clear Activation Lock Bypass Code Command", New: func() Command { return new(ClearActivationLockBypassCode) }, NewResponse: func() Response { return new(ClearActivationLockBypassCodeResponse) }},
	"ClearPasscode":                   {ID: "ClearPasscode", Schema: "mdm/commands/passcode.clear.yaml", Title: "Clear Passcode Command", New: func() Command { return new(ClearPasscode) }, NewResponse: func() Response { return new(ClearPasscodeResponse) }},
	"ClearRestrictionsPassword":       {ID: "ClearRestrictionsPassword", Schema: "mdm/commands/device.restrictions.clearpassword.yaml", Title: "Clear Restrictions Password Command", New: func() Command { return new(ClearRestrictionsPassword) }, NewResponse: func() Response { return new(ClearRestrictionsPasswordResponse) }},
	"ContentCachingInformation":       {ID: "ContentCachingInformation", Schema: "mdm/commands/information.contentcaching.yaml", Title: "Content Caching Information Command", New: func() Command { return new(ContentCachingInformation) }, NewResponse: func() Response { return new(ContentCachingInformationResponse) }},
	"DeclarativeManagement":           {ID: "DeclarativeManagement", Schema: "mdm/commands/declarativemanagement.yaml", Title: "Declarative Management Command", New: func() Command { return new(DeclarativeManagement) }, NewResponse: func() Response { return new(DeclarativeManagementResponse) }},
	"DeleteUser":                      {ID: "DeleteUser", Schema: "mdm/commands/user.delete.yaml", Title: "Delete User Command", New: func() Command { return new(DeleteUser) }, NewResponse: func() Response { return new(DeleteUserResponse) }},
	"DeviceConfigured":                {ID: "DeviceConfigured", Schema: "mdm/commands/device.configured.yaml", Title: "Device Configured Command", New: func() Command { return new(DeviceConfigured) }, NewResponse: func() Response { return new(DeviceConfiguredResponse) }},
	"DeviceInformation":               {ID: "DeviceInformation", Schema: "mdm/commands/information.device.yaml", Title: "Device Information Command", New: func() Command { return new(DeviceInformation) }, NewResponse: func() Response { return new(DeviceInformationResponse) }},
	"DeviceLocation":                  {ID: "DeviceLocation", Schema: "mdm/commands/device.lostmode.location.yaml", Title: "Device Location Command", New: func() Command { return new(DeviceLocation) }, NewResponse: func() Response { return new(DeviceLocationResponse) }},
	"DeviceLock":                      {ID: "DeviceLock", Schema: "mdm/commands/device.lock.yaml", Title: "Device Lock Command", New: func() Command { return new(DeviceLock) }, NewResponse: func() Response { return new(DeviceLockResponse) }},
	"DisableLostMode":                 {ID: "DisableLostMode", Schema: "mdm/commands/device.lostmode.disable.yaml", Title: "Disable Lost Mode Command", New: func() Command { return new(DisableLostMode) }, NewResponse: func() Response { return new(DisableLostModeResponse) }},
	"DisableRemoteDesktop":            {ID: "DisableRemoteDesktop", Schema: "mdm/commands/remotedesktop.disable.yaml", Title: "Disable Remote Desktop Command", New: func() Command { return new(DisableRemoteDesktop) }, NewResponse: func() Response { return new(DisableRemoteDesktopResponse) }},
	"EnableLostMode":                  {ID: "EnableLostMode", Schema: "mdm/commands/device.lostmode.enable.yaml", Title: "Enable Lost Mode Command", New: func() Command { return new(EnableLostMode) }, NewResponse: func() Response { return new(EnableLostModeResponse) }},
	"EnableRemoteDesktop":             {ID: "EnableRemoteDesktop", Schema: "mdm/commands/remotedesktop.enable.yaml", Title: "Enable Remote Desktop Command", New: func() Command { return new(EnableRemoteDesktop) }, NewResponse: func() Response { return new(EnableRemoteDesktopResponse) }},
	"EraseDevice":                     {ID: "EraseDevice", Schema: "mdm/commands/device.erase.yaml", Title: "Erase Device Command", New: func() Command { return new(EraseDevice) }, NewResponse: func() Response { return new(EraseDeviceResponse) }},
	"InstallApplication":              {ID: "InstallApplication", Schema: "mdm/commands/application.install.yaml", Title: "Install Application Command", New: func() Command { return new(InstallApplication) }, NewResponse: func() Response { return new(InstallApplicationResponse) }},
	"InstallEnterpriseApplication":    {ID: "InstallEnterpriseApplication", Schema: "mdm/commands/application.install.enterprise.yaml", Title: "Install Enterprise Application Command", New: func() Command { return new(InstallEnterpriseApplication) }, NewResponse: func() Response { return new(InstallEnterpriseApplicationResponse) }},
	"InstallMedia":                    {ID: "InstallMedia", Schema: "mdm/commands/media.install.yaml", Title: "Install Media Command", New: func() Command { return new(InstallMedia) }, NewResponse: func() Response { return new(InstallMediaResponse) }},
	"InstallProfile":                  {ID: "InstallProfile", Schema: "mdm/commands/profile.install.yaml", Title: "Install Profile Command", New: func() Command { return new(InstallProfile) }, NewResponse: func() Response { return new(InstallProfileResponse) }},
	"InstallProvisioningProfile":      {ID: "InstallProvisioningProfile", Schema: "mdm/commands/profile.provisioning.install.yaml", Title: "Install Provisioning Profile Command", New: func() Command { return new(InstallProvisioningProfile) }, NewResponse: func() Response { return new(InstallProvisioningProfileResponse) }},
	"InstalledApplicationList":        {ID: "InstalledApplicationList", Schema: "mdm/commands/application.installed.list.yaml", Title: "Installed Application List Command", New: func() Command { return new(InstalledApplicationList) }, NewResponse: func() Response { return new(InstalledApplicationListResponse) }},
	"InviteToProgram":                 {ID: "InviteToProgram", Schema: "mdm/commands/application.invitetoprogram.yaml", Title: "Invite To Program Command", New: func() Command { return new(InviteToProgram) }, NewResponse: func() Response { return new(InviteToProgramResponse) }},
	"LOMDeviceRequest":                {ID: "LOMDeviceRequest", Schema: "mdm/commands/lom.devicerequest.yaml", Title: "LOM Device Request Command", New: func() Command { return new(LOMDeviceRequest) }, NewResponse: func() Response { return new(LOMDeviceRequestResponse) }},
	"LOMSetupRequest":                 {ID: "LOMSetupRequest", Schema: "mdm/commands/lom.setuprequest.yaml", Title: "LOM Setup Request Command", New: func() Command { return new(LOMSetupRequest) }, NewResponse: func() Response { return new(LOMSetupRequestResponse) }},
	"LogOutUser":                      {ID: "LogOutUser", Schema: "mdm/commands/user.logout.yaml", Title: "Log Out User Command", New: func() Command { return new(LogOutUser) }, NewResponse: func() Response { return new(LogOutUserResponse) }},
	"ManagedApplicationAttributes":    {ID: "ManagedApplicationAttributes", Schema: "mdm/commands/managed.application.attributes.yaml", Title: "Managed Application Attributes Command", New: func() Command { return new(ManagedApplicationAttributes) }, NewResponse: func() Response { return new(ManagedApplicationAttributesResponse) }},
	"ManagedApplicationConfiguration": {ID: "ManagedApplicationConfiguration", Schema: "mdm/commands/managed.application.configuration.yaml", Title: "Managed Application Configuration Command", New: func() Command { return new(ManagedApplicationConfiguration) }, NewResponse: func() Response { return new(ManagedApplicationConfigurationResponse) }},
	"ManagedApplicationFeedback":      {ID: "ManagedApplicationFeedback", Schema: "mdm/commands/managed.application.feedback.yaml", Title: "Managed Application Feedback Command", New: func() Command { return new(ManagedApplicationFeedback) }, NewResponse: func() Response { return new(ManagedApplicationFeedbackResponse) }},
	"ManagedApplicationList":          {ID: "ManagedApplicationList", Schema: "mdm/commands/application.managed.list.yaml", Title: "Managed Application List Command", New: func() Command { return new(ManagedApplicationList) }, NewResponse: func() Response { return new(ManagedApplicationListResponse) }},
	"ManagedMediaList":                {ID: "ManagedMediaList", Schema: "mdm/commands/media.managed.list.yaml", Title: "Managed Media List Command", New: func() Command { return new(ManagedMediaList) }, NewResponse: func() Response { return new(ManagedMediaListResponse) }},
	"NSExtensionMappings":             {ID: "NSExtensionMappings", Schema: "mdm/commands/application.extensions.mappings.yaml", Title: "NSExtension Mappings Command", New: func() Command { return new(NSExtensionMappings) }, NewResponse: func() Response { return new(NSExtensionMappingsResponse) }},
	"OSUpdateStatus":                  {ID: "OSUpdateStatus", Schema: "mdm/commands/system.update.status.yaml", Title: "OS Update Status Command", New: func() Command { return new(OSUpdateStatus) }, NewResponse: func() Response { return new(OSUpdateStatusResponse) }},
	"PlayLostModeSound":               {ID: "PlayLostModeSound", Schema: "mdm/commands/device.lostmode.playsound.yaml", Title: "Play Lost Mode Sound Command", New: func() Command { return new(PlayLostModeSound) }, NewResponse: func() Response { return new(PlayLostModeSoundResponse) }},
	"ProfileList":                     {ID: "ProfileList", Schema: "mdm/commands/profile.list.yaml", Title: "Profile List Command", New: func() Command { return new(ProfileList) }, NewResponse: func() Response { return new(ProfileListResponse) }},
	"ProvisioningProfileList":         {ID: "ProvisioningProfileList", Schema: "mdm/commands/profile.provisioning.list.yaml", Title: "Provisioning Profile List Command", New: func() Command { return new(ProvisioningProfileList) }, NewResponse: func() Response { return new(ProvisioningProfileListResponse) }},
	"RefreshCellularPlans":            {ID: "RefreshCellularPlans", Schema: "mdm/commands/device.esim.yaml", Title: "Refresh Cellular Plans Command", New: func() Command { return new(RefreshCellularPlans) }, NewResponse: func() Response { return new(RefreshCellularPlansResponse) }},
	"RemoveApplication":               {ID: "RemoveApplication", Schema: "mdm/commands/application.remove.yaml", Title: "Remove Application Command", New: func() Command { return new(RemoveApplication) }, NewResponse: func() Response { return new(RemoveApplicationResponse) }},
	"RemoveMedia":                     {ID: "RemoveMedia", Schema: "mdm/commands/media.remove.yaml", Title: "Remove Media Command", New: func() Command { return new(RemoveMedia) }, NewResponse: func() Response { return new(RemoveMediaResponse) }},
	"RemoveProfile":                   {ID: "RemoveProfile", Schema: "mdm/commands/profile.remove.yaml", Title: "Remove Profile Command", New: func() Command { return new(RemoveProfile) }, NewResponse: func() Response { return new(RemoveProfileResponse) }},
	"RemoveProvisioningProfile":       {ID: "RemoveProvisioningProfile", Schema: "mdm/commands/profile.provisioning.remove.yaml", Title: "Remove Provisioning Profile Command", New: func() Command { return new(RemoveProvisioningProfile) }, NewResponse: func() Response { return new(RemoveProvisioningProfileResponse) }},
	"RequestMirroring":                {ID: "RequestMirroring", Schema: "mdm/commands/mirroring.request.yaml", Title: "Request Mirroring Command", New: func() Command { return new(RequestMirroring) }, NewResponse: func() Response { return new(RequestMirroringResponse) }},
	"RestartDevice":                   {ID: "RestartDevice", Schema: "mdm/commands/device.restart.yaml", Title: "Restart Device Command", New: func() Command { return new(RestartDevice) }, NewResponse: func() Response { return new(RestartDeviceResponse) }},
	"Restrictions":                    {ID: "Restrictions", Schema: "mdm/commands/device.restrictions.list.yaml", Title: "Restrictions Command", New: func() Command { return new(Restrictions) }, NewResponse: func() Response { return new(RestrictionsResponse) }},
	"RotateFileVaultKey":              {ID: "RotateFileVaultKey", Schema: "mdm/commands/rotate.file.vault.key.yaml", Title: "Rotate FileVault Key Command", New: func() Command { return new(RotateFileVaultKey) }, NewResponse: func() Response { return new(RotateFileVaultKeyResponse) }},
	"ScheduleOSUpdate":                {ID: "ScheduleOSUpdate", Schema: "mdm/commands/system.update.schedule.yaml", Title: "Schedule OS Update Command", New: func() Command { return new(ScheduleOSUpdate) }, NewResponse: func() Response { return new(ScheduleOSUpdateResponse) }},
	"ScheduleOSUpdateScan":            {ID: "ScheduleOSUpdateScan", Schema: "mdm/commands/system.update.scan.yaml", Title: "Schedule OS Update Scan Command", New: func() Command { return new(ScheduleOSUpdateScan) }, NewResponse: func() Response { return new(ScheduleOSUpdateScanResponse) }},
	"SecurityInfo":                    {ID: "SecurityInfo", Schema: "mdm/commands/information.security.yaml", Title: "Security Info Command", New: func() Command { return new(SecurityInfo) }, NewResponse: func() Response { return new(SecurityInfoResponse) }},
	"SetAutoAdminPassword":            {ID: "SetAutoAdminPassword", Schema: "mdm/commands/set.auto.admin.password.yaml", Title: "Set Auto Admin Password Command", New: func() Command { return new(SetAutoAdminPassword) }, NewResponse: func() Response { return new(SetAutoAdminPasswordResponse) }},
	"SetFirmwarePassword":             {ID: "SetFirmwarePassword", Schema: "mdm/commands/passcode.firmware.set.yaml", Title: "Set Firmware Password Command", New: func() Command { return new(SetFirmwarePassword) }, NewResponse: func() Response { return new(SetFirmwarePasswordResponse) }},
	"SetRecoveryLock":                 {ID: "SetRecoveryLock", Schema: "mdm/commands/passcode.recovery.set.yaml", Title: "Set Recovery Lock Command", New: func() Command { return new(SetRecoveryLock) }, NewResponse: func() Response { return new(SetRecoveryLockResponse) }},
	"Settings":                        {ID: "Settings", Schema: "mdm/commands/settings.yaml", Title: "Settings Command", New: func() Command { return new(Settings) }, NewResponse: func() Response { return new(SettingsResponse) }},
	"ShutDownDevice":                  {ID: "ShutDownDevice", Schema: "mdm/commands/device.shutdown.yaml", Title: "Shut Down Device Command", New: func() Command { return new(ShutDownDevice) }, NewResponse: func() Response { return new(ShutDownDeviceResponse) }},
	"StopMirroring":                   {ID: "StopMirroring", Schema: "mdm/commands/mirroring.stop.yaml", Title: "Stop Mirroring Command", New: func() Command { return new(StopMirroring) }, NewResponse: func() Response { return new(StopMirroringResponse) }},
	"UnlockUserAccount":               {ID: "UnlockUserAccount", Schema: "mdm/commands/user.unlock.yaml", Title: "Unlock User Account Command", New: func() Command { return new(UnlockUserAccount) }, NewResponse: func() Response { return new(UnlockUserAccountResponse) }},
	"UserConfigured":                  {ID: "UserConfigured", Schema: "mdm/commands/user.configured.yaml", Title: "User Configured Command", New: func() Command { return new(UserConfigured) }, NewResponse: func() Response { return new(UserConfiguredResponse) }},
	"UserList":                        {ID: "UserList", Schema: "mdm/commands/user.list.yaml", Title: "User List Command", New: func() Command { return new(UserList) }, NewResponse: func() Response { return new(UserListResponse) }},
	"ValidateApplications":            {ID: "ValidateApplications", Schema: "mdm/commands/application.validate.yaml", Title: "Validate Applications Command", New: func() Command { return new(ValidateApplications) }, NewResponse: func() Response { return new(ValidateApplicationsResponse) }},
	"VerifyFirmwarePassword":          {ID: "VerifyFirmwarePassword", Schema: "mdm/commands/passcode.firmware.verify.yaml", Title: "Verify Firmware Password Command", New: func() Command { return new(VerifyFirmwarePassword) }, NewResponse: func() Response { return new(VerifyFirmwarePasswordResponse) }},
	"VerifyRecoveryLock":              {ID: "VerifyRecoveryLock", Schema: "mdm/commands/passcode.recovery.verify.yaml", Title: "Verify Recovery Lock Command", New: func() Command { return new(VerifyRecoveryLock) }, NewResponse: func() Response { return new(VerifyRecoveryLockResponse) }},
}

Registry maps Go type names to constructors, one entry per schema file. Several schemas may share a wire identifier (for example six profile payloads use com.apple.MCX), so look up by identifier with ByID.

Functions

func IDs

func IDs() []string

IDs returns the distinct wire identifiers in sorted order.

func Support

func Support(path string) *support.Entry

Support returns the support entry for a key path such as "DeviceLock.Message" or "DeviceLock.response.MessageResult", or nil when unknown.

Types

type AccountConfiguration

type AccountConfiguration struct {
	// If `true`, Setup Assistant skips the user interface for setting up primary accounts and
	// disables autologin. If `true`, you must specify a value for `AutoSetupAdminAccounts`.
	SkipPrimarySetupAccountCreation *bool `plist:"SkipPrimarySetupAccountCreation,omitempty" json:"SkipPrimarySetupAccountCreation,omitempty"`
	// If `true`, Setup Assistant creates the primary accounts as regular users, and you must
	// specify a value for `AutoSetupAdminAccounts`.
	SetPrimarySetupAccountAsRegularUser *bool `plist:"SetPrimarySetupAccountAsRegularUser,omitempty" json:"SetPrimarySetupAccountAsRegularUser,omitempty"`
	// The full name for the primary account. If present, Setup Assistant uses this value to
	// prefill the Full Name field. However, Setup Assistant ignores this value if
	// `DontAutoPopulatePrimaryAccountInfo` is `true`. This value is available in macOS 10.15
	// and later.
	PrimaryAccountFullName *string `plist:"PrimaryAccountFullName,omitempty" json:"PrimaryAccountFullName,omitempty"`
	// The account name for the primary account. If present, Setup Assistant uses this value to
	// prefill the User Name field. However, Setup Assistant ignores this value if
	// `DontAutoPopulatePrimaryAccountInfo` is `true`. This value is available in macOS 10.15
	// and later.
	PrimaryAccountUserName *string `plist:"PrimaryAccountUserName,omitempty" json:"PrimaryAccountUserName,omitempty"`
	// If `true`, Setup Assistant ignores the primary account information and requires the user
	// to enter that information. If `false`, Setup Assistant prefills the Full Name field with
	// `PrimaryAccountFullName` and the User Name field with `PrimaryAccountUserName`. This
	// value is available in macOS 10.15 and later.
	DontAutoPopulatePrimaryAccountInfo *bool `plist:"DontAutoPopulatePrimaryAccountInfo,omitempty" json:"DontAutoPopulatePrimaryAccountInfo,omitempty"`
	// If `true`, and you provide values for `PrimaryAccountFullName` or
	// `PrimaryAccountUserName`, Setup Assistant disables editing for the corresponding fields.
	// `DontAutoPopulatePrimaryAccountInfo` must also be 0 (or missing).
	LockPrimaryAccountInfo *bool `plist:"LockPrimaryAccountInfo,omitempty" json:"LockPrimaryAccountInfo,omitempty"`
	// A dictionary that describes the administrator account to create with Setup Assistant,
	// which uses the first element and ignores additional elements.
	AutoSetupAdminAccounts []AccountConfigurationAutoSetupAdminAccounts `plist:"AutoSetupAdminAccounts,omitempty" json:"AutoSetupAdminAccounts,omitempty"`
	// If present, this is the short name of the local account to manage, which can also be the
	// account that results from setting `AutoSetupAdminAccounts` to `true`. Otherwise, only
	// the local account that Setup Assistant creates is a managed account. This value is
	// available in macOS 11 and later.
	ManagedLocalUserShortName *string `plist:"ManagedLocalUserShortName,omitempty" json:"ManagedLocalUserShortName,omitempty"`
}

AccountConfiguration: Create and configure a local administrator account on a device.

AccountConfiguration corresponds to mdm/commands/account.configuration.yaml (Account Configuration Command).

func (*AccountConfiguration) RequestTypeName

func (*AccountConfiguration) RequestTypeName() string

RequestTypeName returns "AccountConfiguration".

func (*AccountConfiguration) SchemaPath

func (*AccountConfiguration) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*AccountConfiguration) Validate

func (x *AccountConfiguration) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type AccountConfigurationAutoSetupAdminAccounts

type AccountConfigurationAutoSetupAdminAccounts struct {
	// The short name of the user.
	ShortName string `plist:"shortName" json:"shortName"`
	// The full name of the user, which defaults to `shortName` if not specified.
	FullName *string `plist:"fullName,omitempty" json:"fullName,omitempty"`
	// Data that contains the pre-created salted PBKDF2 SHA512 password hash for the account.
	PasswordHash []byte `plist:"passwordHash,omitempty" json:"passwordHash,omitempty"`
	// If `true`, this sets the account attribute to make the account hidden in the Login
	// Window and Users & Groups.
	Hidden *bool `plist:"hidden,omitempty" json:"hidden,omitempty"`
}

AccountConfigurationAutoSetupAdminAccounts: A dictionary that describes the administrator account to create with Setup Assistant, which uses the first element and ignores additional elements.

type AccountConfigurationResponse

type AccountConfigurationResponse struct {
}

AccountConfigurationResponse: Response to AccountConfiguration.

AccountConfigurationResponse corresponds to mdm/commands/account.configuration.yaml (Account Configuration Command).

func (*AccountConfigurationResponse) ResponseRequestTypeName

func (*AccountConfigurationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "AccountConfiguration".

func (*AccountConfigurationResponse) SchemaPath

func (*AccountConfigurationResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*AccountConfigurationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ActivationLockBypassCode

type ActivationLockBypassCode struct {
}

ActivationLockBypassCode: Get the code to bypass Activation Lock on a device.

ActivationLockBypassCode corresponds to mdm/commands/device.activationlock.bypasscode.yaml (Activation Lock Bypass Code Command).

func (*ActivationLockBypassCode) RequestTypeName

func (*ActivationLockBypassCode) RequestTypeName() string

RequestTypeName returns "ActivationLockBypassCode".

func (*ActivationLockBypassCode) SchemaPath

func (*ActivationLockBypassCode) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ActivationLockBypassCode) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ActivationLockBypassCodeResponse

type ActivationLockBypassCodeResponse struct {
	// The Activation Lock bypass code if it's available.
	ActivationLockBypassCode string `plist:"ActivationLockBypassCode" json:"ActivationLockBypassCode"`
}

ActivationLockBypassCodeResponse: Response to ActivationLockBypassCode.

ActivationLockBypassCodeResponse corresponds to mdm/commands/device.activationlock.bypasscode.yaml (Activation Lock Bypass Code Command).

func (*ActivationLockBypassCodeResponse) ResponseRequestTypeName

func (*ActivationLockBypassCodeResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ActivationLockBypassCode".

func (*ActivationLockBypassCodeResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ActivationLockBypassCodeResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ActiveNSExtensions

type ActiveNSExtensions struct {
	// An array of extension points. If you choose to provide this value, the response only
	// includes the app extensions for the extension points you specify.
	FilterExtensionPoints []string `plist:"FilterExtensionPoints,omitempty" json:"FilterExtensionPoints,omitempty"`
}

ActiveNSExtensions: Get a list of active extensions for a user on a device.

ActiveNSExtensions corresponds to mdm/commands/application.extensions.listactive.yaml (Active NSExtensions Command).

func (*ActiveNSExtensions) RequestTypeName

func (*ActiveNSExtensions) RequestTypeName() string

RequestTypeName returns "ActiveNSExtensions".

func (*ActiveNSExtensions) SchemaPath

func (*ActiveNSExtensions) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ActiveNSExtensions) Validate

func (x *ActiveNSExtensions) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ActiveNSExtensionsResponse

type ActiveNSExtensionsResponse struct {
	// An array of dictionaries that contains information about active extensions on the
	// device.
	Extensions []ActiveNSExtensionsResponseExtensions `plist:"Extensions,omitempty" json:"Extensions,omitempty"`
}

ActiveNSExtensionsResponse: Response to ActiveNSExtensions.

ActiveNSExtensionsResponse corresponds to mdm/commands/application.extensions.listactive.yaml (Active NSExtensions Command).

func (*ActiveNSExtensionsResponse) ResponseRequestTypeName

func (*ActiveNSExtensionsResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ActiveNSExtensions".

func (*ActiveNSExtensionsResponse) SchemaPath

func (*ActiveNSExtensionsResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ActiveNSExtensionsResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ActiveNSExtensionsResponseExtensions

type ActiveNSExtensionsResponseExtensions struct {
	// The identifier of the extension.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// The `NSExtensionPointIdentifier` for the extension.
	ExtensionPoint string `plist:"ExtensionPoint" json:"ExtensionPoint"`
	// The extension's display name.
	DisplayName string `plist:"DisplayName" json:"DisplayName"`
	// The display name of the container.
	ContainerDisplayName *string `plist:"ContainerDisplayName,omitempty" json:"ContainerDisplayName,omitempty"`
	// The identifier of the container.
	ContainerIdentifier *string `plist:"ContainerIdentifier,omitempty" json:"ContainerIdentifier,omitempty"`
	// The path to the extension.
	Path string `plist:"Path" json:"Path"`
	// The version of the extension.
	Version string `plist:"Version" json:"Version"`
	// The user-selected state of the extension, which a user sets in the Extensions preference
	// pane in System Preferences.
	UserElection string `plist:"UserElection" json:"UserElection"`
}

ActiveNSExtensionsResponseExtensions: A dictionary that contains information about an extension.

type ApplyRedemptionCode

type ApplyRedemptionCode struct {
	// The bundle identifier of the app.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// The redemption code that applies to the app pending installation.
	RedemptionCode string `plist:"RedemptionCode" json:"RedemptionCode"`
}

ApplyRedemptionCode: Complete the installation of an app using a redemption code.

ApplyRedemptionCode corresponds to mdm/commands/application.redemptioncode.yaml (Apply Redemption Code Command).

func (*ApplyRedemptionCode) RequestTypeName

func (*ApplyRedemptionCode) RequestTypeName() string

RequestTypeName returns "ApplyRedemptionCode".

func (*ApplyRedemptionCode) SchemaPath

func (*ApplyRedemptionCode) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ApplyRedemptionCode) Validate

func (x *ApplyRedemptionCode) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ApplyRedemptionCodeResponse

type ApplyRedemptionCodeResponse struct {
}

ApplyRedemptionCodeResponse: Response to ApplyRedemptionCode.

ApplyRedemptionCodeResponse corresponds to mdm/commands/application.redemptioncode.yaml (Apply Redemption Code Command).

func (*ApplyRedemptionCodeResponse) ResponseRequestTypeName

func (*ApplyRedemptionCodeResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ApplyRedemptionCode".

func (*ApplyRedemptionCodeResponse) SchemaPath

func (*ApplyRedemptionCodeResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ApplyRedemptionCodeResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type AvailableOSUpdates

type AvailableOSUpdates struct {
}

AvailableOSUpdates: Get a list of available operating-system updates for a device.

AvailableOSUpdates corresponds to mdm/commands/system.update.available.yaml (Available OS Updates Command).

func (*AvailableOSUpdates) RequestTypeName

func (*AvailableOSUpdates) RequestTypeName() string

RequestTypeName returns "AvailableOSUpdates".

func (*AvailableOSUpdates) SchemaPath

func (*AvailableOSUpdates) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*AvailableOSUpdates) Validate

func (x *AvailableOSUpdates) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type AvailableOSUpdatesResponse

type AvailableOSUpdatesResponse struct {
	// An array of dictionaries that contains only the most recent available updates in iOS and
	// tvOS, and possibly multiple available updates in macOS. Follow the instructions in the
	// Managed Apps and Updates section of the Apple Software Lookup Service to find a complete
	// catalog of iOS and tvOS updates.
	AvailableOSUpdates []AvailableOSUpdatesResponseAvailableOSUpdates `plist:"AvailableOSUpdates,omitempty" json:"AvailableOSUpdates,omitempty"`
}

AvailableOSUpdatesResponse: Response to AvailableOSUpdates.

AvailableOSUpdatesResponse corresponds to mdm/commands/system.update.available.yaml (Available OS Updates Command).

func (*AvailableOSUpdatesResponse) ResponseRequestTypeName

func (*AvailableOSUpdatesResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "AvailableOSUpdates".

func (*AvailableOSUpdatesResponse) SchemaPath

func (*AvailableOSUpdatesResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*AvailableOSUpdatesResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type AvailableOSUpdatesResponseAvailableOSUpdates

type AvailableOSUpdatesResponseAvailableOSUpdates struct {
	// The product key that represents the update.
	ProductKey string `plist:"ProductKey" json:"ProductKey"`
	// The human-readable name of the update in the current user's current locale.
	HumanReadableName string `plist:"HumanReadableName" json:"HumanReadableName"`
	// The locale, in IOS639-1 Alpha-2 code format, of the `HumanReadableName` value. This
	// value is available in macOS 10.11 and later.
	HumanReadableNameLocale string `plist:"HumanReadableNameLocale" json:"HumanReadableNameLocale"`
	// A URL where the MDM server can request additional localized names for this update. This
	// key isn't present for certain updates, such as mobile software updates (MSUs) or major
	// OS updates. This value is available in macOS 10.11 and later.
	MetadataURL string `plist:"MetadataURL" json:"MetadataURL"`
	// The product name; for example, _iOS_. This value is available in iOS 9.0 and later, and
	// tvOS 12.0 and later.
	ProductName string `plist:"ProductName" json:"ProductName"`
	// The version of the update.
	Version string `plist:"Version" json:"Version"`
	// The build number of the update.
	Build string `plist:"Build" json:"Build"`
	// The storage size necessary to download the software update. Prior to macOS 10.14, this
	// only includes major operating-system updates. In macOS 10.14 and later, this also
	// includes minor updates.
	DownloadSize int64 `plist:"DownloadSize" json:"DownloadSize"`
	// The storage size necessary to install the update. This value is available in iOS 9.0 and
	// later, and tvOS 12.0 and later.
	InstallSize int64 `plist:"InstallSize" json:"InstallSize"`
	// An array that contains app identifiers of apps to close so you can install the update.
	// This value is available in macOS 10.11 and later.
	AppIdentifiersToClose []string `plist:"AppIdentifiersToClose,omitempty" json:"AppIdentifiersToClose,omitempty"`
	// If `true`, this is a critical update.
	IsCritical *bool `plist:"IsCritical,omitempty" json:"IsCritical,omitempty"`
	// If `true`, this is an update to a configuration file. This value is available in macOS
	// 10.11 and later.
	IsConfigDataUpdate *bool `plist:"IsConfigDataUpdate,omitempty" json:"IsConfigDataUpdate,omitempty"`
	// If `true`, this is an update to firmware. This value is available in macOS 10.11 and
	// later.
	IsFirmwareUpdate *bool `plist:"IsFirmwareUpdate,omitempty" json:"IsFirmwareUpdate,omitempty"`
	// If `true`, this is a major update; for example, 10.15.x to 11. This value is available
	// in macOS 10.11 and later.
	IsMajorOSUpdate *bool `plist:"IsMajorOSUpdate,omitempty" json:"IsMajorOSUpdate,omitempty"`
	// If `true`, the device restarts after installing the update.
	RestartRequired *bool `plist:"RestartRequired,omitempty" json:"RestartRequired,omitempty"`
	// If `true`, download the software update and install it later.
	AllowsInstallLater *bool `plist:"AllowsInstallLater,omitempty" json:"AllowsInstallLater,omitempty"`
	// If present, the date when you want the update to install. This value is available in
	// macOS 10.12.4 and later.
	DeferredUntil *time.Time `plist:"DeferredUntil,omitempty" json:"DeferredUntil,omitempty"`
	// If `true`, the device can accept a Bootstrap Token from the MDM server instead of
	// prompting for user authentication prior to installation. This only applies when
	// `BootstrapTokenAllowedForAuthentication` is `true` in the `SecurityInfo` response. This
	// value is available for a Mac with Apple silicon in macOS 11 and later.
	RequiresBootstrapToken *bool `plist:"RequiresBootstrapToken,omitempty" json:"RequiresBootstrapToken,omitempty"`
	// If `true`, this update is a Background Security Improvement.
	IsSecurityResponse bool `plist:"IsSecurityResponse" json:"IsSecurityResponse"`
	// The build version for the Background Security Improvement update, for example, `13A999`,
	// which is the same as `Build`.
	SupplementalBuildVersion *string `plist:"SupplementalBuildVersion,omitempty" json:"SupplementalBuildVersion,omitempty"`
	// The Background Security Improvement OS version suffix, for example, `(a)`. Only present
	// if this is a Background Security Improvement update.
	SupplementalOSVersionExtra *string `plist:"SupplementalOSVersionExtra,omitempty" json:"SupplementalOSVersionExtra,omitempty"`
}

AvailableOSUpdatesResponseAvailableOSUpdates: The response dictionary that describes the available operating-system updates item.

type CertificateList

type CertificateList struct {
	// If `true`, only include certificates that MDM installed or that are in the same profile
	// as the MDM payload. User-enrolled devices ignore this value and always only include
	// managed certificates. This value is available in iOS 13 and later, macOS 10.15 and
	// later, and tvOS 13 and later.
	ManagedOnly *bool `plist:"ManagedOnly,omitempty" json:"ManagedOnly,omitempty"`
}

CertificateList: Get a list of installed certificates on a device.

CertificateList corresponds to mdm/commands/certificate.list.yaml (Certificate List Command).

func (*CertificateList) RequestTypeName

func (*CertificateList) RequestTypeName() string

RequestTypeName returns "CertificateList".

func (*CertificateList) SchemaPath

func (*CertificateList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*CertificateList) Validate

func (x *CertificateList) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type CertificateListResponse

type CertificateListResponse struct {
	// An array of certificate list items that describes each certificate.
	CertificateList []CertificateListResponseCertificateList `plist:"CertificateList,omitempty" json:"CertificateList,omitempty"`
}

CertificateListResponse: Response to CertificateList.

CertificateListResponse corresponds to mdm/commands/certificate.list.yaml (Certificate List Command).

func (*CertificateListResponse) ResponseRequestTypeName

func (*CertificateListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "CertificateList".

func (*CertificateListResponse) SchemaPath

func (*CertificateListResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*CertificateListResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type CertificateListResponseCertificateList

type CertificateListResponseCertificateList struct {
	// The certificate's common name.
	CommonName string `plist:"CommonName" json:"CommonName"`
	// If `true`, this is an identity certificate.
	IsIdentity bool `plist:"IsIdentity" json:"IsIdentity"`
	// The certificate in DER-encoded X.509 format.
	Data []byte `plist:"Data,omitempty" json:"Data,omitempty"`
}

CertificateListResponseCertificateList: A dictionary that contains information about a certificate list item.

type ClearActivationLockBypassCode

type ClearActivationLockBypassCode struct {
}

ClearActivationLockBypassCode: Clear the Activation Lock bypass code on a device.

ClearActivationLockBypassCode corresponds to mdm/commands/device.activationlock.clearbypasscode.yaml (Clear Activation Lock Bypass Code Command).

func (*ClearActivationLockBypassCode) RequestTypeName

func (*ClearActivationLockBypassCode) RequestTypeName() string

RequestTypeName returns "ClearActivationLockBypassCode".

func (*ClearActivationLockBypassCode) SchemaPath

func (*ClearActivationLockBypassCode) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ClearActivationLockBypassCode) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ClearActivationLockBypassCodeResponse

type ClearActivationLockBypassCodeResponse struct {
}

ClearActivationLockBypassCodeResponse: Response to ClearActivationLockBypassCode.

ClearActivationLockBypassCodeResponse corresponds to mdm/commands/device.activationlock.clearbypasscode.yaml (Clear Activation Lock Bypass Code Command).

func (*ClearActivationLockBypassCodeResponse) ResponseRequestTypeName

func (*ClearActivationLockBypassCodeResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ClearActivationLockBypassCode".

func (*ClearActivationLockBypassCodeResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ClearActivationLockBypassCodeResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ClearPasscode

type ClearPasscode struct {
	// The unlock token value that the device provides in its `TokenUpdateMessage` check-in
	// message.
	UnlockToken []byte `plist:"UnlockToken,omitempty" json:"UnlockToken,omitempty"`
}

ClearPasscode: Remove the passcode from a device.

ClearPasscode corresponds to mdm/commands/passcode.clear.yaml (Clear Passcode Command).

func (*ClearPasscode) RequestTypeName

func (*ClearPasscode) RequestTypeName() string

RequestTypeName returns "ClearPasscode".

func (*ClearPasscode) SchemaPath

func (*ClearPasscode) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ClearPasscode) Validate

func (x *ClearPasscode) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ClearPasscodeResponse

type ClearPasscodeResponse struct {
}

ClearPasscodeResponse: Response to ClearPasscode.

ClearPasscodeResponse corresponds to mdm/commands/passcode.clear.yaml (Clear Passcode Command).

func (*ClearPasscodeResponse) ResponseRequestTypeName

func (*ClearPasscodeResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ClearPasscode".

func (*ClearPasscodeResponse) SchemaPath

func (*ClearPasscodeResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ClearPasscodeResponse) Validate

func (x *ClearPasscodeResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ClearRestrictionsPassword

type ClearRestrictionsPassword struct {
}

ClearRestrictionsPassword: Clear the Screen Time password and the restrictions on a device.

ClearRestrictionsPassword corresponds to mdm/commands/device.restrictions.clearpassword.yaml (Clear Restrictions Password Command).

func (*ClearRestrictionsPassword) RequestTypeName

func (*ClearRestrictionsPassword) RequestTypeName() string

RequestTypeName returns "ClearRestrictionsPassword".

func (*ClearRestrictionsPassword) SchemaPath

func (*ClearRestrictionsPassword) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ClearRestrictionsPassword) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ClearRestrictionsPasswordResponse

type ClearRestrictionsPasswordResponse struct {
}

ClearRestrictionsPasswordResponse: Response to ClearRestrictionsPassword.

ClearRestrictionsPasswordResponse corresponds to mdm/commands/device.restrictions.clearpassword.yaml (Clear Restrictions Password Command).

func (*ClearRestrictionsPasswordResponse) ResponseRequestTypeName

func (*ClearRestrictionsPasswordResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ClearRestrictionsPassword".

func (*ClearRestrictionsPasswordResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ClearRestrictionsPasswordResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type Command

type Command interface {
	// RequestTypeName returns the wire identifier from Apple's schema.
	RequestTypeName() string
	// SchemaPath returns the schema file the type was generated from.
	SchemaPath() string
	// Validate checks the value against the schema for the target.
	Validate(t support.Target) error
}

Command is implemented by every top-level type in this package.

type ContentCachingInformation

type ContentCachingInformation struct {
}

ContentCachingInformation: Get the status of the content caches on a device.

ContentCachingInformation corresponds to mdm/commands/information.contentcaching.yaml (Content Caching Information Command).

func (*ContentCachingInformation) RequestTypeName

func (*ContentCachingInformation) RequestTypeName() string

RequestTypeName returns "ContentCachingInformation".

func (*ContentCachingInformation) SchemaPath

func (*ContentCachingInformation) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ContentCachingInformation) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ContentCachingInformationResponse

type ContentCachingInformationResponse struct {
	// A dictionary that contains the status of content caching on a device.
	StatusResponse ContentCachingInformationResponseStatusResponse `plist:"StatusResponse,omitempty" json:"StatusResponse,omitempty"`
}

ContentCachingInformationResponse: Response to ContentCachingInformation.

ContentCachingInformationResponse corresponds to mdm/commands/information.contentcaching.yaml (Content Caching Information Command).

func (*ContentCachingInformationResponse) ResponseRequestTypeName

func (*ContentCachingInformationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ContentCachingInformation".

func (*ContentCachingInformationResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ContentCachingInformationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ContentCachingInformationResponseStatusResponse

type ContentCachingInformationResponseStatusResponse struct {
	// If `true`, the device has enabled content caching. Enabling content caching doesn't
	// guarantee service. See the `Active` key for the readiness of content caching to serve
	// requests.
	Activated *bool `plist:"Activated,omitempty" json:"Activated,omitempty"`
	// If `true`, content caching is ready to serve requests.
	Active *bool `plist:"Active,omitempty" json:"Active,omitempty"`
	// The actual amount of disk space, in bytes, that cached content uses. See related values
	// `CacheUsed` and `PersonalCacheUsed`.
	ActualCacheUsed *int64 `plist:"ActualCacheUsed,omitempty" json:"ActualCacheUsed,omitempty"`
	// The error conditions the content cache detected in the `PeerFilterRanges` in the
	// installed `com.apple.AssetCache.managed` payload.
	AlertsForPeerFilterRanges map[string]ContentCachingInformationResponseStatusResponseAlertsForPeerFilterRanges `plist:"AlertsForPeerFilterRanges,omitempty" json:"AlertsForPeerFilterRanges,omitempty"`
	// An array that contains the error conditions the content cache detected that aren't
	// related to peer filter ranges, parent content caches, or peer content caches.
	Alerts []ContentCachingInformationResponseStatusResponseAlerts `plist:"Alerts,omitempty" json:"Alerts,omitempty"`
	// The amount of disk space that various categories of cached content use. Apple defines
	// these categories and they're subject to change.
	CacheDetails *ContentCachingInformationResponseStatusResponseCacheDetails `plist:"CacheDetails,omitempty" json:"CacheDetails,omitempty"`
	// The amount of disk space, in bytes, available to the content cache.
	CacheFree *int64 `plist:"CacheFree,omitempty" json:"CacheFree,omitempty"`
	// The maximum amount of disk space, in bytes, available to the content cache. A value of
	// `0` indicates an unlimited amount. This value corresponds to `CacheLimit` in the
	// installed `ContentCaching` profile.
	CacheLimit *int64 `plist:"CacheLimit,omitempty" json:"CacheLimit,omitempty"`
	// The level of cache pressure. `LowSpace` means cache pressure is high.
	CacheStatus *string `plist:"CacheStatus,omitempty" json:"CacheStatus,omitempty"`
	// The amount of disk space, in bytes, cached content uses. Content caching allocates space
	// in its cache for entire files even when it stores only part of those files in its cache.
	CacheUsed *int64 `plist:"CacheUsed,omitempty" json:"CacheUsed,omitempty"`
	// If `true`, the content cache finished moving from one volume to another.
	DataMigrationCompleted *bool `plist:"DataMigrationCompleted,omitempty" json:"DataMigrationCompleted,omitempty"`
	// The error that occurred while the content cache moved from one volume to another.
	DataMigrationError *ContentCachingInformationResponseStatusResponseDataMigrationError `plist:"DataMigrationError,omitempty" json:"DataMigrationError,omitempty"`
	// A floating-point number between `0.0` and `1.0` that indicates the percentage of
	// progress in moving the content cache from one volume to another. A value of `1.0`
	// indicates that the content cache has fully migrated.
	DataMigrationProgress *float64 `plist:"DataMigrationProgress,omitempty" json:"DataMigrationProgress,omitempty"`
	// A floating-point number between `0.0` and `1.0` that represents how often the cache
	// needed more disk space over the last hour of operation. A lower value is better.
	MaxCachePressureLast1Hour *float64 `plist:"MaxCachePressureLast1Hour,omitempty" json:"MaxCachePressureLast1Hour,omitempty"`
	// An array of dictionaries that describes parent content caches.
	Parents []ContentCachingInformationResponseStatusResponseParents `plist:"Parents,omitempty" json:"Parents,omitempty"`
	// An array of dictionaries that describes peer content caches.
	Peers []ContentCachingInformationResponseStatusResponsePeers `plist:"Peers,omitempty" json:"Peers,omitempty"`
	// The amount of disk space, in bytes, available to the content cache for personal iCloud
	// content.
	PersonalCacheFree *int64 `plist:"PersonalCacheFree,omitempty" json:"PersonalCacheFree,omitempty"`
	// The maximum amount of disk space, in bytes, available to the content cache for personal
	// iCloud content. A value of `0` indicates an unlimited amount.
	PersonalCacheLimit *int64 `plist:"PersonalCacheLimit,omitempty" json:"PersonalCacheLimit,omitempty"`
	// The amount of disk space, in bytes, available to the content cache for personal iCloud
	// content.
	PersonalCacheUsed *int64 `plist:"PersonalCacheUsed,omitempty" json:"PersonalCacheUsed,omitempty"`
	// The IP port number the content cache listens to for requests from clients, peers, and
	// children.
	Port *int64 `plist:"Port,omitempty" json:"Port,omitempty"`
	// An array of the content cache's local IP addresses.
	PrivateAddresses []string `plist:"PrivateAddresses,omitempty" json:"PrivateAddresses,omitempty"`
	// The public IP address of the content cache.
	PublicAddress *string `plist:"PublicAddress,omitempty" json:"PublicAddress,omitempty"`
	// If present, the reason the content cache failed to register itself with Apple.
	RegistrationError *string `plist:"RegistrationError,omitempty" json:"RegistrationError,omitempty"`
	// If present, the HTTP response code the content cache received when it failed to register
	// itself with Apple.
	RegistrationResponseCode *int64 `plist:"RegistrationResponseCode,omitempty" json:"RegistrationResponseCode,omitempty"`
	// The date when the content cache began registering itself with Apple. This value is only
	// available during registration attempts.
	RegistrationStarted *time.Time `plist:"RegistrationStarted,omitempty" json:"RegistrationStarted,omitempty"`
	// The status of the content cache's registration with Apple, which is one of the following
	// values:
	RegistrationStatus *int64 `plist:"RegistrationStatus,omitempty" json:"RegistrationStatus,omitempty"`
	// If `true`, a restriction prevents caching of certain content types.
	RestrictedMedia *bool `plist:"RestrictedMedia,omitempty" json:"RestrictedMedia,omitempty"`
	// The unique identifier of the content cache.
	ServerGUID *string `plist:"ServerGUID,omitempty" json:"ServerGUID,omitempty"`
	// The status of the content cache's registration with Apple.
	StartupStatus *string `plist:"StartupStatus,omitempty" json:"StartupStatus,omitempty"`
	// The status of tethered caching, which is content caching with a shared internet
	// connection, which is one of the following values:
	TetheratorStatus *int64 `plist:"TetheratorStatus,omitempty" json:"TetheratorStatus,omitempty"`
	// The start date to use when collecting data for the other `TotalBytes` values.
	TotalBytesAreSince *time.Time `plist:"TotalBytesAreSince,omitempty" json:"TotalBytesAreSince,omitempty"`
	// The amount of data, in bytes, that the content cache downloaded, but couldn't add to its
	// cache, since the `TotalBytesAreSince` date.
	TotalBytesDropped *int64 `plist:"TotalBytesDropped,omitempty" json:"TotalBytesDropped,omitempty"`
	// The amount of data, in bytes, that the content cache received since the
	// `TotalBytesAreSince` date.
	TotalBytesImported *int64 `plist:"TotalBytesImported,omitempty" json:"TotalBytesImported,omitempty"`
	// The amount of data, in bytes, that the content cache served to its child content cache
	// since the `TotalBytesAreSince` date.
	TotalBytesReturnedToChildren *int64 `plist:"TotalBytesReturnedToChildren,omitempty" json:"TotalBytesReturnedToChildren,omitempty"`
	// The amount of data, in bytes, that the content cache served to client iOS, macOS, and
	// tvOS devices since the `TotalBytesAreSince` date.
	TotalBytesReturnedToClients *int64 `plist:"TotalBytesReturnedToClients,omitempty" json:"TotalBytesReturnedToClients,omitempty"`
	// The amount of data, in bytes, that the content cache served to peer content caches since
	// the `TotalBytesAreSince` date.
	TotalBytesReturnedToPeers *int64 `plist:"TotalBytesReturnedToPeers,omitempty" json:"TotalBytesReturnedToPeers,omitempty"`
	// The amount of data, in bytes, that the content cache saved from the internet since the
	// `TotalBytesAreSince` date.
	TotalBytesStoredFromOrigin *int64 `plist:"TotalBytesStoredFromOrigin,omitempty" json:"TotalBytesStoredFromOrigin,omitempty"`
	// The amount of data, in bytes, that the content cache saved from parent content caches
	// since the `TotalBytesAreSince` date.
	TotalBytesStoredFromParents *int64 `plist:"TotalBytesStoredFromParents,omitempty" json:"TotalBytesStoredFromParents,omitempty"`
	// The amount of data, in bytes, that the content cache saved from peer content caches
	// since the `TotalBytesAreSince` date.
	TotalBytesStoredFromPeers *int64 `plist:"TotalBytesStoredFromPeers,omitempty" json:"TotalBytesStoredFromPeers,omitempty"`
}

ContentCachingInformationResponseStatusResponse: A dictionary that contains the status of content caching on a device.

type ContentCachingInformationResponseStatusResponseAlerts

type ContentCachingInformationResponseStatusResponseAlerts struct {
	// The type of the alert.
	ClassName string `plist:"className" json:"className"`
	// The date of the alert.
	PostDate time.Time `plist:"postDate" json:"postDate"`
	// The limit, in bytes, for the content cache at the time of the alert. This value only
	// applies to `AssetCacheLowSpaceAlert` and `AssetCacheNoSpaceAlert` types.
	CacheLimit *int64 `plist:"cacheLimit,omitempty" json:"cacheLimit,omitempty"`
	// The space, in bytes, that the system reserves at the time of the alert. This value only
	// applies to the `AssetCacheLowSpaceAlert` and `AssetCacheNoSpaceAlert` types.
	ReservedVolumeSpace *int64 `plist:"reservedVolumeSpace,omitempty" json:"reservedVolumeSpace,omitempty"`
	// The resource that was missing or inaccessible at the time of the alert. This value only
	// applies to the `AssetCacheResourceMissingAlert` type.
	Resource *string `plist:"resource,omitempty" json:"resource,omitempty"`
	// The subpath of the resource that was missing or inaccessible at the time of the alert.
	// This value only applies to the `AssetCacheResourceMissingAlert` type.
	PathPreventingAccess *string `plist:"pathPreventingAccess,omitempty" json:"pathPreventingAccess,omitempty"`
}

ContentCachingInformationResponseStatusResponseAlerts: A dictionary that describes an alert from the content cache.

type ContentCachingInformationResponseStatusResponseAlertsForPeerFilterRanges

type ContentCachingInformationResponseStatusResponseAlertsForPeerFilterRanges struct {
	// The type of the alert.
	ClassName string `plist:"className" json:"className"`
	// The date of the alert.
	PostDate time.Time `plist:"postDate" json:"postDate"`
	// The index into the `PeerFilterRanges` in the installed ContentCaching payload.
	PeerFilterRangeIndex int64 `plist:"peerFilterRangeIndex" json:"peerFilterRangeIndex"`
	// An array of local IP addresses of peer content caches that rejected requests from the
	// content cache.
	Addresses []string `plist:"addresses,omitempty" json:"addresses,omitempty"`
}

ContentCachingInformationResponseStatusResponseAlertsForPeerFilterRanges: A dictionary that describes the alerts for the peer filter ranges. The key name is the index into the `PeerFilterRanges` array in the installed `com.apple.AssetCache.managed` payload.

type ContentCachingInformationResponseStatusResponseCacheDetails

type ContentCachingInformationResponseStatusResponseCacheDetails struct {
	// The amount of disk space, in bytes, that this category of cached content uses.
	CategoryName int64 `plist:"Category Name" json:"Category Name"`
}

ContentCachingInformationResponseStatusResponseCacheDetails: The amount of disk space that various categories of cached content use. Apple defines these categories and they're subject to change.

type ContentCachingInformationResponseStatusResponseDataMigrationError

type ContentCachingInformationResponseStatusResponseDataMigrationError struct {
	// The error domain.
	Domain string `plist:"domain" json:"domain"`
	// The error code.
	Code int64 `plist:"code" json:"code"`
	// A dictionary that contains additional information about the error.
	UserInfo map[string]any `plist:"userInfo,omitempty" json:"userInfo,omitempty"`
}

ContentCachingInformationResponseStatusResponseDataMigrationError: The error that occurred while the content cache moved from one volume to another.

type ContentCachingInformationResponseStatusResponseParents

type ContentCachingInformationResponseStatusResponseParents struct {
	// The local IP address of the parent content cache.
	Address string `plist:"address" json:"address"`
	// A dictionary that describes an alert related to the parent content cache.
	Alert *ContentCachingInformationResponseStatusResponseParentsAlert `plist:"alert,omitempty" json:"alert,omitempty"`
	// A dictionary that contains additional details about the parent content cache.
	Details ContentCachingInformationResponseStatusResponseParentsDetails `plist:"details,omitempty" json:"details,omitempty"`
	// The unique identifier of the parent content cache.
	Guid string `plist:"guid" json:"guid"`
	// If `true,` the parent content cache is able to respond to requests from this content
	// cache.
	Healthy bool `plist:"healthy" json:"healthy"`
	// The IP port number the parent content cache listens to for requests.
	Port int64 `plist:"port" json:"port"`
	// The version number of the parent content cache software.
	Version string `plist:"version" json:"version"`
}

ContentCachingInformationResponseStatusResponseParents: A dictionary that describes a parent content cache.

type ContentCachingInformationResponseStatusResponseParentsAlert

type ContentCachingInformationResponseStatusResponseParentsAlert struct {
	// The type of the alert.
	ClassName string `plist:"className" json:"className"`
	// The date of the alert.
	PostDate time.Time `plist:"postDate" json:"postDate"`
	// An array of local IP addresses of parent content caches.
	Addresses []string `plist:"addresses,omitempty" json:"addresses,omitempty"`
}

ContentCachingInformationResponseStatusResponseParentsAlert: A dictionary that describes an alert related to the parent content cache.

type ContentCachingInformationResponseStatusResponseParentsDetails

type ContentCachingInformationResponseStatusResponseParentsDetails struct {
	// If `true`, the parent content cache power source is AC; otherwise, an internal battery
	// provides its power.
	AcPower *bool `plist:"ac-power,omitempty" json:"ac-power,omitempty"`
	// The maximum amount of disk space, in bytes, available to the parent content cache.
	CacheSize *int64 `plist:"cache-size,omitempty" json:"cache-size,omitempty"`
	// A dictionary that describes the capabilities of the parent content cache.
	Capabilities *ContentCachingInformationResponseStatusResponseParentsDetailsCapabilities `plist:"capabilities,omitempty" json:"capabilities,omitempty"`
	// If `true`, the parent content cache computer is portable; for example, a laptop.
	IsPortable *bool `plist:"is-portable,omitempty" json:"is-portable,omitempty"`
	// A dictionary that describes the parent content cache's connection to its local network.
	LocalNetwork *ContentCachingInformationResponseStatusResponseParentsDetailsLocalNetwork `plist:"local-network,omitempty" json:"local-network,omitempty"`
}

ContentCachingInformationResponseStatusResponseParentsDetails: A dictionary that contains additional details about the parent content cache.

type ContentCachingInformationResponseStatusResponseParentsDetailsCapabilities

type ContentCachingInformationResponseStatusResponseParentsDetailsCapabilities struct {
	// If `true`, the parent content cache is capable of imports and uploads.
	Im *bool `plist:"im,omitempty" json:"im,omitempty"`
	// If `true`, the parent content cache is capable of handling namespaces, which is an
	// aspect of personal caching.
	Ns *bool `plist:"ns,omitempty" json:"ns,omitempty"`
	// If `true`, the parent content cache is capable of caching personal iCloud content.
	Pc *bool `plist:"pc,omitempty" json:"pc,omitempty"`
	// If `true`, the parent content cache is capable of handling query parameters in URLs.
	QueryParameters *bool `plist:"query-parameters,omitempty" json:"query-parameters,omitempty"`
	// If `true`, the parent content cache is capable of caching shared non-iCloud content.
	Sc *bool `plist:"sc,omitempty" json:"sc,omitempty"`
	// If `true`, the parent content cache is capable of prioritizing imports and uploads.
	Ur *bool `plist:"ur,omitempty" json:"ur,omitempty"`
}

ContentCachingInformationResponseStatusResponseParentsDetailsCapabilities: A dictionary that describes the capabilities of the parent content cache.

type ContentCachingInformationResponseStatusResponseParentsDetailsLocalNetwork

type ContentCachingInformationResponseStatusResponseParentsDetailsLocalNetwork struct {
	// The transfer speed, in megabits per second, of the parent content cache's connection to
	// its local network.
	Speed *int64 `plist:"speed,omitempty" json:"speed,omitempty"`
	// If `true`, the parent content cache has a wired connection to its local network. If
	// `false`, it has a wireless connection; for example, Wi-Fi.
	Wired *bool `plist:"wired,omitempty" json:"wired,omitempty"`
}

ContentCachingInformationResponseStatusResponseParentsDetailsLocalNetwork: A dictionary that describes the parent content cache's connection to its local network.

type ContentCachingInformationResponseStatusResponsePeers

type ContentCachingInformationResponseStatusResponsePeers struct {
	// The local IP address of the peer content cache.
	Address string `plist:"address" json:"address"`
	// A dictionary that describes an alert related to the peer content cache.
	Alert *ContentCachingInformationResponseStatusResponsePeersAlert `plist:"alert,omitempty" json:"alert,omitempty"`
	// A dictionary that contains additional details about the peer content cache.
	Details ContentCachingInformationResponseStatusResponsePeersDetails `plist:"details,omitempty" json:"details,omitempty"`
	// If `true`, the peer content cache is able to respond to requests from the content cache.
	Friendly bool `plist:"friendly" json:"friendly"`
	// The unique identifier of the peer content cache.
	Guid string `plist:"guid" json:"guid"`
	// If `true`, the peer content cache is able to respond to requests from the content cache.
	Healthy bool `plist:"healthy" json:"healthy"`
	// The IP port number the peer content cache listens to for requests.
	Port int64 `plist:"port" json:"port"`
	// The version number of the peer content cache software.
	Version string `plist:"version" json:"version"`
}

ContentCachingInformationResponseStatusResponsePeers: A dictionary that describes a peer content cache.

type ContentCachingInformationResponseStatusResponsePeersAlert

type ContentCachingInformationResponseStatusResponsePeersAlert struct {
	// The type of the alert.
	ClassName string `plist:"className" json:"className"`
	// The date of the alert.
	PostDate time.Time `plist:"postDate" json:"postDate"`
	// An array of local IP addresses of peer content caches.
	Addresses []string `plist:"addresses,omitempty" json:"addresses,omitempty"`
	// The local IP address of a peer content cache.
	PeerAddress *string `plist:"peerAddress,omitempty" json:"peerAddress,omitempty"`
}

ContentCachingInformationResponseStatusResponsePeersAlert: A dictionary that describes an alert related to the peer content cache.

type ContentCachingInformationResponseStatusResponsePeersDetails

type ContentCachingInformationResponseStatusResponsePeersDetails struct {
	// If `true`, the peer content cache power source is AC; otherwise, an internal battery
	// provides its power.
	AcPower *bool `plist:"ac-power,omitempty" json:"ac-power,omitempty"`
	// The maximum amount of disk space, in bytes, available to the peer content cache.
	CacheSize *int64 `plist:"cache-size,omitempty" json:"cache-size,omitempty"`
	// A dictionary that describes the capabilities of the peer content cache.
	Capabilities *ContentCachingInformationResponseStatusResponsePeersDetailsCapabilities `plist:"capabilities,omitempty" json:"capabilities,omitempty"`
	// If `true`, the peer content cache computer is portable; for example, a laptop.
	IsPortable *bool `plist:"is-portable,omitempty" json:"is-portable,omitempty"`
	// A dictionary that describes the peer content cache's connection to its local network.
	LocalNetwork *ContentCachingInformationResponseStatusResponsePeersDetailsLocalNetwork `plist:"local-network,omitempty" json:"local-network,omitempty"`
}

ContentCachingInformationResponseStatusResponsePeersDetails: A dictionary that contains additional details about the peer content cache.

type ContentCachingInformationResponseStatusResponsePeersDetailsCapabilities

type ContentCachingInformationResponseStatusResponsePeersDetailsCapabilities struct {
	// If `true`, the peer content cache is capable of imports and uploads.
	Im *bool `plist:"im,omitempty" json:"im,omitempty"`
	// If `true`, the peer content cache is capable of handling namespaces, which is an aspect
	// of personal caching.
	Ns *bool `plist:"ns,omitempty" json:"ns,omitempty"`
	// If `true`, the peer content cache is capable of caching personal iCloud content.
	Pc *bool `plist:"pc,omitempty" json:"pc,omitempty"`
	// If `true`, the peer content cache is capable of handling query parameters in URLs.
	QueryParameters *bool `plist:"query-parameters,omitempty" json:"query-parameters,omitempty"`
	// If `true`, the peer content cache is capable of caching shared non-iCloud content.
	Sc *bool `plist:"sc,omitempty" json:"sc,omitempty"`
	// If `true`, the peer content cache is capable of prioritizing imports and uploads.
	Ur *bool `plist:"ur,omitempty" json:"ur,omitempty"`
}

ContentCachingInformationResponseStatusResponsePeersDetailsCapabilities: A dictionary that describes the capabilities of the peer content cache.

type ContentCachingInformationResponseStatusResponsePeersDetailsLocalNetwork

type ContentCachingInformationResponseStatusResponsePeersDetailsLocalNetwork struct {
	// The transfer speed, in megabits per second, of the peer content cache's connection to
	// its local network.
	Speed *int64 `plist:"speed,omitempty" json:"speed,omitempty"`
	// If `true`, the peer content cache has a wired connection to its local network. If
	// `false`, it has a wireless connection; for example, Wi-Fi.
	Wired *bool `plist:"wired,omitempty" json:"wired,omitempty"`
}

ContentCachingInformationResponseStatusResponsePeersDetailsLocalNetwork: A dictionary that describes the peer content cache's connection to its local network.

type DeclarativeManagement

type DeclarativeManagement struct {
	// The base64-encoded declarative management JSON request using a `TokensResponse`.
	Data []byte `plist:"Data,omitempty" json:"Data,omitempty"`
}

DeclarativeManagement: Enable your server to support declarative management or trigger a declarative management synchronization operation on the device.

DeclarativeManagement corresponds to mdm/commands/declarativemanagement.yaml (Declarative Management Command).

func (*DeclarativeManagement) RequestTypeName

func (*DeclarativeManagement) RequestTypeName() string

RequestTypeName returns "DeclarativeManagement".

func (*DeclarativeManagement) SchemaPath

func (*DeclarativeManagement) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeclarativeManagement) Validate

func (x *DeclarativeManagement) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeclarativeManagementResponse

type DeclarativeManagementResponse struct {
}

DeclarativeManagementResponse: Response to DeclarativeManagement.

DeclarativeManagementResponse corresponds to mdm/commands/declarativemanagement.yaml (Declarative Management Command).

func (*DeclarativeManagementResponse) ResponseRequestTypeName

func (*DeclarativeManagementResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DeclarativeManagement".

func (*DeclarativeManagementResponse) SchemaPath

func (*DeclarativeManagementResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeclarativeManagementResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeleteUser

type DeleteUser struct {
	// The user name of the account to delete. This key is required when the value for
	// `DeleteAllUsers` is absent or `false`.
	UserName *string `plist:"UserName,omitempty" json:"UserName,omitempty"`
	// If `true`, the system deletes the account even if the user has data that's pending sync
	// to the cloud. This value is available on iOS 9.3 and later.
	ForceDeletion *bool `plist:"ForceDeletion,omitempty" json:"ForceDeletion,omitempty"`
	// If `true`, the system attempts to delete all users from the device. If `ForceDeletion`
	// is `false`, the system generates an error instead and doesn't delete users who have data
	// that's pending sync. This value is available in iOS 14 and later.
	DeleteAllUsers *bool `plist:"DeleteAllUsers,omitempty" json:"DeleteAllUsers,omitempty"`
}

DeleteUser: Delete a user's account from a device.

DeleteUser corresponds to mdm/commands/user.delete.yaml (Delete User Command).

func (*DeleteUser) RequestTypeName

func (*DeleteUser) RequestTypeName() string

RequestTypeName returns "DeleteUser".

func (*DeleteUser) SchemaPath

func (*DeleteUser) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeleteUser) Validate

func (x *DeleteUser) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeleteUserResponse

type DeleteUserResponse struct {
}

DeleteUserResponse: Response to DeleteUser.

DeleteUserResponse corresponds to mdm/commands/user.delete.yaml (Delete User Command).

func (*DeleteUserResponse) ResponseRequestTypeName

func (*DeleteUserResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DeleteUser".

func (*DeleteUserResponse) SchemaPath

func (*DeleteUserResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeleteUserResponse) Validate

func (x *DeleteUserResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceConfigured

type DeviceConfigured struct {
}

DeviceConfigured: Inform the device that it can allow the user to continue in Setup Assistant.

DeviceConfigured corresponds to mdm/commands/device.configured.yaml (Device Configured Command).

func (*DeviceConfigured) RequestTypeName

func (*DeviceConfigured) RequestTypeName() string

RequestTypeName returns "DeviceConfigured".

func (*DeviceConfigured) SchemaPath

func (*DeviceConfigured) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceConfigured) Validate

func (x *DeviceConfigured) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceConfiguredResponse

type DeviceConfiguredResponse struct {
}

DeviceConfiguredResponse: Response to DeviceConfigured.

DeviceConfiguredResponse corresponds to mdm/commands/device.configured.yaml (Device Configured Command).

func (*DeviceConfiguredResponse) ResponseRequestTypeName

func (*DeviceConfiguredResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DeviceConfigured".

func (*DeviceConfiguredResponse) SchemaPath

func (*DeviceConfiguredResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceConfiguredResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceInformation

type DeviceInformation struct {
	// An array of query dictionaries to get information about a device.
	Queries []string `plist:"Queries,omitempty" json:"Queries,omitempty"`
	// A freshness code that appears in the resulting attestation. This value can contain up to
	// 32 bytes of data. If specified, queries need to contain `DevicePropertiesAttestation`.
	DeviceAttestationNonce []byte `plist:"DeviceAttestationNonce,omitempty" json:"DeviceAttestationNonce,omitempty"`
}

DeviceInformation: Get detailed information about a device.

DeviceInformation corresponds to mdm/commands/information.device.yaml (Device Information Command).

func (*DeviceInformation) RequestTypeName

func (*DeviceInformation) RequestTypeName() string

RequestTypeName returns "DeviceInformation".

func (*DeviceInformation) SchemaPath

func (*DeviceInformation) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceInformation) Validate

func (x *DeviceInformation) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceInformationResponse

type DeviceInformationResponse struct {
	// A dictionary that contains information about the device.
	QueryResponses DeviceInformationResponseQueryResponses `plist:"QueryResponses,omitempty" json:"QueryResponses,omitempty"`
}

DeviceInformationResponse: Response to DeviceInformation.

DeviceInformationResponse corresponds to mdm/commands/information.device.yaml (Device Information Command).

func (*DeviceInformationResponse) ResponseRequestTypeName

func (*DeviceInformationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DeviceInformation".

func (*DeviceInformationResponse) SchemaPath

func (*DeviceInformationResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceInformationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceInformationResponseQueryResponses

type DeviceInformationResponseQueryResponses struct {
	// The unique identifier of the device.
	UDID *string `plist:"UDID,omitempty" json:"UDID,omitempty"`
	// The device identifier to use in provisioning profiles. This value differs from the UDID
	// on a Mac with Apple silicon. Available in macOS 11.3 and later.
	ProvisioningUDID *string `plist:"ProvisioningUDID,omitempty" json:"ProvisioningUDID,omitempty"`
	// The contents of `OrganizationInfo`.
	OrganizationInfo *DeviceInformationResponseQueryResponsesOrganizationInfo `plist:"OrganizationInfo,omitempty" json:"OrganizationInfo,omitempty"`
	// The contents of `MDMOptions`.
	MDMOptions *DeviceInformationResponseQueryResponsesMDMOptions `plist:"MDMOptions,omitempty" json:"MDMOptions,omitempty"`
	// The date of the last iCloud backup. Available in iOS 8 and later.
	LastCloudBackupDate *time.Time `plist:"LastCloudBackupDate,omitempty" json:"LastCloudBackupDate,omitempty"`
	// If `true` on the device channel, the device is still waiting for a
	// `Device-Configured-Command` command to continue through Setup Assistant.
	AwaitingConfiguration *bool `plist:"AwaitingConfiguration,omitempty" json:"AwaitingConfiguration,omitempty"`
	// If `true`, the device has an active iTunes Store account. Requires the App Installation
	// access right.
	ITunesStoreAccountIsActive *bool `plist:"iTunesStoreAccountIsActive,omitempty" json:"iTunesStoreAccountIsActive,omitempty"`
	// A hash of the logged-in iTunes Store account. Also see `GetVppUserRequest`. Requires the
	// App Installation access right.
	ITunesStoreAccountHash *string `plist:"iTunesStoreAccountHash,omitempty" json:"iTunesStoreAccountHash,omitempty"`
	// The device name. Requires the Device Information access right.
	DeviceName *string `plist:"DeviceName,omitempty" json:"DeviceName,omitempty"`
	// The operating system version. Requires the Device Information access right.
	OSVersion *string `plist:"OSVersion,omitempty" json:"OSVersion,omitempty"`
	// The OS update Background Security Improvement version letter.
	SupplementalOSVersionExtra *string `plist:"SupplementalOSVersionExtra,omitempty" json:"SupplementalOSVersionExtra,omitempty"`
	// The operating system version. Requires the Device Information access right.
	BuildVersion *string `plist:"BuildVersion,omitempty" json:"BuildVersion,omitempty"`
	// The supplemental OS build version.
	SupplementalBuildVersion *string `plist:"SupplementalBuildVersion,omitempty" json:"SupplementalBuildVersion,omitempty"`
	// The model name, such as _iPhone_. Requires the Device Information access right.
	ModelName *string `plist:"ModelName,omitempty" json:"ModelName,omitempty"`
	// The model. Requires the Device Information access right.
	Model *string `plist:"Model,omitempty" json:"Model,omitempty"`
	// The device's hardware model number including region info, for example, `MK1A3LL/A`.
	// Requires the Device Information access right. Requires a Mac with Apple silicon on
	// macOS.
	ModelNumber *string `plist:"ModelNumber,omitempty" json:"ModelNumber,omitempty"`
	// If `true`, the macOS device uses an Apple silicon chip.
	IsAppleSilicon *bool `plist:"IsAppleSilicon,omitempty" json:"IsAppleSilicon,omitempty"`
	// The product name, such as _iPad8,12_. Requires the Device Information access right.
	ProductName *string `plist:"ProductName,omitempty" json:"ProductName,omitempty"`
	// The serial number. Requires the Device Information access right.
	SerialNumber *string `plist:"SerialNumber,omitempty" json:"SerialNumber,omitempty"`
	// The total capacity in floating-point base-10 gigabytes (GB) on iOS and macOS 12 or
	// later. The capacity is in base-2 gibibytes (GiB) on macOS 11 and earlier. Requires the
	// Device Information access right. Available in iOS 4 and later, and macOS 10.7 and later.
	DeviceCapacity *float64 `plist:"DeviceCapacity,omitempty" json:"DeviceCapacity,omitempty"`
	// The available capacity in floating-point base-10 gigabytes (GB) in iOS and macOS 12 or
	// later. The capacity is in base-2 gibibytes (GiB) in macOS 11 and earlier. Requires the
	// Device Information access right. Available in iOS 4 and later, and macOS 10.7 and later.
	AvailableDeviceCapacity *float64 `plist:"AvailableDeviceCapacity,omitempty" json:"AvailableDeviceCapacity,omitempty"`
	// The International Mobile Equipment Identity (IMEI) number. Requires the Device
	// Information access right. Available as of iOS 4 and deprecated in iOS 16.
	IMEI *string `plist:"IMEI,omitempty" json:"IMEI,omitempty"`
	// The mobile equipment identifier (MEID) number. Requires the Device Information access
	// right. Available as of iOS 4 and deprecated in iOS 16.
	MEID *string `plist:"MEID,omitempty" json:"MEID,omitempty"`
	// The modem firmware version. Requires the Device Information access right. Available in
	// iOS 4 and later.
	ModemFirmwareVersion *string `plist:"ModemFirmwareVersion,omitempty" json:"ModemFirmwareVersion,omitempty"`
	// The cellular technology type, which is one of the following values: - `0`: None - `1`:
	// GSM - `2`: CDMA - `3`: GSM and CDMA
	CellularTechnology *int64 `plist:"CellularTechnology,omitempty" json:"CellularTechnology,omitempty"`
	// The battery level, between `0.0` and `1.0`, or `-1.0` if MDM can't determine the battery
	// level. Requires the Device Information access right. Available in iOS 5 and later, and
	// macOS 13.3 and later.
	BatteryLevel *float64 `plist:"BatteryLevel,omitempty" json:"BatteryLevel,omitempty"`
	// If `true`, the device has an internal battery.
	HasBattery *bool `plist:"HasBattery,omitempty" json:"HasBattery,omitempty"`
	// If `true`, it's a supervised device. Requires the Device Information access right.
	// Available in iOS 6 and later, macOS 10.15 and later, and tvOS 9 and later.
	IsSupervised *bool `plist:"IsSupervised,omitempty" json:"IsSupervised,omitempty"`
	// If `true`, the device is a Shared iPad. Requires the Device Information access right.
	// Available in iOS 9.3 and later.
	IsMultiUser *bool `plist:"IsMultiUser,omitempty" json:"IsMultiUser,omitempty"`
	// If `true`, the device has enabled a device locator service, such as Find My. Requires
	// the Device Information access right. Available in iOS 7 and later.
	IsDeviceLocatorServiceEnabled *bool `plist:"IsDeviceLocatorServiceEnabled,omitempty" json:"IsDeviceLocatorServiceEnabled,omitempty"`
	// If `true`, the device has enabled Activation Lock. Requires the Device Information
	// access right. Available as of iOS 7 and macOS 10.9, and deprecated in iOS 16 and macOS
	// 13.
	IsActivationLockEnabled *bool `plist:"IsActivationLockEnabled,omitempty" json:"IsActivationLockEnabled,omitempty"`
	// If `true`, the device supports Activation Lock. Also see `IsActivationLockManageable` in
	// `ManagementStatus`. Available in macOS 10.9 and later.
	IsActivationLockSupported *bool `plist:"IsActivationLockSupported,omitempty" json:"IsActivationLockSupported,omitempty"`
	// If `true`, the device is in Do Not Disturb (DND) mode. This value is `true` even if DND
	// is only in effect for a locked device. Requires the Device Information access right.
	// Available in iOS 7 and later.
	IsDoNotDisturbInEffect *bool `plist:"IsDoNotDisturbInEffect,omitempty" json:"IsDoNotDisturbInEffect,omitempty"`
	// If `true`, the device can receive `PowerON`, `PowerOFF`, and `Reset` commands from a
	// lights-out management (LOM) controller. Available in macOS 11 and later.
	SupportsLOMDevice *bool `plist:"SupportsLOMDevice,omitempty" json:"SupportsLOMDevice,omitempty"`
	// The device identifier. Requires the Device Information access right. Available in tvOS 6
	// and later.
	DeviceID *string `plist:"DeviceID,omitempty" json:"DeviceID,omitempty"`
	// The device identifier for Exchange Active Sync (EAS). Requires the Device Information
	// access right. Available in iOS 7 and later.
	EASDeviceIdentifier *string `plist:"EASDeviceIdentifier,omitempty" json:"EASDeviceIdentifier,omitempty"`
	// If `true`, the device has enabled iCloud backup. Requires the Device Information access
	// right. Available in iOS 7.1 and later.
	IsCloudBackupEnabled *bool `plist:"IsCloudBackupEnabled,omitempty" json:"IsCloudBackupEnabled,omitempty"`
	// An array of the directory GUIDs of the logged-in managed users. If one of these users is
	// currently logged in to the console, the `CurrentConsoleManagedUser` key returns the GUID
	// of that user. Requires the Device Information access right. Available in macOS 10.11 and
	// later.
	ActiveManagedUsers []string `plist:"ActiveManagedUsers,omitempty" json:"ActiveManagedUsers,omitempty"`
	// The contents of “OSUpdateSettings-dictionary“. Requires the Device Information access
	// right. Available in macOS 10.11 and later.
	OSUpdateSettings *DeviceInformationResponseQueryResponsesOSUpdateSettings `plist:"OSUpdateSettings,omitempty" json:"OSUpdateSettings,omitempty"`
	// The local host name from Bonjour. Available in macOS 10.11 and later.
	LocalHostName *string `plist:"LocalHostName,omitempty" json:"LocalHostName,omitempty"`
	// The host name. Available in macOS 10.11 and later.
	HostName *string `plist:"HostName,omitempty" json:"HostName,omitempty"`
	// The contents of “AutoSetupAdminAccountsItem“, which Setup Assistant automatically
	// creates during DEP enrollment. Requires the Device Information access right. Available
	// in macOS 10.11 and later.
	AutoSetupAdminAccounts []DeviceInformationResponseQueryResponsesAutoSetupAdminAccounts `plist:"AutoSetupAdminAccounts,omitempty" json:"AutoSetupAdminAccounts,omitempty"`
	// If `true`, the device has enabled System Integrity Protection. Requires the Device
	// Information access right. Available in macOS 10.12 and later.
	SystemIntegrityProtectionEnabled *bool `plist:"SystemIntegrityProtectionEnabled,omitempty" json:"SystemIntegrityProtectionEnabled,omitempty"`
	// If `true`, the device has enabled Managed Lost Mode. Requires the Device Information
	// access right. Available in iOS 9.3 and later.
	IsMDMLostModeEnabled *bool `plist:"IsMDMLostModeEnabled,omitempty" json:"IsMDMLostModeEnabled,omitempty"`
	// The maximum number of users that can use this Shared iPad device. Starting with iOS
	// 13.4, the value that returns is always `32`. Requires the Device Information access
	// right. Available in iOS 9.3 and later.
	MaximumResidentUsers *int64 `plist:"MaximumResidentUsers,omitempty" json:"MaximumResidentUsers,omitempty"`
	// The estimated number of users that can use this Shared iPad device, according to the
	// space available on the device and each user's quota. Requires the Device Information
	// access right. Available in iOS 14 and later.
	EstimatedResidentUsers *int64 `plist:"EstimatedResidentUsers,omitempty" json:"EstimatedResidentUsers,omitempty"`
	// The quota size in megabytes for each user on this Shared iPad device. Requires the
	// Device Information access right. Available in iOS 13.4 and later.
	QuotaSize *int64 `plist:"QuotaSize,omitempty" json:"QuotaSize,omitempty"`
	// The number of users currently on this Shared iPad device. Requires the Device
	// Information access right. Available in iOS 13.4 and later.
	ResidentUsers *int64 `plist:"ResidentUsers,omitempty" json:"ResidentUsers,omitempty"`
	// The timeout interval for the user session. A value of `0` indicates that there's no
	// timeout.
	UserSessionTimeout *int64 `plist:"UserSessionTimeout,omitempty" json:"UserSessionTimeout,omitempty"`
	// The timeout interval for the temporary session. A value of `0` indicates that there's no
	// timeout.
	TemporarySessionTimeout *int64 `plist:"TemporarySessionTimeout,omitempty" json:"TemporarySessionTimeout,omitempty"`
	// If `true`, the device allows only temporary sessions.
	TemporarySessionOnly *bool `plist:"TemporarySessionOnly,omitempty" json:"TemporarySessionOnly,omitempty"`
	// The list of domains that the device suggests on the Shared iPad login screen. Available
	// in iOS 16 and later.
	ManagedAppleIDDefaultDomains []string `plist:"ManagedAppleIDDefaultDomains,omitempty" json:"ManagedAppleIDDefaultDomains,omitempty"`
	// The grace period for Shared iPad online authentication (in days). A value of `0`
	// indicates that the device requires online authentication for every login. Available in
	// iOS 16 and later.
	OnlineAuthenticationGracePeriod *int64 `plist:"OnlineAuthenticationGracePeriod,omitempty" json:"OnlineAuthenticationGracePeriod,omitempty"`
	// If `true`, skip the language and country/region panes for new users on Shared iPad.
	SkipLanguageAndLocaleSetupForNewUsers *bool `plist:"SkipLanguageAndLocaleSetupForNewUsers,omitempty" json:"SkipLanguageAndLocaleSetupForNewUsers,omitempty"`
	// The push token for the user-channel connection, in the same format as in
	// `TokenUpdateRequest`. MDM ignores this query for the device channel. Requires the Device
	// Information access right. Available in iOS 9.3 and later, and macOS 10.12 and later.
	PushToken []byte `plist:"PushToken,omitempty" json:"PushToken,omitempty"`
	// If `true`, the device has enabled diagnostic submission. Requires the Device Information
	// access right. Available in iOS 9.3 and later.
	DiagnosticSubmissionEnabled *bool `plist:"DiagnosticSubmissionEnabled,omitempty" json:"DiagnosticSubmissionEnabled,omitempty"`
	// If `true`, the device is sharing app analytics. Requires the Device Information access
	// right. Available in iOS 9.3 and later.
	AppAnalyticsEnabled *bool `plist:"AppAnalyticsEnabled,omitempty" json:"AppAnalyticsEnabled,omitempty"`
	// The current Internet Assigned Numbers Authority (IANA) time zone database name. Requires
	// the Device Information access right. Available in iOS 14 and later, and tvOS 14 and
	// later.
	TimeZone *string `plist:"TimeZone,omitempty" json:"TimeZone,omitempty"`
	// The integrated circuit card (ICC) identifier for the installed SIM card. Requires the
	// Network Information access right. Available as of iOS 4 and deprecated in iOS 16.
	ICCID *string `plist:"ICCID,omitempty" json:"ICCID,omitempty"`
	// The Bluetooth media access control (MAC) address. Requires the Network Information
	// access right.
	BluetoothMAC *string `plist:"BluetoothMAC,omitempty" json:"BluetoothMAC,omitempty"`
	// The Wi-Fi MAC address. Requires the Network Information access right.
	WiFiMAC *string `plist:"WiFiMAC,omitempty" json:"WiFiMAC,omitempty"`
	// The primary Ethernet MAC address. Requires the Network Information access right.
	// Available in macOS 10.7 and later.
	EthernetMAC *string `plist:"EthernetMAC,omitempty" json:"EthernetMAC,omitempty"`
	// The name of the current carrier network. Requires the Network Information access right.
	// Available as of iOS 4 and deprecated in iOS 16.
	CurrentCarrierNetwork *string `plist:"CurrentCarrierNetwork,omitempty" json:"CurrentCarrierNetwork,omitempty"`
	// Apple no longer supports this query. Use `SubscriberCarrierNetwork` instead.
	SIMCarrierNetwork *string `plist:"SIMCarrierNetwork,omitempty" json:"SIMCarrierNetwork,omitempty"`
	// The name of the home carrier network. Requires the Network Information access right.
	// Available as of iOS 5 and deprecated in iOS 16.
	SubscriberCarrierNetwork *string `plist:"SubscriberCarrierNetwork,omitempty" json:"SubscriberCarrierNetwork,omitempty"`
	// The version of the carrier settings. Requires the Network Information access right.
	// Available as of iOS 4 and deprecated in iOS 16.
	CarrierSettingsVersion *string `plist:"CarrierSettingsVersion,omitempty" json:"CarrierSettingsVersion,omitempty"`
	// The raw phone number without punctuation and including the country code. Requires the
	// Network Information access right. Available as of iOS 4 and deprecated in iOS 16.
	PhoneNumber *string `plist:"PhoneNumber,omitempty" json:"PhoneNumber,omitempty"`
	// If `true`, the device has enabled data roaming. Requires the Network Information access
	// right. Available in iOS 5 and later.
	DataRoamingEnabled *bool `plist:"DataRoamingEnabled,omitempty" json:"DataRoamingEnabled,omitempty"`
	// If `true`, the device has enabled voice roaming, which isn't available for all carriers.
	// Requires the Network Information access right. Requires the Device Information access
	// right. Available as of iOS 5 and deprecated in iOS 16.
	VoiceRoamingEnabled *bool `plist:"VoiceRoamingEnabled,omitempty" json:"VoiceRoamingEnabled,omitempty"`
	// If `true,` the device has enabled Personal Hotspot, which isn't available for all
	// carriers. Requires the Network Information access right. Available in iOS 7 and later.
	PersonalHotspotEnabled *bool `plist:"PersonalHotspotEnabled,omitempty" json:"PersonalHotspotEnabled,omitempty"`
	// If `true`, the device is network-tethered. Requires the Network Information access
	// right. Available in iOS 10.3 and later.
	IsNetworkTethered *bool `plist:"IsNetworkTethered,omitempty" json:"IsNetworkTethered,omitempty"`
	// If `true`, the device is roaming. Requires the Network Information access right.
	// IAvailable as of iOS 4.2 and deprecated in iOS 16.
	IsRoaming *bool `plist:"IsRoaming,omitempty" json:"IsRoaming,omitempty"`
	// Apple no longer supports this query. Use `SubscriberMCC` instead.
	SIMMCC *string `plist:"SIMMCC,omitempty" json:"SIMMCC,omitempty"`
	// Apple no longer supports this query. Use `SubscriberMNC` instead.
	SIMMNC *string `plist:"SIMMNC,omitempty" json:"SIMMNC,omitempty"`
	// The home Mobile Country Code (MCC). Requires the Network Information access right.
	// Available as of iOS 4.2.6 and deprecated in iOS 16.
	SubscriberMCC *string `plist:"SubscriberMCC,omitempty" json:"SubscriberMCC,omitempty"`
	// The key to get the home Mobile Network Code (MNC). Requires the Network Information
	// access right. Available as of iOS 4.2.6 and deprecated in iOS 16.
	SubscriberMNC *string `plist:"SubscriberMNC,omitempty" json:"SubscriberMNC,omitempty"`
	// The current mobile country code (MCC). Requires the Network Information access right.
	// Available as of iOS 4 and deprecated in iOS 16.
	CurrentMCC *string `plist:"CurrentMCC,omitempty" json:"CurrentMCC,omitempty"`
	// The current mobile network code (MNC). Requires the Network Information access right.
	// Available as of iOS 4 and deprecated in iOS 16.
	CurrentMNC *string `plist:"CurrentMNC,omitempty" json:"CurrentMNC,omitempty"`
	// The contents of “ServiceSubscriptionProperty“. Requires the Network Information access
	// right.
	ServiceSubscriptions []DeviceInformationResponseQueryResponsesServiceSubscriptions `plist:"ServiceSubscriptions,omitempty" json:"ServiceSubscriptions,omitempty"`
	// If `true`, the `EraseDeviceCommand` requires a PIN. Available in macOS 11 and later.
	PINRequiredForEraseDevice *bool `plist:"PINRequiredForEraseDevice,omitempty" json:"PINRequiredForEraseDevice,omitempty"`
	// If `true`, the `DeviceLockCommand` requires a PIN. Available in macOS 11 and later.
	PINRequiredForDeviceLock *bool `plist:"PINRequiredForDeviceLock,omitempty" json:"PINRequiredForDeviceLock,omitempty"`
	// If `true`, the device supports iOS or iPadOS app installs through MDM. Available in
	// macOS 11 and later.
	SupportsiOSAppInstalls *bool `plist:"SupportsiOSAppInstalls,omitempty" json:"SupportsiOSAppInstalls,omitempty"`
	// The device identifier to look up available OS updates through
	// [https://gdmf.apple.com/v2/pmv](https://gdmf.apple.com/v2/pmv). Available in iOS 15 and
	// later, and macOS 12 and later.
	SoftwareUpdateDeviceID *string `plist:"SoftwareUpdateDeviceID,omitempty" json:"SoftwareUpdateDeviceID,omitempty"`
	// The device settings that control which updates appear in the Software Update pane in
	// Settings. Available in iOS 14.5 and later.
	SoftwareUpdateSettings *DeviceInformationResponseQueryResponsesSoftwareUpdateSettings `plist:"SoftwareUpdateSettings,omitempty" json:"SoftwareUpdateSettings,omitempty"`
	// The current state of settable accessibility settings. Available in iOS 16 and later.
	AccessibilitySettings *DeviceInformationResponseQueryResponsesAccessibilitySettings `plist:"AccessibilitySettings,omitempty" json:"AccessibilitySettings,omitempty"`
	// The key to get an attestation of the device's properties. Available in iOS 16 and later,
	// macOS 14 and later, tvOS 16 and later, and watchOS 10 and later. The hardware
	// requirements for attestation are described below.
	DevicePropertiesAttestation [][]byte `plist:"DevicePropertiesAttestation,omitempty" json:"DevicePropertiesAttestation,omitempty"`
	// Specifies whether the device can perform an `EraseDeviceCommand` using Erase All Content
	// and Settings (EACS), which is one of the following values: - `success`: The device
	// supports EACS. - `not supported`: The device is too old to support EACS. - `unknown
	// failure`: A problem occurred for which there isn't a more specific error message. -
	// `(other string)`: A reason why the device can't perform EACS, such as "System is not
	// sealed"
	EACSPreflight *string `plist:"EACSPreflight,omitempty" json:"EACSPreflight,omitempty"`
}

DeviceInformationResponseQueryResponses: A dictionary that contains information about the device.

type DeviceInformationResponseQueryResponsesAccessibilitySettings

type DeviceInformationResponseQueryResponsesAccessibilitySettings struct {
	// If `true`, the device has enabled bold text.
	BoldTextEnabled *bool `plist:"BoldTextEnabled,omitempty" json:"BoldTextEnabled,omitempty"`
	// If `true`, the device has enabled increase contrast.
	IncreaseContrastEnabled *bool `plist:"IncreaseContrastEnabled,omitempty" json:"IncreaseContrastEnabled,omitempty"`
	// If `true`, the device has enabled reduced motion.
	ReduceMotionEnabled *bool `plist:"ReduceMotionEnabled,omitempty" json:"ReduceMotionEnabled,omitempty"`
	// If `true`, the device has enabled reduced transparency.
	ReduceTransparencyEnabled *bool `plist:"ReduceTransparencyEnabled,omitempty" json:"ReduceTransparencyEnabled,omitempty"`
	// The accessibility text size apps that support dynamic text use. 0 is the smallest value,
	// and 11 is the largest available.
	TextSize *int64 `plist:"TextSize,omitempty" json:"TextSize,omitempty"`
	// If `true`, the device has enabled touch accommodations.
	TouchAccommodationsEnabled *bool `plist:"TouchAccommodationsEnabled,omitempty" json:"TouchAccommodationsEnabled,omitempty"`
	// If `true`, the device has enabled voiceover.
	VoiceOverEnabled *bool `plist:"VoiceOverEnabled,omitempty" json:"VoiceOverEnabled,omitempty"`
	// If `true`, the device has enabled zoom.
	ZoomEnabled *bool `plist:"ZoomEnabled,omitempty" json:"ZoomEnabled,omitempty"`
	// If `true`, the device has enabled grayscale display.
	GrayscaleEnabled *bool `plist:"GrayscaleEnabled,omitempty" json:"GrayscaleEnabled,omitempty"`
}

DeviceInformationResponseQueryResponsesAccessibilitySettings: The current state of settable accessibility settings. Available in iOS 16 and later.

type DeviceInformationResponseQueryResponsesAutoSetupAdminAccounts

type DeviceInformationResponseQueryResponsesAutoSetupAdminAccounts struct {
	// The `GeneratedUID` of the administrator account. This value is available in macOS 10.11
	// and later.
	GUID *string `plist:"GUID,omitempty" json:"GUID,omitempty"`
	// The short name of the administrator account. This value is available in macOS 10.11 and
	// later.
	ShortName *string `plist:"shortName,omitempty" json:"shortName,omitempty"`
}

DeviceInformationResponseQueryResponsesAutoSetupAdminAccounts: The response dictionary that contains the administrator setup information.

type DeviceInformationResponseQueryResponsesMDMOptions

type DeviceInformationResponseQueryResponsesMDMOptions struct {
	// If `true`, a supervised device registers itself with Activation Lock when the user
	// enables Find My. Unsupervised devices ignore this value. This value is available in iOS
	// 7 and later, macOS 11 and later, and tvOS 9 and later.
	ActivationLockAllowedWhileSupervised *bool `plist:"ActivationLockAllowedWhileSupervised,omitempty" json:"ActivationLockAllowedWhileSupervised,omitempty"`
	// If `true`, the server supports Bootstrap Token commands. This value is available in
	// macOS 11 and later.
	BootstrapTokenAllowed *bool `plist:"BootstrapTokenAllowed,omitempty" json:"BootstrapTokenAllowed,omitempty"`
	// If `true`, the device can accept a Bootstrap Token from the MDM server instead of
	// prompting for user authentication prior to installation. This only applies when
	// `BootstrapTokenAllowedForAuthentication` is `true` in the `SecurityInfo` response. This
	// value is available for a Mac with Apple silicon in macOS 11 and later.
	PromptUserToAllowBootstrapTokenForAuthentication *bool `` /* 132-byte string literal not displayed */
}

DeviceInformationResponseQueryResponsesMDMOptions: The contents of `MDMOptions`.

type DeviceInformationResponseQueryResponsesOSUpdateSettings

type DeviceInformationResponseQueryResponsesOSUpdateSettings struct {
	// The URL to the software update catalog the client is using. This value is available in
	// macOS 10.11 and later.
	CatalogURL *string `plist:"CatalogURL,omitempty" json:"CatalogURL,omitempty"`
	// If `true`, `CatalogURL` is the default catalog. This value is available in macOS 10.11
	// and later.
	IsDefaultCatalog *bool `plist:"IsDefaultCatalog,omitempty" json:"IsDefaultCatalog,omitempty"`
	// The date of the last software update scan. This value is available in macOS 10.11 and
	// later.
	PreviousScanDate *time.Time `plist:"PreviousScanDate,omitempty" json:"PreviousScanDate,omitempty"`
	// The result code of last software update scan; `0` = success. This value is available in
	// macOS 10.11 and no longer available in macOS 15 and later.
	PreviousScanResult *string `plist:"PreviousScanResult,omitempty" json:"PreviousScanResult,omitempty"`
	// If `true`, start a new scan. This value is available in macOS 10.11 and later.
	PerformPeriodicCheck *bool `plist:"PerformPeriodicCheck,omitempty" json:"PerformPeriodicCheck,omitempty"`
	// The preference to automatically check for app updates. This value is available in macOS
	// 10.11 and later.
	AutoCheckEnabled *bool `plist:"AutoCheckEnabled,omitempty" json:"AutoCheckEnabled,omitempty"`
	// The preference to download app updates in the background. This value is available in
	// macOS 10.11 and later.
	BackgroundDownloadEnabled *bool `plist:"BackgroundDownloadEnabled,omitempty" json:"BackgroundDownloadEnabled,omitempty"`
	// The preference to automatically install app updates. This value is available in macOS
	// 10.11 and later.
	AutomaticAppInstallationEnabled *bool `plist:"AutomaticAppInstallationEnabled,omitempty" json:"AutomaticAppInstallationEnabled,omitempty"`
	// The preference to automatically install operating system updates. This value is
	// available in macOS 10.11 and later.
	AutomaticOSInstallationEnabled *bool `plist:"AutomaticOSInstallationEnabled,omitempty" json:"AutomaticOSInstallationEnabled,omitempty"`
	// The preference to automatically install system data files and security updates. This
	// value is available in macOS 10.11 and later.
	AutomaticSecurityUpdatesEnabled *bool `plist:"AutomaticSecurityUpdatesEnabled,omitempty" json:"AutomaticSecurityUpdatesEnabled,omitempty"`
}

DeviceInformationResponseQueryResponsesOSUpdateSettings: The contents of “OSUpdateSettings-dictionary“. Requires the Device Information access right. Available in macOS 10.11 and later.

type DeviceInformationResponseQueryResponsesOrganizationInfo

type DeviceInformationResponseQueryResponsesOrganizationInfo struct {
	// A string that describes the organization operating the MDM server. This value is
	// available in iOS 7 and later, macOS 10.11 and later, and tvOS 9 and later.
	OrganizationName string `plist:"OrganizationName" json:"OrganizationName"`
	// The organization's address. Use the LF character (`&#10`) to insert line breaks. This
	// value is available in iOS 7 and later, macOS 10.11 and later, and tvOS 9 and later.
	OrganizationAddress *string `plist:"OrganizationAddress,omitempty" json:"OrganizationAddress,omitempty"`
	// The organization's phone number. This value is available in iOS 7 and later, macOS 10.11
	// and later, and tvOS 9 and later.
	OrganizationPhone *string `plist:"OrganizationPhone,omitempty" json:"OrganizationPhone,omitempty"`
	// The organization's support email address. This value is available in iOS 7 and later,
	// macOS 10.11 and later, and tvOS 9 and later.
	OrganizationEmail *string `plist:"OrganizationEmail,omitempty" json:"OrganizationEmail,omitempty"`
	// A unique identifier for the various services a single organization manages. This value
	// is available in iOS 7 and later, macOS 10.11 and later, and tvOS 9 and later.
	OrganizationMagic *string `plist:"OrganizationMagic,omitempty" json:"OrganizationMagic,omitempty"`
}

DeviceInformationResponseQueryResponsesOrganizationInfo: The contents of `OrganizationInfo`.

type DeviceInformationResponseQueryResponsesServiceSubscriptions

type DeviceInformationResponseQueryResponsesServiceSubscriptions struct {
	// The version of the carrier settings. This value is available in iOS 12 and later.
	CarrierSettingsVersion *string `plist:"CarrierSettingsVersion,omitempty" json:"CarrierSettingsVersion,omitempty"`
	// The name of the current carrier network. This value is available in iOS 12 and later.
	CurrentCarrierNetwork *string `plist:"CurrentCarrierNetwork,omitempty" json:"CurrentCarrierNetwork,omitempty"`
	// The current mobile country code (MCC). This value is available in iOS 12 and later.
	CurrentMCC *string `plist:"CurrentMCC,omitempty" json:"CurrentMCC,omitempty"`
	// The current mobile network code (MNC). This value is available in iOS 12 and later.
	CurrentMNC *string `plist:"CurrentMNC,omitempty" json:"CurrentMNC,omitempty"`
	// The integrated circuit card identifier (ICCID) value. This value is available in iOS 12
	// and later.
	ICCID *string `plist:"ICCID,omitempty" json:"ICCID,omitempty"`
	// The eSIM identifier. This value is available in iOS 14 and later.
	EID *string `plist:"EID,omitempty" json:"EID,omitempty"`
	// The device International Mobile Equipment Identity (IMEI) number. This value is
	// available in iOS 12 and later.
	IMEI *string `plist:"IMEI,omitempty" json:"IMEI,omitempty"`
	// If `true`, this subscription is the preference for data. This value is available in iOS
	// 12 and later.
	IsDataPreferred *bool `plist:"IsDataPreferred,omitempty" json:"IsDataPreferred,omitempty"`
	// If `true`, the phone is roaming. This value is available in iOS 12 and later.
	IsRoaming *bool `plist:"IsRoaming,omitempty" json:"IsRoaming,omitempty"`
	// If `true`, this subscription is the preference for voice. This value is available in iOS
	// 12 and later.
	IsVoicePreferred *bool `plist:"IsVoicePreferred,omitempty" json:"IsVoicePreferred,omitempty"`
	// The label of this subscription. This value is available in iOS 12 and later.
	Label *string `plist:"Label,omitempty" json:"Label,omitempty"`
	// The unique identifier for this subscription. This value is available in iOS 12 and
	// later.
	LabelID *string `plist:"LabelID,omitempty" json:"LabelID,omitempty"`
	// The device Mobile Equipment Identifier (MEID) number. This query is available in iOS 12
	// and later.
	MEID *string `plist:"MEID,omitempty" json:"MEID,omitempty"`
	// The raw phone number without punctuation and including country code. This value is
	// available in iOS 12 and later.
	PhoneNumber *string `plist:"PhoneNumber,omitempty" json:"PhoneNumber,omitempty"`
	// The description of the slot that contains the SIM representing this subscription. This
	// value is available in iOS 12 and later.
	Slot *string `plist:"Slot,omitempty" json:"Slot,omitempty"`
	// The name of the home carrier network. This value is available in iOS 16 and later.
	SubscriberCarrierNetwork *string `plist:"SubscriberCarrierNetwork,omitempty" json:"SubscriberCarrierNetwork,omitempty"`
}

DeviceInformationResponseQueryResponsesServiceSubscriptions: Properties of this Service Subscription. See below.

type DeviceInformationResponseQueryResponsesSoftwareUpdateSettings

type DeviceInformationResponseQueryResponsesSoftwareUpdateSettings struct {
	// Which software updates to present to the user.
	RecommendationsCadence *int64 `plist:"RecommendationsCadence,omitempty" json:"RecommendationsCadence,omitempty"`
}

DeviceInformationResponseQueryResponsesSoftwareUpdateSettings: The device settings that control which updates appear in the Software Update pane in Settings. Available in iOS 14.5 and later.

type DeviceLocation

type DeviceLocation struct {
}

DeviceLocation: Request the location of a device when in Lost Mode.

DeviceLocation corresponds to mdm/commands/device.lostmode.location.yaml (Device Location Command).

func (*DeviceLocation) RequestTypeName

func (*DeviceLocation) RequestTypeName() string

RequestTypeName returns "DeviceLocation".

func (*DeviceLocation) SchemaPath

func (*DeviceLocation) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceLocation) Validate

func (x *DeviceLocation) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceLocationResponse

type DeviceLocationResponse struct {
	// The latitude of the device's location.
	Latitude float64 `plist:"Latitude" json:"Latitude"`
	// The longitude of the device's location.
	Longitude float64 `plist:"Longitude" json:"Longitude"`
	// The radius of uncertainty for the location in meters, which is a negative value if the
	// horizontal accuracy is unknown.
	HorizontalAccuracy float64 `plist:"HorizontalAccuracy" json:"HorizontalAccuracy"`
	// The accuracy of the altitude value in meters, which is a negative value if the vertical
	// accuracy is unknown.
	VerticalAccuracy float64 `plist:"VerticalAccuracy" json:"VerticalAccuracy"`
	// The altitude of the device's location, which is a negative value if the altitude is
	// unknown.
	Altitude float64 `plist:"Altitude" json:"Altitude"`
	// The speed of the device in meters per second, which is a negative value if the speed is
	// unknown.
	Speed float64 `plist:"Speed" json:"Speed"`
	// The direction the device is traveling, which is a negative value if the course is
	// unknown.
	Course float64 `plist:"Course" json:"Course"`
	// The RFC 3339 timestamp of when the server determines the location of the device.
	Timestamp string `plist:"Timestamp" json:"Timestamp"`
}

DeviceLocationResponse: Response to DeviceLocation.

DeviceLocationResponse corresponds to mdm/commands/device.lostmode.location.yaml (Device Location Command).

func (*DeviceLocationResponse) ResponseRequestTypeName

func (*DeviceLocationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DeviceLocation".

func (*DeviceLocationResponse) SchemaPath

func (*DeviceLocationResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceLocationResponse) Validate

func (x *DeviceLocationResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceLock

type DeviceLock struct {
	// The message to display on the Lock Screen of the device. This value doesn't apply to a
	// Shared iPad device. This value is available in iOS 4 and later, and macOS 10.14 and
	// later.
	Message *string `plist:"Message,omitempty" json:"Message,omitempty"`
	// The phone number to display on the Lock Screen. This value doesn't apply to a Shared
	// iPad device. This value is available in iOS 7 and later and macOS 11.5 and later (for a
	// Mac with Apple silicon only).
	PhoneNumber *string `plist:"PhoneNumber,omitempty" json:"PhoneNumber,omitempty"`
	// The six-character PIN for Find My. This value is available in macOS 10.8 and later.
	PIN *string `plist:"PIN,omitempty" json:"PIN,omitempty"`
}

DeviceLock: Remotely and immediately lock a device.

DeviceLock corresponds to mdm/commands/device.lock.yaml (Device Lock Command).

func (*DeviceLock) RequestTypeName

func (*DeviceLock) RequestTypeName() string

RequestTypeName returns "DeviceLock".

func (*DeviceLock) SchemaPath

func (*DeviceLock) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceLock) Validate

func (x *DeviceLock) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DeviceLockResponse

type DeviceLockResponse struct {
	// The message result if the command includes a message or phone number, which is one of
	// the following values:
	MessageResult *string `plist:"MessageResult,omitempty" json:"MessageResult,omitempty"`
}

DeviceLockResponse: Response to DeviceLock.

DeviceLockResponse corresponds to mdm/commands/device.lock.yaml (Device Lock Command).

func (*DeviceLockResponse) ResponseRequestTypeName

func (*DeviceLockResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DeviceLock".

func (*DeviceLockResponse) SchemaPath

func (*DeviceLockResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DeviceLockResponse) Validate

func (x *DeviceLockResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DisableLostMode

type DisableLostMode struct {
}

DisableLostMode: Take the device out of Lost Mode.

DisableLostMode corresponds to mdm/commands/device.lostmode.disable.yaml (Disable Lost Mode Command).

func (*DisableLostMode) RequestTypeName

func (*DisableLostMode) RequestTypeName() string

RequestTypeName returns "DisableLostMode".

func (*DisableLostMode) SchemaPath

func (*DisableLostMode) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DisableLostMode) Validate

func (x *DisableLostMode) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DisableLostModeResponse

type DisableLostModeResponse struct {
}

DisableLostModeResponse: Response to DisableLostMode.

DisableLostModeResponse corresponds to mdm/commands/device.lostmode.disable.yaml (Disable Lost Mode Command).

func (*DisableLostModeResponse) ResponseRequestTypeName

func (*DisableLostModeResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DisableLostMode".

func (*DisableLostModeResponse) SchemaPath

func (*DisableLostModeResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DisableLostModeResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DisableRemoteDesktop

type DisableRemoteDesktop struct {
}

DisableRemoteDesktop: Disable Remote Desktop on a device.

DisableRemoteDesktop corresponds to mdm/commands/remotedesktop.disable.yaml (Disable Remote Desktop Command).

func (*DisableRemoteDesktop) RequestTypeName

func (*DisableRemoteDesktop) RequestTypeName() string

RequestTypeName returns "DisableRemoteDesktop".

func (*DisableRemoteDesktop) SchemaPath

func (*DisableRemoteDesktop) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DisableRemoteDesktop) Validate

func (x *DisableRemoteDesktop) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type DisableRemoteDesktopResponse

type DisableRemoteDesktopResponse struct {
}

DisableRemoteDesktopResponse: Response to DisableRemoteDesktop.

DisableRemoteDesktopResponse corresponds to mdm/commands/remotedesktop.disable.yaml (Disable Remote Desktop Command).

func (*DisableRemoteDesktopResponse) ResponseRequestTypeName

func (*DisableRemoteDesktopResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "DisableRemoteDesktop".

func (*DisableRemoteDesktopResponse) SchemaPath

func (*DisableRemoteDesktopResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*DisableRemoteDesktopResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type EnableLostMode

type EnableLostMode struct {
	// If present, the device displays this text on the Lock Screen. You must provide this
	// value if you don't provide a value for `PhoneNumber`.
	Message *string `plist:"Message,omitempty" json:"Message,omitempty"`
	// If present, the device displays this phone number on the Lock Screen. You must provide
	// this value if you don't provide a value for `Message`.
	PhoneNumber *string `plist:"PhoneNumber,omitempty" json:"PhoneNumber,omitempty"`
	// If present, the device displays this text at the bottom of the Lock Screen.
	Footnote *string `plist:"Footnote,omitempty" json:"Footnote,omitempty"`
}

EnableLostMode: Enable Lost Mode on a device, which provides a message and phone number on the Lock Screen.

EnableLostMode corresponds to mdm/commands/device.lostmode.enable.yaml (Enable Lost Mode Command).

func (*EnableLostMode) RequestTypeName

func (*EnableLostMode) RequestTypeName() string

RequestTypeName returns "EnableLostMode".

func (*EnableLostMode) SchemaPath

func (*EnableLostMode) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*EnableLostMode) Validate

func (x *EnableLostMode) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type EnableLostModeResponse

type EnableLostModeResponse struct {
}

EnableLostModeResponse: Response to EnableLostMode.

EnableLostModeResponse corresponds to mdm/commands/device.lostmode.enable.yaml (Enable Lost Mode Command).

func (*EnableLostModeResponse) ResponseRequestTypeName

func (*EnableLostModeResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "EnableLostMode".

func (*EnableLostModeResponse) SchemaPath

func (*EnableLostModeResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*EnableLostModeResponse) Validate

func (x *EnableLostModeResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type EnableRemoteDesktop

type EnableRemoteDesktop struct {
}

EnableRemoteDesktop: Enable Remote Desktop on a device.

EnableRemoteDesktop corresponds to mdm/commands/remotedesktop.enable.yaml (Enable Remote Desktop Command).

func (*EnableRemoteDesktop) RequestTypeName

func (*EnableRemoteDesktop) RequestTypeName() string

RequestTypeName returns "EnableRemoteDesktop".

func (*EnableRemoteDesktop) SchemaPath

func (*EnableRemoteDesktop) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*EnableRemoteDesktop) Validate

func (x *EnableRemoteDesktop) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type EnableRemoteDesktopResponse

type EnableRemoteDesktopResponse struct {
}

EnableRemoteDesktopResponse: Response to EnableRemoteDesktop.

EnableRemoteDesktopResponse corresponds to mdm/commands/remotedesktop.enable.yaml (Enable Remote Desktop Command).

func (*EnableRemoteDesktopResponse) ResponseRequestTypeName

func (*EnableRemoteDesktopResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "EnableRemoteDesktop".

func (*EnableRemoteDesktopResponse) SchemaPath

func (*EnableRemoteDesktopResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*EnableRemoteDesktopResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type Entry

type Entry struct {
	// ID is the wire identifier: RequestType, MessageType, PayloadType,
	// DeclarationType, StatusItemType, error code, or type name.
	ID string
	// Schema is the YAML path in apple/device-management.
	Schema string
	Title  string
	// New returns a zero value of the type as Command.
	New func() Command
	// NewResponse returns a zero response value.
	NewResponse func() Response
}

Entry describes one schema in the Registry.

func ByID

func ByID(id string) []Entry

ByID returns every entry with the given wire identifier, sorted by type name.

type EraseDevice

type EraseDevice struct {
	// If `true`, preserve the data plan on an iPhone or iPad with eSIM functionality, if one
	// exists. This value is available in iOS 11 and later.
	PreserveDataPlan *bool `plist:"PreserveDataPlan,omitempty" json:"PreserveDataPlan,omitempty"`
	// If `true`, disable Proximity Setup on the next reboot and skip the pane in Setup
	// Assistant. This value is available in iOS 11 and later. Prior to iOS 14, don't use this
	// option with any other option.
	DisallowProximitySetup *bool `plist:"DisallowProximitySetup,omitempty" json:"DisallowProximitySetup,omitempty"`
	// The six-character PIN for Find My. This value is available in macOS 10.8 and later.
	PIN *string `plist:"PIN,omitempty" json:"PIN,omitempty"`
	// This key defines the fallback behavior for erasing a device.
	ObliterationBehavior *string `plist:"ObliterationBehavior,omitempty" json:"ObliterationBehavior,omitempty"`
	// The configuration settings for return to service. This value is available in iOS 17 and
	// later, with Shared iPad, in tvOS 18 and later, and in visionOS 26 and later.
	ReturnToService *EraseDeviceReturnToService `plist:"ReturnToService,omitempty" json:"ReturnToService,omitempty"`
}

EraseDevice: Remotely and immediately erase a device.

EraseDevice corresponds to mdm/commands/device.erase.yaml (Erase Device Command).

func (*EraseDevice) RequestTypeName

func (*EraseDevice) RequestTypeName() string

RequestTypeName returns "EraseDevice".

func (*EraseDevice) SchemaPath

func (*EraseDevice) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*EraseDevice) Validate

func (x *EraseDevice) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type EraseDeviceResponse

type EraseDeviceResponse struct {
}

EraseDeviceResponse: Response to EraseDevice.

EraseDeviceResponse corresponds to mdm/commands/device.erase.yaml (Erase Device Command).

func (*EraseDeviceResponse) ResponseRequestTypeName

func (*EraseDeviceResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "EraseDevice".

func (*EraseDeviceResponse) SchemaPath

func (*EraseDeviceResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*EraseDeviceResponse) Validate

func (x *EraseDeviceResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type EraseDeviceReturnToService

type EraseDeviceReturnToService struct {
	// If `true`, the device tries to reenroll itself automatically after erasure. The user
	// needs to deactivate all activation locks for this feature to work correctly.
	Enabled bool `plist:"Enabled" json:"Enabled"`
	// The Wi-Fi profile that installs after erasure when using return to service. This is
	// required when the device doesn't have an Ethernet or cellular connection.
	WiFiProfileData []byte `plist:"WiFiProfileData,omitempty" json:"WiFiProfileData,omitempty"`
	// The MDM profile that installs after erasure when using return to service. This key is
	// required for all unsupervised devices, as well as supervised devices that don't enroll
	// with Automated Device Enrollment. If provided, the device uses this profile directly
	// instead of fetching it from the server. For devices that enroll with Automated Device
	// Enrollment, this key isn't necessary unless the cloud configuration profile of the
	// device contains the `configuration-web-url` key.
	MDMProfileData []byte `plist:"MDMProfileData,omitempty" json:"MDMProfileData,omitempty"`
	// The bootstrap token the system uses to implement return to service with app
	// preservation. Required when enabling return to service through the cloud configuration.
	BootstrapToken []byte `plist:"BootstrapToken,omitempty" json:"BootstrapToken,omitempty"`
}

EraseDeviceReturnToService: The configuration settings for return to service. This value is available in iOS 17 and later, with Shared iPad, in tvOS 18 and later, and in visionOS 26 and later.

type InstallApplication

type InstallApplication struct {
	// The app's iTunes Store identifier.
	ITunesStoreID *int64 `plist:"iTunesStoreID,omitempty" json:"iTunesStoreID,omitempty"`
	// The app's bundle identifier.
	Identifier *string `plist:"Identifier,omitempty" json:"Identifier,omitempty"`
	// A dictionary that contains the app installation options.
	Options *InstallApplicationOptions `plist:"Options,omitempty" json:"Options,omitempty"`
	// The URL of the app manifest, which needs to begin with `https:`. The manifest is
	// returned as a property list that uses the `ManifestURL` format.
	ManifestURL *string `plist:"ManifestURL,omitempty" json:"ManifestURL,omitempty"`
	// A bitwise OR of the management flags. The possible values are:
	ManagementFlags *int64 `plist:"ManagementFlags,omitempty" json:"ManagementFlags,omitempty"`
	// A dictionary that contains the initial configuration of the app, if you choose to
	// provide it. Available in iOS 7 and later, macOS 11 and later, and tvOS 10.2 and later.
	Configuration map[string]any `plist:"Configuration,omitempty" json:"Configuration,omitempty"`
	// A dictionary that contains the initial attributes of the app, if you choose to provide
	// it. Available in iOS 7 and later, and tvOS 10.2 and later.
	Attributes *InstallApplicationAttributes `plist:"Attributes,omitempty" json:"Attributes,omitempty"`
	// The change management state. This value doesn't work with the user enrollment feature
	// introduced in iOS 13, or any type of account driven enrollment. Available in iOS 9 and
	// later, macOS 11 and later, and tvOS 10.2 and later. The only possible value is:
	ChangeManagementState *string `plist:"ChangeManagementState,omitempty" json:"ChangeManagementState,omitempty"`
	// If `true`, install the app as a managed app. Otherwise, the system installs the app as
	// unmanaged. If you reinstall a manged app and omit this value or set it to `false`, the
	// app becomes unmanaged.
	InstallAsManaged *bool `plist:"InstallAsManaged,omitempty" json:"InstallAsManaged,omitempty"`
	// If `true`, the app is an iOS app that can run on a Mac with Apple silicon in macOS 11
	// and later.
	IOSApp *bool `plist:"iOSApp,omitempty" json:"iOSApp,omitempty"`
}

InstallApplication: Install a third-party app on a device.

InstallApplication corresponds to mdm/commands/application.install.yaml (Install Application Command).

func (*InstallApplication) RequestTypeName

func (*InstallApplication) RequestTypeName() string

RequestTypeName returns "InstallApplication".

func (*InstallApplication) SchemaPath

func (*InstallApplication) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallApplication) Validate

func (x *InstallApplication) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallApplicationAttributes

type InstallApplicationAttributes struct {
	// A per-app VPN unique identifier for this app. Available in iOS 7 and later.
	VPNUUID *string `plist:"VPNUUID,omitempty" json:"VPNUUID,omitempty"`
	// The content filter UUID for this app. Available in iOS 16 and later.
	ContentFilterUUID *string `plist:"ContentFilterUUID,omitempty" json:"ContentFilterUUID,omitempty"`
	// The DNS proxy UUID for this app. Available in iOS 16 and later.
	DNSProxyUUID *string `plist:"DNSProxyUUID,omitempty" json:"DNSProxyUUID,omitempty"`
	// The relay UUID for this app. Available in iOS 17 and later.
	RelayUUID *string `plist:"RelayUUID,omitempty" json:"RelayUUID,omitempty"`
	// An array that contains the associated domains to add to this app. Available in iOS 13
	// and later.
	AssociatedDomains []string `plist:"AssociatedDomains,omitempty" json:"AssociatedDomains,omitempty"`
	// If `true`, perform claimed site association verification directly at the domain instead
	// of on Apple's servers. Only set this to `true` for domains that can't access the
	// internet. Available in iOS 14 and later.
	AssociatedDomainsEnableDirectDownloads *bool `plist:"AssociatedDomainsEnableDirectDownloads,omitempty" json:"AssociatedDomainsEnableDirectDownloads,omitempty"`
	// If `false`, this app isn't removable while it's a managed app. Available in iOS 14 and
	// later, and tvOS 14 and later.
	Removable *bool `plist:"Removable,omitempty" json:"Removable,omitempty"`
	// If `true`, Tap to Pay on iPhone requires users to use Face ID or a passcode to unlock
	// their device after every transaction that requires a customer's card PIN. If `false`,
	// the user can configure this setting on their device.
	TapToPayScreenLock *bool `plist:"TapToPayScreenLock,omitempty" json:"TapToPayScreenLock,omitempty"`
	// The data network name (DNN) or app category. For DNN, the value is `DNN:name`, where
	// `name` is the carrier-provided DNN name. For app category, the value is
	// `AppCategory:category`, where `category` is a carrier-provided string like
	// "Enterprise1".
	CellularSliceUUID *string `plist:"CellularSliceUUID,omitempty" json:"CellularSliceUUID,omitempty"`
	// If `false`, the system prevents the user from hiding the app. It doesn't affect the
	// user's ability to leave it in the App Library, while removing it from the Home Screen.
	Hideable *bool `plist:"Hideable,omitempty" json:"Hideable,omitempty"`
	// If `false`, the system prevents the user from locking the app. This also prevents the
	// user from hiding the app.
	Lockable *bool `plist:"Lockable,omitempty" json:"Lockable,omitempty"`
}

InstallApplicationAttributes: A dictionary that contains the initial attributes of the app, if you choose to provide it. Available in iOS 7 and later, and tvOS 10.2 and later.

type InstallApplicationOptions

type InstallApplicationOptions struct {
	// The app's purchase type, which must be one of the following values:
	PurchaseMethod *int64 `plist:"PurchaseMethod,omitempty" json:"PurchaseMethod,omitempty"`
}

InstallApplicationOptions: A dictionary that contains the app installation options.

type InstallApplicationResponse

type InstallApplicationResponse struct {
	// The app's bundle identifier, if the user accepted the request.
	Identifier *string `plist:"Identifier,omitempty" json:"Identifier,omitempty"`
	// The app's installation state, if the user accepted the request. If this value is
	// `NeedsRedemption`, the server needs to send a redemption code to complete the app
	// installation.
	State *string `plist:"State,omitempty" json:"State,omitempty"`
	// The reason, if installation fails. macOS always returns "Other".
	RejectionReason *string `plist:"RejectionReason,omitempty" json:"RejectionReason,omitempty"`
}

InstallApplicationResponse: Response to InstallApplication.

InstallApplicationResponse corresponds to mdm/commands/application.install.yaml (Install Application Command).

func (*InstallApplicationResponse) ResponseRequestTypeName

func (*InstallApplicationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InstallApplication".

func (*InstallApplicationResponse) SchemaPath

func (*InstallApplicationResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallApplicationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallEnterpriseApplication

type InstallEnterpriseApplication struct {
	// A dictionary that specifies where to download the app. This value uses the `ManifestURL`
	// format.
	Manifest map[string]any `plist:"Manifest,omitempty" json:"Manifest,omitempty"`
	// The URL of the app manifest, which needs to begin with `https:`. The manifest is
	// returned as a property list that uses the `ManifestURL` format.
	ManifestURL *string `plist:"ManifestURL,omitempty" json:"ManifestURL,omitempty"`
	// An array of DER-encoded certificates to pin the connection when fetching the
	// `ManifestURL`.
	ManifestURLPinningCerts [][]byte `plist:"ManifestURLPinningCerts,omitempty" json:"ManifestURLPinningCerts,omitempty"`
	// If `true`, certificate revocation checks require a positive response when using
	// certificate pinning with `ManifestURLPinningCerts`.
	PinningRevocationCheckRequired *bool `plist:"PinningRevocationCheckRequired,omitempty" json:"PinningRevocationCheckRequired,omitempty"`
	// If `true`, install the app as a managed app. Otherwise, the system installs the app as
	// unmanaged. If you reinstall a manged app and omit this value or set it to `false`, the
	// app becomes unmanaged.
	InstallAsManaged *bool `plist:"InstallAsManaged,omitempty" json:"InstallAsManaged,omitempty"`
	// The management flags. The possible values are:
	ManagementFlags *int64 `plist:"ManagementFlags,omitempty" json:"ManagementFlags,omitempty"`
	// A dictionary that contains the initial configuration of the app, if you choose to
	// provide it. Available in macOS 11 and later.
	Configuration map[string]any `plist:"Configuration,omitempty" json:"Configuration,omitempty"`
	// The change management state. This value doesn't work with the user enrollments. The only
	// possible value is:
	ChangeManagementState *string `plist:"ChangeManagementState,omitempty" json:"ChangeManagementState,omitempty"`
	// If `true`, the app is an iOS app that can run on a Mac with Apple silicon in macOS 11
	// and later.
	IOSApp *bool `plist:"iOSApp,omitempty" json:"iOSApp,omitempty"`
}

InstallEnterpriseApplication: Install an enterprise app on a device.

InstallEnterpriseApplication corresponds to mdm/commands/application.install.enterprise.yaml (Install Enterprise Application Command).

func (*InstallEnterpriseApplication) RequestTypeName

func (*InstallEnterpriseApplication) RequestTypeName() string

RequestTypeName returns "InstallEnterpriseApplication".

func (*InstallEnterpriseApplication) SchemaPath

func (*InstallEnterpriseApplication) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallEnterpriseApplication) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallEnterpriseApplicationResponse

type InstallEnterpriseApplicationResponse struct {
}

InstallEnterpriseApplicationResponse: Response to InstallEnterpriseApplication.

InstallEnterpriseApplicationResponse corresponds to mdm/commands/application.install.enterprise.yaml (Install Enterprise Application Command).

func (*InstallEnterpriseApplicationResponse) ResponseRequestTypeName

func (*InstallEnterpriseApplicationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InstallEnterpriseApplication".

func (*InstallEnterpriseApplicationResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallEnterpriseApplicationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallMedia

type InstallMedia struct {
	// The book's iTunes Store identifier.
	ITunesStoreID *int64 `plist:"iTunesStoreID,omitempty" json:"iTunesStoreID,omitempty"`
	// The URL to retrieve the book. This value is available in iOS 8 and later.
	MediaURL *string `plist:"MediaURL,omitempty" json:"MediaURL,omitempty"`
	// The media type, which can only be `Book`.
	MediaType string `plist:"MediaType" json:"MediaType"`
	// The book's persistent identifier in reverse-DNS form; for example,
	// `com.acme.manuals.training`. This value is available in iOS 8 and later.
	PersistentID *string `plist:"PersistentID,omitempty" json:"PersistentID,omitempty"`
	// The kind of the media, which can be one of the following values:
	Kind *string `plist:"Kind,omitempty" json:"Kind,omitempty"`
	// The book's version number. This value is available in iOS 8 and later.
	Version *string `plist:"Version,omitempty" json:"Version,omitempty"`
	// The name of the book's author. This value is available in iOS 8 and later.
	Author *string `plist:"Author,omitempty" json:"Author,omitempty"`
	// The book's title. This value is available in iOS 8 and later.
	Title *string `plist:"Title,omitempty" json:"Title,omitempty"`
}

InstallMedia: Install a book on a device.

InstallMedia corresponds to mdm/commands/media.install.yaml (Install Media Command).

func (*InstallMedia) RequestTypeName

func (*InstallMedia) RequestTypeName() string

RequestTypeName returns "InstallMedia".

func (*InstallMedia) SchemaPath

func (*InstallMedia) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallMedia) Validate

func (x *InstallMedia) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallMediaResponse

type InstallMediaResponse struct {
	// The book's iTunes Store identifier, if present in the command.
	ITunesStoreID *int64 `plist:"iTunesStoreID,omitempty" json:"iTunesStoreID,omitempty"`
	// The URL to retrieve the book, if present in the command. This value is available in iOS
	// 8 and later.
	MediaURL *string `plist:"MediaURL,omitempty" json:"MediaURL,omitempty"`
	// The book's persistent identifier, if present in the command. This value is available in
	// iOS 8 and later.
	PersistentID *string `plist:"PersistentID,omitempty" json:"PersistentID,omitempty"`
	// The media type, which can only be `Book`.
	MediaType *string `plist:"MediaType,omitempty" json:"MediaType,omitempty"`
	// The installation state of this book. The `Failed` and `Unknown` states are transient and
	// the device only reports them once. Books from the Book Store report their state as
	// `Installed` instead of `Managed`.
	State *string `plist:"State,omitempty" json:"State,omitempty"`
	// The reason, if installation fails, which is one of the following values:
	RejectionReason *string `plist:"RejectionReason,omitempty" json:"RejectionReason,omitempty"`
}

InstallMediaResponse: Response to InstallMedia.

InstallMediaResponse corresponds to mdm/commands/media.install.yaml (Install Media Command).

func (*InstallMediaResponse) ResponseRequestTypeName

func (*InstallMediaResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InstallMedia".

func (*InstallMediaResponse) SchemaPath

func (*InstallMediaResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallMediaResponse) Validate

func (x *InstallMediaResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallProfile

type InstallProfile struct {
	// The profile to install, which you can encrypt using any identity certificate installed
	// on the device. You can also sign the profile.
	Payload []byte `plist:"Payload,omitempty" json:"Payload,omitempty"`
}

InstallProfile: Install a configuration profile on a device.

InstallProfile corresponds to mdm/commands/profile.install.yaml (Install Profile Command).

func (*InstallProfile) RequestTypeName

func (*InstallProfile) RequestTypeName() string

RequestTypeName returns "InstallProfile".

func (*InstallProfile) SchemaPath

func (*InstallProfile) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallProfile) Validate

func (x *InstallProfile) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallProfileResponse

type InstallProfileResponse struct {
}

InstallProfileResponse: Response to InstallProfile.

InstallProfileResponse corresponds to mdm/commands/profile.install.yaml (Install Profile Command).

func (*InstallProfileResponse) ResponseRequestTypeName

func (*InstallProfileResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InstallProfile".

func (*InstallProfileResponse) SchemaPath

func (*InstallProfileResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallProfileResponse) Validate

func (x *InstallProfileResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallProvisioningProfile

type InstallProvisioningProfile struct {
	// The provisioning profile.
	ProvisioningProfile []byte `plist:"ProvisioningProfile,omitempty" json:"ProvisioningProfile,omitempty"`
}

InstallProvisioningProfile: Install a provisioning profile on a device.

InstallProvisioningProfile corresponds to mdm/commands/profile.provisioning.install.yaml (Install Provisioning Profile Command).

func (*InstallProvisioningProfile) RequestTypeName

func (*InstallProvisioningProfile) RequestTypeName() string

RequestTypeName returns "InstallProvisioningProfile".

func (*InstallProvisioningProfile) SchemaPath

func (*InstallProvisioningProfile) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallProvisioningProfile) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstallProvisioningProfileResponse

type InstallProvisioningProfileResponse struct {
}

InstallProvisioningProfileResponse: Response to InstallProvisioningProfile.

InstallProvisioningProfileResponse corresponds to mdm/commands/profile.provisioning.install.yaml (Install Provisioning Profile Command).

func (*InstallProvisioningProfileResponse) ResponseRequestTypeName

func (*InstallProvisioningProfileResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InstallProvisioningProfile".

func (*InstallProvisioningProfileResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*InstallProvisioningProfileResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstalledApplicationList

type InstalledApplicationList struct {
	// An array of app identifiers. Provide this value to limit the response to only include
	// these apps. This value is available in iOS 7 and later, macOS 10.15 and later, tvOS 10.2
	// and later, visionOS 1.1 and later, and watchOS 10 and later.
	Identifiers []string `plist:"Identifiers,omitempty" json:"Identifiers,omitempty"`
	// If `true`, only get a list of managed apps, excluding ones that Declarative Device
	// Management is managing. This value is available in iOS 7 and later, macOS 10.15 and
	// later, and tvOS 10.2 and later.
	ManagedAppsOnly *bool `plist:"ManagedAppsOnly,omitempty" json:"ManagedAppsOnly,omitempty"`
	// An array of strings that represent keys in `InstalledApplicationListItem`. If present,
	// the response only contains the keys listed here, except `Identifier` is always included.
	// If not present, the response contains all keys. Starting in iOS 26, macOS 26, tvOS 26,
	// watchOS 26, and visionOS 26, if this key isn't present, the response omits values that
	// are expensive to calculate.
	Items []string `plist:"Items,omitempty" json:"Items,omitempty"`
}

InstalledApplicationList: Get a list of the installed apps on a device.

InstalledApplicationList corresponds to mdm/commands/application.installed.list.yaml (Installed Application List Command).

func (*InstalledApplicationList) RequestTypeName

func (*InstalledApplicationList) RequestTypeName() string

RequestTypeName returns "InstalledApplicationList".

func (*InstalledApplicationList) SchemaPath

func (*InstalledApplicationList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InstalledApplicationList) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstalledApplicationListResponse

type InstalledApplicationListResponse struct {
	// An array of dictionaries that describes each installed app.
	InstalledApplicationList []InstalledApplicationListResponseInstalledApplicationList `plist:"InstalledApplicationList,omitempty" json:"InstalledApplicationList,omitempty"`
}

InstalledApplicationListResponse: Response to InstalledApplicationList.

InstalledApplicationListResponse corresponds to mdm/commands/application.installed.list.yaml (Installed Application List Command).

func (*InstalledApplicationListResponse) ResponseRequestTypeName

func (*InstalledApplicationListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InstalledApplicationList".

func (*InstalledApplicationListResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*InstalledApplicationListResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InstalledApplicationListResponseInstalledApplicationList

type InstalledApplicationListResponseInstalledApplicationList struct {
	// The app's identifier. This key is always be present on iOS and tvOS, but may be missing
	// on macOS.
	Identifier *string `plist:"Identifier,omitempty" json:"Identifier,omitempty"`
	// The app's external version identifier. You can also retrieve this value from the App
	// Store. For more information, see `Apps and Books for Organizations`.
	ExternalVersionIdentifier *int64 `plist:"ExternalVersionIdentifier,omitempty" json:"ExternalVersionIdentifier,omitempty"`
	// The marketplace hosted application's distributor ID. This value is available in iOS 17.4
	// and later.
	DistributorIdentifier *string `plist:"DistributorIdentifier,omitempty" json:"DistributorIdentifier,omitempty"`
	// The app's version.
	Version *string `plist:"Version,omitempty" json:"Version,omitempty"`
	// The app's short version.
	ShortVersion *string `plist:"ShortVersion,omitempty" json:"ShortVersion,omitempty"`
	// The app's name.
	Name *string `plist:"Name,omitempty" json:"Name,omitempty"`
	// The app's static bundle size, in bytes. This value is expensive to calculate. Starting
	// in iOS 26, macOS 26, tvOS 26, watchOS 26, and visionOS 26 it isn't present in the
	// response unless it is included in the `Items` request key. This value is available in
	// iOS 5 and later, and macOS 10.7 and later, tvOS 10.2 and later, watchOS 10 and later,
	// and visionOS 1.1 and later.
	BundleSize *int64 `plist:"BundleSize,omitempty" json:"BundleSize,omitempty"`
	// The size of the app's file system in bytes, including the Documents, Library, and other
	// directories. This value is expensive to calculate. Starting in iOS 26, tvOS 26, watchOS
	// 26, and visionOS 26 it isn't present in the response unless it is included in the
	// `Items` request key. This value is available in iOS 5 and later, tvOS 10.2 and later,
	// watchOS 10 and later, and visionOS 1.1 and later.
	DynamicSize *int64 `plist:"DynamicSize,omitempty" json:"DynamicSize,omitempty"`
	// If `true`, the app is valid and can run on the device. If the app is
	// enterprise-distributed and unvalidated, it won't be able to run until validation has
	// occurred. This value is available in iOS 9.2 and later, and tvOS 10.2 and later.
	IsValidated *bool `plist:"IsValidated,omitempty" json:"IsValidated,omitempty"`
	// If `true`, the app is downloading. If `false`, it's already installed.
	Installing *bool `plist:"Installing,omitempty" json:"Installing,omitempty"`
	// If `true`, the app came from the App Store and can participate in store features. For
	// device-based Volume Purchase Program (VPP) apps, this value is `false`. This value is
	// available in iOS 11.3 and later, and tvOS 11.3 and later.
	AppStoreVendable *bool `plist:"AppStoreVendable,omitempty" json:"AppStoreVendable,omitempty"`
	// If `true`, installing the app didn't require an Apple Account. This value is available
	// in iOS 11.3 and later, and tvOS 11.3 and later.
	DeviceBasedVPP *bool `plist:"DeviceBasedVPP,omitempty" json:"DeviceBasedVPP,omitempty"`
	// If `true`, the app is part of the Apple Beta Software Program. This value is available
	// in iOS 11.3 and later, and tvOS 11.3 and later.
	BetaApp *bool `plist:"BetaApp,omitempty" json:"BetaApp,omitempty"`
	// If `true`, the app is ad-hoc code signed. This query is available in iOS 11.3 and later,
	// and tvOS 11.3 and later.
	AdHocCodeSigned *bool `plist:"AdHocCodeSigned,omitempty" json:"AdHocCodeSigned,omitempty"`
	// If `true`, the app has an update available. This key is present only for App Store apps.
	// In macOS, this key is present only for Volume Purchase Program (VPP) apps. This status
	// updates daily and isn't always up-to-date when installing an app.
	HasUpdateAvailable *bool `plist:"HasUpdateAvailable,omitempty" json:"HasUpdateAvailable,omitempty"`
	// If `true`, the download failed.
	DownloadFailed *bool `plist:"DownloadFailed,omitempty" json:"DownloadFailed,omitempty"`
	// If `true`, the app is in the initial state, which is waiting to download.
	DownloadWaiting *bool `plist:"DownloadWaiting,omitempty" json:"DownloadWaiting,omitempty"`
	// If `true`, the user paused the download.
	DownloadPaused *bool `plist:"DownloadPaused,omitempty" json:"DownloadPaused,omitempty"`
	// If `true`, the user canceled the download.
	DownloadCancelled *bool `plist:"DownloadCancelled,omitempty" json:"DownloadCancelled,omitempty"`
	// If `true`, the app is an App Clip. Available in iOS 16 and later.
	IsAppClip *bool `plist:"IsAppClip,omitempty" json:"IsAppClip,omitempty"`
	// The source of the application. When the app is managed by Declarative Device Management
	// this value is `Declarative Device Management`.
	Source *string `plist:"Source,omitempty" json:"Source,omitempty"`
}

InstalledApplicationListResponseInstalledApplicationList: A dictionary that describes an app list item.

type InviteToProgram

type InviteToProgram struct {
	// The program's identifier, which can only be `com.apple.cloudvpp`.
	ProgramID string `plist:"ProgramID" json:"ProgramID"`
	// The Volume Purchase Program (VPP) invitation URL.
	InvitationURL string `plist:"InvitationURL" json:"InvitationURL"`
}

InviteToProgram: Invite a user to join the Volume Purchase Program (VPP).

InviteToProgram corresponds to mdm/commands/application.invitetoprogram.yaml (Invite To Program Command).

func (*InviteToProgram) RequestTypeName

func (*InviteToProgram) RequestTypeName() string

RequestTypeName returns "InviteToProgram".

func (*InviteToProgram) SchemaPath

func (*InviteToProgram) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InviteToProgram) Validate

func (x *InviteToProgram) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type InviteToProgramResponse

type InviteToProgramResponse struct {
	// The result of the command.
	InvitationResult string `plist:"InvitationResult" json:"InvitationResult"`
}

InviteToProgramResponse: Response to InviteToProgram.

InviteToProgramResponse corresponds to mdm/commands/application.invitetoprogram.yaml (Invite To Program Command).

func (*InviteToProgramResponse) ResponseRequestTypeName

func (*InviteToProgramResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "InviteToProgram".

func (*InviteToProgramResponse) SchemaPath

func (*InviteToProgramResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*InviteToProgramResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type LOMDeviceRequest

type LOMDeviceRequest struct {
	// An array of requests to perform.
	RequestList []LOMDeviceRequestRequestList `plist:"RequestList,omitempty" json:"RequestList,omitempty"`
}

LOMDeviceRequest: Send requests to a device using lights-out management (LOM).

LOMDeviceRequest corresponds to mdm/commands/lom.devicerequest.yaml (LOM Device Request Command).

func (*LOMDeviceRequest) RequestTypeName

func (*LOMDeviceRequest) RequestTypeName() string

RequestTypeName returns "LOMDeviceRequest".

func (*LOMDeviceRequest) SchemaPath

func (*LOMDeviceRequest) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*LOMDeviceRequest) Validate

func (x *LOMDeviceRequest) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type LOMDeviceRequestRequestList

type LOMDeviceRequestRequestList struct {
	// The requested action to perform on the device.
	DeviceRequestType string `plist:"DeviceRequestType" json:"DeviceRequestType"`
	// The unique identifier of the request.
	DeviceRequestUUID string `plist:"DeviceRequestUUID" json:"DeviceRequestUUID"`
	// The DNS name of the device. This should match the `dNSName` in `SubjectAltName` or an
	// equivalent in a PKCS12 identity.
	DeviceDNSName string `plist:"DeviceDNSName" json:"DeviceDNSName"`
	// An array that contains the IPv6 addresses for primary LOM-compatible Ethernet interfaces
	// for the device.
	PrimaryIPv6AddressList []string `plist:"PrimaryIPv6AddressList,omitempty" json:"PrimaryIPv6AddressList,omitempty"`
	// An array that contains the IPv6 addresses for secondary LOM-compatible Ethernet
	// interfaces for the device.
	SecondaryIPv6AddressList []string `plist:"SecondaryIPv6AddressList,omitempty" json:"SecondaryIPv6AddressList,omitempty"`
	// The LOM protocol version that the device supports. Provide the same value that
	// `LOMProtocolVersion` receives in the `LOMSetupRequestResponse`.
	LOMProtocolVersion int64 `plist:"LOMProtocolVersion" json:"LOMProtocolVersion"`
}

LOMDeviceRequestRequestList: A dictionary that contains a requested action to perform on a device using lights-out management (LOM).

type LOMDeviceRequestResponse

type LOMDeviceRequestResponse struct {
	// An array of dictionaries that describes the status of each request.
	ResponseList []LOMDeviceRequestResponseResponseList `plist:"ResponseList,omitempty" json:"ResponseList,omitempty"`
}

LOMDeviceRequestResponse: Response to LOMDeviceRequest.

LOMDeviceRequestResponse corresponds to mdm/commands/lom.devicerequest.yaml (LOM Device Request Command).

func (*LOMDeviceRequestResponse) ResponseRequestTypeName

func (*LOMDeviceRequestResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "LOMDeviceRequest".

func (*LOMDeviceRequestResponse) SchemaPath

func (*LOMDeviceRequestResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*LOMDeviceRequestResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type LOMDeviceRequestResponseResponseList

type LOMDeviceRequestResponseResponseList struct {
	// If `true`, the request was successful.
	DeviceRequestSuccess bool `plist:"DeviceRequestSuccess" json:"DeviceRequestSuccess"`
	// The unique identifier of the request for this response list item.
	DeviceRequestUUID string `plist:"DeviceRequestUUID" json:"DeviceRequestUUID"`
	// If present, a description of the error for a failed request.
	DeviceRequestReturnError *string `plist:"DeviceRequestReturnError,omitempty" json:"DeviceRequestReturnError,omitempty"`
}

LOMDeviceRequestResponseResponseList: A dictionary that describes a response list item.

type LOMSetupRequest

type LOMSetupRequest struct {
}

LOMSetupRequest: Get information from a device to set up lights-out management (LOM).

LOMSetupRequest corresponds to mdm/commands/lom.setuprequest.yaml (LOM Setup Request Command).

func (*LOMSetupRequest) RequestTypeName

func (*LOMSetupRequest) RequestTypeName() string

RequestTypeName returns "LOMSetupRequest".

func (*LOMSetupRequest) SchemaPath

func (*LOMSetupRequest) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*LOMSetupRequest) Validate

func (x *LOMSetupRequest) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type LOMSetupRequestResponse

type LOMSetupRequestResponse struct {
	// An array that contains the IPv6 addresses for primary LOM-compatible Ethernet interfaces
	// for the device.
	PrimaryIPv6AddressList []string `plist:"PrimaryIPv6AddressList,omitempty" json:"PrimaryIPv6AddressList,omitempty"`
	// An array that contains the IPv6 addresses for secondary LOM-compatible Ethernet
	// interfaces for the device.
	SecondaryIPv6AddressList []string `plist:"SecondaryIPv6AddressList,omitempty" json:"SecondaryIPv6AddressList,omitempty"`
	// The LOM protocol version that the device supports.
	LOMProtocolVersion int64 `plist:"LOMProtocolVersion" json:"LOMProtocolVersion"`
}

LOMSetupRequestResponse: Response to LOMSetupRequest.

LOMSetupRequestResponse corresponds to mdm/commands/lom.setuprequest.yaml (LOM Setup Request Command).

func (*LOMSetupRequestResponse) ResponseRequestTypeName

func (*LOMSetupRequestResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "LOMSetupRequest".

func (*LOMSetupRequestResponse) SchemaPath

func (*LOMSetupRequestResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*LOMSetupRequestResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type LogOutUser

type LogOutUser struct {
}

LogOutUser: Force the current user to log out of a device.

LogOutUser corresponds to mdm/commands/user.logout.yaml (Log Out User Command).

func (*LogOutUser) RequestTypeName

func (*LogOutUser) RequestTypeName() string

RequestTypeName returns "LogOutUser".

func (*LogOutUser) SchemaPath

func (*LogOutUser) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*LogOutUser) Validate

func (x *LogOutUser) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type LogOutUserResponse

type LogOutUserResponse struct {
}

LogOutUserResponse: Response to LogOutUser.

LogOutUserResponse corresponds to mdm/commands/user.logout.yaml (Log Out User Command).

func (*LogOutUserResponse) ResponseRequestTypeName

func (*LogOutUserResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "LogOutUser".

func (*LogOutUserResponse) SchemaPath

func (*LogOutUserResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*LogOutUserResponse) Validate

func (x *LogOutUserResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationAttributes

type ManagedApplicationAttributes struct {
	// The bundle identifiers of the managed apps.
	Identifiers []string `plist:"Identifiers,omitempty" json:"Identifiers,omitempty"`
}

ManagedApplicationAttributes: Query attributes in managed apps on a device.

ManagedApplicationAttributes corresponds to mdm/commands/managed.application.attributes.yaml (Managed Application Attributes Command).

func (*ManagedApplicationAttributes) RequestTypeName

func (*ManagedApplicationAttributes) RequestTypeName() string

RequestTypeName returns "ManagedApplicationAttributes".

func (*ManagedApplicationAttributes) SchemaPath

func (*ManagedApplicationAttributes) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationAttributes) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationAttributesResponse

type ManagedApplicationAttributesResponse struct {
	// An array of app attribute items.
	ApplicationAttributes []ManagedApplicationAttributesResponseApplicationAttributes `plist:"ApplicationAttributes,omitempty" json:"ApplicationAttributes,omitempty"`
}

ManagedApplicationAttributesResponse: Response to ManagedApplicationAttributes.

ManagedApplicationAttributesResponse corresponds to mdm/commands/managed.application.attributes.yaml (Managed Application Attributes Command).

func (*ManagedApplicationAttributesResponse) ResponseRequestTypeName

func (*ManagedApplicationAttributesResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ManagedApplicationAttributes".

func (*ManagedApplicationAttributesResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationAttributesResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationAttributesResponseApplicationAttributes

type ManagedApplicationAttributesResponseApplicationAttributes struct {
	// The app's bundle identifier.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// The app's attributes.
	Attributes *ManagedApplicationAttributesResponseApplicationAttributesAttributes `plist:"Attributes,omitempty" json:"Attributes,omitempty"`
}

ManagedApplicationAttributesResponseApplicationAttributes: A dictionary that contains a managed app attributes item.

type ManagedApplicationAttributesResponseApplicationAttributesAttributes

type ManagedApplicationAttributesResponseApplicationAttributesAttributes struct {
	// A per-app VPN unique identifier for this app.
	VPNUUID *string `plist:"VPNUUID,omitempty" json:"VPNUUID,omitempty"`
	// The content Filter UUID assigned to this app.
	ContentFilterUUID *string `plist:"ContentFilterUUID,omitempty" json:"ContentFilterUUID,omitempty"`
	// The DNS Proxy UUID assigned to this app.
	DNSProxyUUID *string `plist:"DNSProxyUUID,omitempty" json:"DNSProxyUUID,omitempty"`
	// The relay UUID for this app.
	RelayUUID *string `plist:"RelayUUID,omitempty" json:"RelayUUID,omitempty"`
	// This app's associated domains. This value is available in iOS 13 and later.
	AssociatedDomains []string `plist:"AssociatedDomains,omitempty" json:"AssociatedDomains,omitempty"`
	// If `true`, perform claimed site association verification directly at the domain instead
	// of on Apple's servers. Only set this to `true` for domains that can't access the
	// internet. This value is available in iOS 14 and later.
	AssociatedDomainsEnableDirectDownloads *bool `plist:"AssociatedDomainsEnableDirectDownloads,omitempty" json:"AssociatedDomainsEnableDirectDownloads,omitempty"`
	// If `false`, this app isn't removable while it's a managed app. This value is available
	// in iOS 14 and later.
	Removable *bool `plist:"Removable,omitempty" json:"Removable,omitempty"`
	// If `true`, Tap to Pay on iPhone requires users to use Face ID or a passcode to unlock
	// their device after every transaction that requires a customer's card PIN. If `false`,
	// the user can configure this setting on their device.
	TapToPayScreenLock *bool `plist:"TapToPayScreenLock,omitempty" json:"TapToPayScreenLock,omitempty"`
	// The data network name (DNN) or app category. For DNN, the value is `DNN:name`, where
	// `name` is the carrier-provided DNN name. For app category, the value is
	// `AppCategory:category`, where `category` is a carrier-provided string like
	// "Enterprise1".
	CellularSliceUUID *string `plist:"CellularSliceUUID,omitempty" json:"CellularSliceUUID,omitempty"`
	// If `false`, the system prevents the user from hiding the app. It doesn't affect the
	// user's ability to leave it in the App Library, while removing it from the Home Screen.
	Hideable *bool `plist:"Hideable,omitempty" json:"Hideable,omitempty"`
	// If `false`, the system prevents the user from locking the app. This also prevents the
	// user from hiding the app.
	Lockable *bool `plist:"Lockable,omitempty" json:"Lockable,omitempty"`
}

ManagedApplicationAttributesResponseApplicationAttributesAttributes: The app's attributes.

type ManagedApplicationConfiguration

type ManagedApplicationConfiguration struct {
	// The bundle identifiers of the managed apps.
	Identifiers []string `plist:"Identifiers,omitempty" json:"Identifiers,omitempty"`
}

ManagedApplicationConfiguration: Get app configurations from managed apps on a device.

ManagedApplicationConfiguration corresponds to mdm/commands/managed.application.configuration.yaml (Managed Application Configuration Command).

func (*ManagedApplicationConfiguration) RequestTypeName

func (*ManagedApplicationConfiguration) RequestTypeName() string

RequestTypeName returns "ManagedApplicationConfiguration".

func (*ManagedApplicationConfiguration) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationConfiguration) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationConfigurationResponse

type ManagedApplicationConfigurationResponse struct {
	// An array of app configuration items.
	ApplicationConfigurations []ManagedApplicationConfigurationResponseApplicationConfigurations `plist:"ApplicationConfigurations,omitempty" json:"ApplicationConfigurations,omitempty"`
}

ManagedApplicationConfigurationResponse: Response to ManagedApplicationConfiguration.

ManagedApplicationConfigurationResponse corresponds to mdm/commands/managed.application.configuration.yaml (Managed Application Configuration Command).

func (*ManagedApplicationConfigurationResponse) ResponseRequestTypeName

func (*ManagedApplicationConfigurationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ManagedApplicationConfiguration".

func (*ManagedApplicationConfigurationResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationConfigurationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationConfigurationResponseApplicationConfigurations

type ManagedApplicationConfigurationResponseApplicationConfigurations struct {
	// The app's bundle identifier.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// The app's configurations.
	Configuration map[string]any `plist:"Configuration,omitempty" json:"Configuration,omitempty"`
}

ManagedApplicationConfigurationResponseApplicationConfigurations: A dictionary that contains a managed app's configurations item.

type ManagedApplicationFeedback

type ManagedApplicationFeedback struct {
	// The bundle identifiers of the managed apps.
	Identifiers []string `plist:"Identifiers,omitempty" json:"Identifiers,omitempty"`
	// If `true`, delete the app's feedback dictionary after the server reads it. Apps that are
	// managed by Declarative Device Management are ignored.
	DeleteFeedback *bool `plist:"DeleteFeedback,omitempty" json:"DeleteFeedback,omitempty"`
}

ManagedApplicationFeedback: Get app feedback from a managed app on the device.

ManagedApplicationFeedback corresponds to mdm/commands/managed.application.feedback.yaml (Managed Application Feedback Command).

func (*ManagedApplicationFeedback) RequestTypeName

func (*ManagedApplicationFeedback) RequestTypeName() string

RequestTypeName returns "ManagedApplicationFeedback".

func (*ManagedApplicationFeedback) SchemaPath

func (*ManagedApplicationFeedback) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationFeedback) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationFeedbackResponse

type ManagedApplicationFeedbackResponse struct {
	// An array of managed app feedback items.
	ManagedApplicationFeedback []ManagedApplicationFeedbackResponseManagedApplicationFeedback `plist:"ManagedApplicationFeedback,omitempty" json:"ManagedApplicationFeedback,omitempty"`
}

ManagedApplicationFeedbackResponse: Response to ManagedApplicationFeedback.

ManagedApplicationFeedbackResponse corresponds to mdm/commands/managed.application.feedback.yaml (Managed Application Feedback Command).

func (*ManagedApplicationFeedbackResponse) ResponseRequestTypeName

func (*ManagedApplicationFeedbackResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ManagedApplicationFeedback".

func (*ManagedApplicationFeedbackResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationFeedbackResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationFeedbackResponseManagedApplicationFeedback

type ManagedApplicationFeedbackResponseManagedApplicationFeedback struct {
	// The app's bundle identifier.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// The app's feedback.
	Feedback map[string]any `plist:"Feedback,omitempty" json:"Feedback,omitempty"`
}

ManagedApplicationFeedbackResponseManagedApplicationFeedback: A dictionary that contains a managed app's feedback item.

type ManagedApplicationList

type ManagedApplicationList struct {
	// The bundle identifiers of the managed apps to include in the response.
	Identifiers []string `plist:"Identifiers,omitempty" json:"Identifiers,omitempty"`
}

ManagedApplicationList: Get the status of all managed apps on a device.

ManagedApplicationList corresponds to mdm/commands/application.managed.list.yaml (Managed Application List Command).

func (*ManagedApplicationList) RequestTypeName

func (*ManagedApplicationList) RequestTypeName() string

RequestTypeName returns "ManagedApplicationList".

func (*ManagedApplicationList) SchemaPath

func (*ManagedApplicationList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationList) Validate

func (x *ManagedApplicationList) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedApplicationListManagedApplicationItem

type ManagedApplicationListManagedApplicationItem struct {
	// The status of the managed app, which is one of the following values:
	Status string `plist:"Status" json:"Status"`
	// The bitwise OR of the following management flags: * '1': Remove app upon removal of MDM
	// profile. * '4': Prevent backup of app data.
	ManagementFlags int64 `plist:"ManagementFlags" json:"ManagementFlags"`
	// If the user already purchased a paid app, this code is available for use by another
	// user. This code reports only once. This value is available in iOS 5 and later.
	UnusedRedemptionCode string `plist:"UnusedRedemptionCode" json:"UnusedRedemptionCode"`
	// If 'true', the app has an update available. This key is present only for App Store apps.
	// In macOS, this key is present only for Volume Purchase Program (VPP) apps. This status
	// updates daily and isn't always up-to-date when installing an app.
	HasConfiguration bool `plist:"HasConfiguration" json:"HasConfiguration"`
	// If 'true', the app has feedback for the server. This value is available in iOS 7 and
	// later, and tvOS 10.2 and later. On macOS 11.3 and later, this value is available if the
	// request was sent on the user channel.
	HasFeedback bool `plist:"HasFeedback" json:"HasFeedback"`
	// If 'true', the app is valid and can run on the device. If the app is
	// enterprise-distributed and unvalidated, it won't be able to run until validation has
	// occurred. This value is available in iOS 9.2 and later, and tvOS 10.2 and later.
	IsValidated bool `plist:"IsValidated" json:"IsValidated"`
	// The app's external version identifier. You can also retrieve this value from the App
	// Store. For more information, see `Apps and Books for Organizations`.
	ExternalVersionIdentifier int64 `plist:"ExternalVersionIdentifier" json:"ExternalVersionIdentifier"`
}

ManagedApplicationListManagedApplicationItem: The bundle identifier of the managed app.

type ManagedApplicationListResponse

type ManagedApplicationListResponse struct {
	// A dictionary that contains status information about each managed app. The response
	// doesn't include apps that Declarative Device Management manages.
	ManagedApplicationList map[string]ManagedApplicationListManagedApplicationItem `plist:"ManagedApplicationList,omitempty" json:"ManagedApplicationList,omitempty"`
}

ManagedApplicationListResponse: Response to ManagedApplicationList.

ManagedApplicationListResponse corresponds to mdm/commands/application.managed.list.yaml (Managed Application List Command).

func (*ManagedApplicationListResponse) ResponseRequestTypeName

func (*ManagedApplicationListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ManagedApplicationList".

func (*ManagedApplicationListResponse) SchemaPath

func (*ManagedApplicationListResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedApplicationListResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedMediaList

type ManagedMediaList struct {
}

ManagedMediaList: Get a list of the managed books on a device.

ManagedMediaList corresponds to mdm/commands/media.managed.list.yaml (Managed Media List Command).

func (*ManagedMediaList) RequestTypeName

func (*ManagedMediaList) RequestTypeName() string

RequestTypeName returns "ManagedMediaList".

func (*ManagedMediaList) SchemaPath

func (*ManagedMediaList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedMediaList) Validate

func (x *ManagedMediaList) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedMediaListResponse

type ManagedMediaListResponse struct {
	// An array of dictionaries that describes managed books.
	Books []ManagedMediaListResponseBooks `plist:"Books,omitempty" json:"Books,omitempty"`
}

ManagedMediaListResponse: Response to ManagedMediaList.

ManagedMediaListResponse corresponds to mdm/commands/media.managed.list.yaml (Managed Media List Command).

func (*ManagedMediaListResponse) ResponseRequestTypeName

func (*ManagedMediaListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ManagedMediaList".

func (*ManagedMediaListResponse) SchemaPath

func (*ManagedMediaListResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ManagedMediaListResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ManagedMediaListResponseBooks

type ManagedMediaListResponseBooks struct {
	// The book's iTunes Store identifier.
	ITunesStoreID int64 `plist:"iTunesStoreID" json:"iTunesStoreID"`
	// The installation state of this book, which is one of the following values:
	State *string `plist:"State,omitempty" json:"State,omitempty"`
	// The book's persistent identifier in reverse-DNS form; for example,
	// `com.acme.manuals.training`.
	PersistentID *string `plist:"PersistentID,omitempty" json:"PersistentID,omitempty"`
	// The kind of the media, which is one of the following values:
	Kind *string `plist:"Kind,omitempty" json:"Kind,omitempty"`
	// The book's version number.
	Version *string `plist:"Version,omitempty" json:"Version,omitempty"`
	// The name of the book's author.
	Author *string `plist:"Author,omitempty" json:"Author,omitempty"`
	// The book's title.
	Title *string `plist:"Title,omitempty" json:"Title,omitempty"`
}

ManagedMediaListResponseBooks: A dictionary that describes a managed book.

type NSExtensionMappings

type NSExtensionMappings struct {
}

NSExtensionMappings: Get a list of the installed extensions for a user on a device.

NSExtensionMappings corresponds to mdm/commands/application.extensions.mappings.yaml (NSExtension Mappings Command).

func (*NSExtensionMappings) RequestTypeName

func (*NSExtensionMappings) RequestTypeName() string

RequestTypeName returns "NSExtensionMappings".

func (*NSExtensionMappings) SchemaPath

func (*NSExtensionMappings) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*NSExtensionMappings) Validate

func (x *NSExtensionMappings) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type NSExtensionMappingsResponse

type NSExtensionMappingsResponse struct {
	// An array of dictionaries that contains information about extensions on the device.
	Extensions []NSExtensionMappingsResponseExtensions `plist:"Extensions,omitempty" json:"Extensions,omitempty"`
}

NSExtensionMappingsResponse: Response to NSExtensionMappings.

NSExtensionMappingsResponse corresponds to mdm/commands/application.extensions.mappings.yaml (NSExtension Mappings Command).

func (*NSExtensionMappingsResponse) ResponseRequestTypeName

func (*NSExtensionMappingsResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "NSExtensionMappings".

func (*NSExtensionMappingsResponse) SchemaPath

func (*NSExtensionMappingsResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*NSExtensionMappingsResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type NSExtensionMappingsResponseExtensions

type NSExtensionMappingsResponseExtensions struct {
	// The identifier of the extension.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// The `NSExtensionPointIdentifier` for the extension.
	ExtensionPoint string `plist:"ExtensionPoint" json:"ExtensionPoint"`
	// The display name of the extension.
	DisplayName string `plist:"DisplayName" json:"DisplayName"`
}

NSExtensionMappingsResponseExtensions: A dictionary that contains information about an extension.

type OSUpdateStatus

type OSUpdateStatus struct {
}

OSUpdateStatus: Get the status of operating-system updates on a device.

OSUpdateStatus corresponds to mdm/commands/system.update.status.yaml (OS Update Status Command).

func (*OSUpdateStatus) RequestTypeName

func (*OSUpdateStatus) RequestTypeName() string

RequestTypeName returns "OSUpdateStatus".

func (*OSUpdateStatus) SchemaPath

func (*OSUpdateStatus) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*OSUpdateStatus) Validate

func (x *OSUpdateStatus) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type OSUpdateStatusResponse

type OSUpdateStatusResponse struct {
	// An array of dictionaries that describes the statuses of software updates. The array is
	// empty if there are no software updates currently in progress. This command only returns
	// the status for System Applications and Configuration Data updates when a software update
	// is managed by a Declarative Device Management `SoftwareUpdateEnforcementSpecific`
	// configuration.
	OSUpdateStatus []OSUpdateStatusResponseOSUpdateStatus `plist:"OSUpdateStatus,omitempty" json:"OSUpdateStatus,omitempty"`
}

OSUpdateStatusResponse: Response to OSUpdateStatus.

OSUpdateStatusResponse corresponds to mdm/commands/system.update.status.yaml (OS Update Status Command).

func (*OSUpdateStatusResponse) ResponseRequestTypeName

func (*OSUpdateStatusResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "OSUpdateStatus".

func (*OSUpdateStatusResponse) SchemaPath

func (*OSUpdateStatusResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*OSUpdateStatusResponse) Validate

func (x *OSUpdateStatusResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type OSUpdateStatusResponseOSUpdateStatus

type OSUpdateStatusResponseOSUpdateStatus struct {
	// The product key that represents the update.
	ProductKey string `plist:"ProductKey" json:"ProductKey"`
	// If `true`, the update has finished downloading.
	IsDownloaded bool `plist:"IsDownloaded" json:"IsDownloaded"`
	// A floating-point number between `0.0` and `1.0` that indicates the download progress as
	// a percentage.
	DownloadPercentComplete float64 `plist:"DownloadPercentComplete" json:"DownloadPercentComplete"`
	// The status of the update, which is one of the following values:
	Status string `plist:"Status" json:"Status"`
	// The number of times a user can defer this OS update.
	MaxDeferrals *int64 `plist:"MaxDeferrals,omitempty" json:"MaxDeferrals,omitempty"`
	// The number of remaining user deferrals for this OS update.
	DeferralsRemaining *int64 `plist:"DeferralsRemaining,omitempty" json:"DeferralsRemaining,omitempty"`
	// The date of the next attempt at installing this OS update.
	NextScheduledInstall *time.Time `plist:"NextScheduledInstall,omitempty" json:"NextScheduledInstall,omitempty"`
	// The dates/times when the OS notified the user about installing this OS update.
	PastNotifications []time.Time `plist:"PastNotifications,omitempty" json:"PastNotifications,omitempty"`
}

OSUpdateStatusResponseOSUpdateStatus: A dictionary that describes the status of a software update.

type PlayLostModeSound

type PlayLostModeSound struct {
}

PlayLostModeSound: Play the Lost Mode sound on a device that's in Lost Mode.

PlayLostModeSound corresponds to mdm/commands/device.lostmode.playsound.yaml (Play Lost Mode Sound Command).

func (*PlayLostModeSound) RequestTypeName

func (*PlayLostModeSound) RequestTypeName() string

RequestTypeName returns "PlayLostModeSound".

func (*PlayLostModeSound) SchemaPath

func (*PlayLostModeSound) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*PlayLostModeSound) Validate

func (x *PlayLostModeSound) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type PlayLostModeSoundResponse

type PlayLostModeSoundResponse struct {
}

PlayLostModeSoundResponse: Response to PlayLostModeSound.

PlayLostModeSoundResponse corresponds to mdm/commands/device.lostmode.playsound.yaml (Play Lost Mode Sound Command).

func (*PlayLostModeSoundResponse) ResponseRequestTypeName

func (*PlayLostModeSoundResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "PlayLostModeSound".

func (*PlayLostModeSoundResponse) SchemaPath

func (*PlayLostModeSoundResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*PlayLostModeSoundResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ProfileList

type ProfileList struct {
	// If `true`, only include profiles that MDM has installed. For user enrollments, the
	// device ignores this key and always limits the results to managed profiles. This value is
	// available in iOS 13 and later, macOS 10.5 and later, and tvOS 13 and later.
	ManagedOnly *bool `plist:"ManagedOnly,omitempty" json:"ManagedOnly,omitempty"`
}

ProfileList: Get a list of installed profiles on a device.

ProfileList corresponds to mdm/commands/profile.list.yaml (Profile List Command).

func (*ProfileList) RequestTypeName

func (*ProfileList) RequestTypeName() string

RequestTypeName returns "ProfileList".

func (*ProfileList) SchemaPath

func (*ProfileList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ProfileList) Validate

func (x *ProfileList) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ProfileListResponse

type ProfileListResponse struct {
	// An array of dictionaries that describes each installed profile.
	ProfileList []ProfileListResponseProfileList `plist:"ProfileList,omitempty" json:"ProfileList,omitempty"`
}

ProfileListResponse: Response to ProfileList.

ProfileListResponse corresponds to mdm/commands/profile.list.yaml (Profile List Command).

func (*ProfileListResponse) ResponseRequestTypeName

func (*ProfileListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ProfileList".

func (*ProfileListResponse) SchemaPath

func (*ProfileListResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ProfileListResponse) Validate

func (x *ProfileListResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ProfileListResponseProfileList

type ProfileListResponseProfileList struct {
	// The unique identifier for the profile.
	PayloadUUID string `plist:"PayloadUUID" json:"PayloadUUID"`
	// The reverse-DNS-style identifier of the profile; for example, `com.example.myprofile`.
	PayloadIdentifier string `plist:"PayloadIdentifier" json:"PayloadIdentifier"`
	// The version of the configuration profile as a whole, not of the individual profiles
	// within it. The value should be `1`.
	PayloadVersion *int64 `plist:"PayloadVersion,omitempty" json:"PayloadVersion,omitempty"`
	// The human-readable name of the profile.
	PayloadDisplayName *string `plist:"PayloadDisplayName,omitempty" json:"PayloadDisplayName,omitempty"`
	// The human-readable name of the organization that provided the profile.
	PayloadOrganization *string `plist:"PayloadOrganization,omitempty" json:"PayloadOrganization,omitempty"`
	// The description of the profile.
	PayloadDescription *string `plist:"PayloadDescription,omitempty" json:"PayloadDescription,omitempty"`
	// If `true`, the user can't delete the profile unless it has a removal password and the
	// user provides it. The framework ignores this field on unsupervised devices.
	PayloadRemovalDisallowed *bool `plist:"PayloadRemovalDisallowed,omitempty" json:"PayloadRemovalDisallowed,omitempty"`
	// If `true`, the profile has a passcode for removal.
	HasRemovalPasscode *bool `plist:"HasRemovalPasscode,omitempty" json:"HasRemovalPasscode,omitempty"`
	// If `true`, it's an encrypted profile.
	IsEncrypted *bool `plist:"IsEncrypted,omitempty" json:"IsEncrypted,omitempty"`
	// An array that contains the certificate for signing the profile, followed by any
	// intermediate certificates, in DER-encoded X.509 format.
	SignerCertificates [][]byte `plist:"SignerCertificates,omitempty" json:"SignerCertificates,omitempty"`
	// If `true`, the current MDM service installed the profile. MDM doesn't return this value
	// for supervised devices, and can remove or replace all profiles on supervised devices.
	IsManaged *bool `plist:"IsManaged,omitempty" json:"IsManaged,omitempty"`
	// A string set to `Declarative Device Management` when the profile is managed by
	// Declarative Device Management.
	Source *string `plist:"Source,omitempty" json:"Source,omitempty"`
	// An array of payload content items. This value isn't present if `IsEncrypted` is `true`.
	PayloadContent []ProfileListResponseProfileListPayloadContent `plist:"PayloadContent,omitempty" json:"PayloadContent,omitempty"`
}

ProfileListResponseProfileList: A dictionary that describes a profile list item.

type ProfileListResponseProfileListPayloadContent

type ProfileListResponseProfileListPayloadContent struct {
	// The type of payload, such as `com.apple.wifi.managed`.
	PayloadType string `plist:"PayloadType" json:"PayloadType"`
	// The version of the payload. The value is `1`.
	PayloadVersion int64 `plist:"PayloadVersion" json:"PayloadVersion"`
	// The reverse-DNS-style identifier of the payload, such as `com.example.mypayload`.
	PayloadIdentifier string `plist:"PayloadIdentifier" json:"PayloadIdentifier"`
	// The unique identifier of the payload.
	PayloadUUID string `plist:"PayloadUUID" json:"PayloadUUID"`
	// The human-readable name of the payload.
	PayloadDisplayName *string `plist:"PayloadDisplayName,omitempty" json:"PayloadDisplayName,omitempty"`
	// A description of the payload.
	PayloadDescription *string `plist:"PayloadDescription,omitempty" json:"PayloadDescription,omitempty"`
	// The human-readable name of the organization that provided the payload.
	PayloadOrganization *string `plist:"PayloadOrganization,omitempty" json:"PayloadOrganization,omitempty"`
}

ProfileListResponseProfileListPayloadContent: A dictionary that describes a profile payload content item.

type ProvisioningProfileList

type ProvisioningProfileList struct {
	// If `true`, only include profiles that MDM has installed. For user enrollments, the
	// device ignores this key and always limits the results to managed profiles. This value is
	// available in iOS 13 and later, and tvOS 13 and later.
	ManagedOnly *bool `plist:"ManagedOnly,omitempty" json:"ManagedOnly,omitempty"`
}

ProvisioningProfileList: Get a list of installed provisioning profiles on a device.

ProvisioningProfileList corresponds to mdm/commands/profile.provisioning.list.yaml (Provisioning Profile List Command).

func (*ProvisioningProfileList) RequestTypeName

func (*ProvisioningProfileList) RequestTypeName() string

RequestTypeName returns "ProvisioningProfileList".

func (*ProvisioningProfileList) SchemaPath

func (*ProvisioningProfileList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ProvisioningProfileList) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ProvisioningProfileListResponse

type ProvisioningProfileListResponse struct {
	// An array of dictionaries that describes each installed profile.
	ProvisioningProfileList []ProvisioningProfileListResponseProvisioningProfileList `plist:"ProvisioningProfileList,omitempty" json:"ProvisioningProfileList,omitempty"`
}

ProvisioningProfileListResponse: Response to ProvisioningProfileList.

ProvisioningProfileListResponse corresponds to mdm/commands/profile.provisioning.list.yaml (Provisioning Profile List Command).

func (*ProvisioningProfileListResponse) ResponseRequestTypeName

func (*ProvisioningProfileListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ProvisioningProfileList".

func (*ProvisioningProfileListResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*ProvisioningProfileListResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ProvisioningProfileListResponseProvisioningProfileList

type ProvisioningProfileListResponseProvisioningProfileList struct {
	// The display name of the provisioning profile.
	Name string `plist:"Name" json:"Name"`
	// The unique identifier for the provisioning profile.
	UUID string `plist:"UUID" json:"UUID"`
	// The expiry date of the provisioning profile.
	ExpiryDate *time.Time `plist:"ExpiryDate,omitempty" json:"ExpiryDate,omitempty"`
}

ProvisioningProfileListResponseProvisioningProfileList: A dictionary that describes a provisioning profile list item.

type RefreshCellularPlans

type RefreshCellularPlans struct {
	// The carrier's eSIM server URL to query. Obtain this URL from each carrier separately.
	ESIMServerURL string `plist:"eSIMServerURL" json:"eSIMServerURL"`
}

RefreshCellularPlans: Query a carrier URL for active eSIM cellular-plan profiles on a device.

RefreshCellularPlans corresponds to mdm/commands/device.esim.yaml (Refresh Cellular Plans Command).

func (*RefreshCellularPlans) RequestTypeName

func (*RefreshCellularPlans) RequestTypeName() string

RequestTypeName returns "RefreshCellularPlans".

func (*RefreshCellularPlans) SchemaPath

func (*RefreshCellularPlans) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RefreshCellularPlans) Validate

func (x *RefreshCellularPlans) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RefreshCellularPlansResponse

type RefreshCellularPlansResponse struct {
}

RefreshCellularPlansResponse: Response to RefreshCellularPlans.

RefreshCellularPlansResponse corresponds to mdm/commands/device.esim.yaml (Refresh Cellular Plans Command).

func (*RefreshCellularPlansResponse) ResponseRequestTypeName

func (*RefreshCellularPlansResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RefreshCellularPlans".

func (*RefreshCellularPlansResponse) SchemaPath

func (*RefreshCellularPlansResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RefreshCellularPlansResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveApplication

type RemoveApplication struct {
	// The bundle identifier of the managed app.
	Identifier string `plist:"Identifier" json:"Identifier"`
}

RemoveApplication: Remove an app.

RemoveApplication corresponds to mdm/commands/application.remove.yaml (Remove Application Command).

func (*RemoveApplication) RequestTypeName

func (*RemoveApplication) RequestTypeName() string

RequestTypeName returns "RemoveApplication".

func (*RemoveApplication) SchemaPath

func (*RemoveApplication) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveApplication) Validate

func (x *RemoveApplication) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveApplicationResponse

type RemoveApplicationResponse struct {
}

RemoveApplicationResponse: Response to RemoveApplication.

RemoveApplicationResponse corresponds to mdm/commands/application.remove.yaml (Remove Application Command).

func (*RemoveApplicationResponse) ResponseRequestTypeName

func (*RemoveApplicationResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RemoveApplication".

func (*RemoveApplicationResponse) SchemaPath

func (*RemoveApplicationResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveApplicationResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveMedia

type RemoveMedia struct {
	// The media type, which can only be `Book`.
	MediaType string `plist:"MediaType" json:"MediaType"`
	// The book's iTunes Store identifier.
	ITunesStoreID *string `plist:"iTunesStoreID,omitempty" json:"iTunesStoreID,omitempty"`
	// The book's persistent identifier in reverse-DNS form; for example,
	// `com.acme.manuals.training`.
	PersistentID *string `plist:"PersistentID,omitempty" json:"PersistentID,omitempty"`
}

RemoveMedia: Remove a previously installed book from a device.

RemoveMedia corresponds to mdm/commands/media.remove.yaml (Remove Media Command).

func (*RemoveMedia) RequestTypeName

func (*RemoveMedia) RequestTypeName() string

RequestTypeName returns "RemoveMedia".

func (*RemoveMedia) SchemaPath

func (*RemoveMedia) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveMedia) Validate

func (x *RemoveMedia) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveMediaResponse

type RemoveMediaResponse struct {
}

RemoveMediaResponse: Response to RemoveMedia.

RemoveMediaResponse corresponds to mdm/commands/media.remove.yaml (Remove Media Command).

func (*RemoveMediaResponse) ResponseRequestTypeName

func (*RemoveMediaResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RemoveMedia".

func (*RemoveMediaResponse) SchemaPath

func (*RemoveMediaResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveMediaResponse) Validate

func (x *RemoveMediaResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveProfile

type RemoveProfile struct {
	// The identifier of the profile to remove.
	Identifier string `plist:"Identifier" json:"Identifier"`
}

RemoveProfile: Remove a previously installed profile from the device.

RemoveProfile corresponds to mdm/commands/profile.remove.yaml (Remove Profile Command).

func (*RemoveProfile) RequestTypeName

func (*RemoveProfile) RequestTypeName() string

RequestTypeName returns "RemoveProfile".

func (*RemoveProfile) SchemaPath

func (*RemoveProfile) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveProfile) Validate

func (x *RemoveProfile) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveProfileResponse

type RemoveProfileResponse struct {
}

RemoveProfileResponse: Response to RemoveProfile.

RemoveProfileResponse corresponds to mdm/commands/profile.remove.yaml (Remove Profile Command).

func (*RemoveProfileResponse) ResponseRequestTypeName

func (*RemoveProfileResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RemoveProfile".

func (*RemoveProfileResponse) SchemaPath

func (*RemoveProfileResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveProfileResponse) Validate

func (x *RemoveProfileResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveProvisioningProfile

type RemoveProvisioningProfile struct {
	// The unique identifier of the provisioning profile to remove.
	UUID string `plist:"UUID" json:"UUID"`
}

RemoveProvisioningProfile: Remove a previously installed provisioning profile from a device.

RemoveProvisioningProfile corresponds to mdm/commands/profile.provisioning.remove.yaml (Remove Provisioning Profile Command).

func (*RemoveProvisioningProfile) RequestTypeName

func (*RemoveProvisioningProfile) RequestTypeName() string

RequestTypeName returns "RemoveProvisioningProfile".

func (*RemoveProvisioningProfile) SchemaPath

func (*RemoveProvisioningProfile) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveProvisioningProfile) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RemoveProvisioningProfileResponse

type RemoveProvisioningProfileResponse struct {
}

RemoveProvisioningProfileResponse: Response to RemoveProvisioningProfile.

RemoveProvisioningProfileResponse corresponds to mdm/commands/profile.provisioning.remove.yaml (Remove Provisioning Profile Command).

func (*RemoveProvisioningProfileResponse) ResponseRequestTypeName

func (*RemoveProvisioningProfileResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RemoveProvisioningProfile".

func (*RemoveProvisioningProfileResponse) SchemaPath

SchemaPath returns the Apple schema file this type was generated from.

func (*RemoveProvisioningProfileResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RequestMirroring

type RequestMirroring struct {
	// The name of the AirPlay Mirroring destination.
	DestinationName *string `plist:"DestinationName,omitempty" json:"DestinationName,omitempty"`
	// The hardware address of the AirPlay Mirroring destination that identifies the device, in
	// the format `xx:xx:xx:xx:xx`. This value isn't case-sensitive. Not available for Apple TV
	// devices running tvOS 18 or later, use `DestinationName` instead.
	DestinationDeviceID *string `plist:"DestinationDeviceID,omitempty" json:"DestinationDeviceID,omitempty"`
	// The number of seconds, from `10` to `300`, for the device to spend searching for the
	// destination. The default value is `30`.
	ScanTime *int64 `plist:"ScanTime,omitempty" json:"ScanTime,omitempty"`
	// The screen-sharing password that the device uses when connecting to the destination.
	Password *string `plist:"Password,omitempty" json:"Password,omitempty"`
}

RequestMirroring: Prompt the user to share their screen using AirPlay Mirroring.

RequestMirroring corresponds to mdm/commands/mirroring.request.yaml (Request Mirroring Command).

func (*RequestMirroring) RequestTypeName

func (*RequestMirroring) RequestTypeName() string

RequestTypeName returns "RequestMirroring".

func (*RequestMirroring) SchemaPath

func (*RequestMirroring) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RequestMirroring) Validate

func (x *RequestMirroring) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RequestMirroringResponse

type RequestMirroringResponse struct {
	// The result of the request. One of these values:
	MirroringResult *string `plist:"MirroringResult,omitempty" json:"MirroringResult,omitempty"`
}

RequestMirroringResponse: Response to RequestMirroring.

RequestMirroringResponse corresponds to mdm/commands/mirroring.request.yaml (Request Mirroring Command).

func (*RequestMirroringResponse) ResponseRequestTypeName

func (*RequestMirroringResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RequestMirroring".

func (*RequestMirroringResponse) SchemaPath

func (*RequestMirroringResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RequestMirroringResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type Response

type Response interface {
	// ResponseRequestTypeName returns the RequestType this responds to.
	ResponseRequestTypeName() string
	SchemaPath() string
	Validate(t support.Target) error
}

Response is implemented by every command response type.

type RestartDevice

type RestartDevice struct {
	// If `true`, the system rebuilds the kernel cache during a device restart. If
	// `BootstrapTokenAllowedForAuthentication` is `true` in the `SecurityInfo` response, the
	// device requests the bootstrap token from the MDM server prior to executing this command.
	// This value is available in macOS 11 and later.
	RebuildKernelCache *bool `plist:"RebuildKernelCache,omitempty" json:"RebuildKernelCache,omitempty"`
	// If `RebuildKernelCache` is `true`, this value specifies the paths to kexts to add to the
	// auxiliary kernel cache since the last kernel cache rebuild. If not present, the system
	// only adds previously discovered kexts to the kernel cache. This value is available in
	// macOS 11 and later.
	KextPaths []string `plist:"KextPaths,omitempty" json:"KextPaths,omitempty"`
	// If `true`, notifies the user to restart the device at their convenience. No forced
	// restart occurs unless the device is at `loginwindow` with no logged-in users. The user
	// can dismiss the notification and ignore the request. No further notifications display
	// unless you resend the command.
	NotifyUser *bool `plist:"NotifyUser,omitempty" json:"NotifyUser,omitempty"`
}

RestartDevice: Remotely and immediately restart a device.

RestartDevice corresponds to mdm/commands/device.restart.yaml (Restart Device Command).

func (*RestartDevice) RequestTypeName

func (*RestartDevice) RequestTypeName() string

RequestTypeName returns "RestartDevice".

func (*RestartDevice) SchemaPath

func (*RestartDevice) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RestartDevice) Validate

func (x *RestartDevice) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RestartDeviceResponse

type RestartDeviceResponse struct {
}

RestartDeviceResponse: Response to RestartDevice.

RestartDeviceResponse corresponds to mdm/commands/device.restart.yaml (Restart Device Command).

func (*RestartDeviceResponse) ResponseRequestTypeName

func (*RestartDeviceResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RestartDevice".

func (*RestartDeviceResponse) SchemaPath

func (*RestartDeviceResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RestartDeviceResponse) Validate

func (x *RestartDeviceResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type Restrictions

type Restrictions struct {
	// If `true`, the device reports restrictions from each profile. This value is available in
	// iOS 4 and later, and tvOS 6.1 and later.
	ProfileRestrictions *bool `plist:"ProfileRestrictions,omitempty" json:"ProfileRestrictions,omitempty"`
}

Restrictions: Get a list of restrictions on the device.

Restrictions corresponds to mdm/commands/device.restrictions.list.yaml (Restrictions Command).

func (*Restrictions) RequestTypeName

func (*Restrictions) RequestTypeName() string

RequestTypeName returns "Restrictions".

func (*Restrictions) SchemaPath

func (*Restrictions) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*Restrictions) Validate

func (x *Restrictions) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RestrictionsBooleanDictionary

type RestrictionsBooleanDictionary struct {
	// The value of the restriction.
	Value bool `plist:"value" json:"value"`
}

RestrictionsBooleanDictionary: The Boolean restriction parameters.

type RestrictionsIntersectionDictionary

type RestrictionsIntersectionDictionary struct {
	// The values of the restriction.
	Values []string `plist:"values,omitempty" json:"values,omitempty"`
}

RestrictionsIntersectionDictionary: The intersected restriction parameters.

type RestrictionsResponse

type RestrictionsResponse struct {
	// A dictionary that contains the global restrictions in effect. This value is available in
	// iOS 4 and later, and tvOS 6.1 and later.
	GlobalRestrictions RestrictionsRestrictionsDictionary `plist:"GlobalRestrictions,omitempty" json:"GlobalRestrictions,omitempty"`
	// A dictionary that contains dictionaries of restrictions from each profile. This value is
	// only available when `ProfileRestrictions` is `true` in the command. The keys are the
	// identifiers of the profiles. This value is available in iOS 4 and later, and tvOS 6.1
	// and later.
	ProfileRestrictions map[string]RestrictionsRestrictionsDictionary `plist:"ProfileRestrictions,omitempty" json:"ProfileRestrictions,omitempty"`
}

RestrictionsResponse: Response to Restrictions.

RestrictionsResponse corresponds to mdm/commands/device.restrictions.list.yaml (Restrictions Command).

func (*RestrictionsResponse) ResponseRequestTypeName

func (*RestrictionsResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "Restrictions".

func (*RestrictionsResponse) SchemaPath

func (*RestrictionsResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RestrictionsResponse) Validate

func (x *RestrictionsResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RestrictionsRestrictionsDictionary

type RestrictionsRestrictionsDictionary struct {
	// A dictionary of Boolean profile restrictions.
	RestrictedBool map[string]RestrictionsBooleanDictionary `plist:"restrictedBool,omitempty" json:"restrictedBool,omitempty"`
	// A dictionary of numeric profile restrictions.
	RestrictedValue map[string]RestrictionsValueDictionary `plist:"restrictedValue,omitempty" json:"restrictedValue,omitempty"`
	// A dictionary of intersected profile restrictions. Intersected restrictions indicate that
	// new restrictions can only reduce the number of strings in the set.
	Intersection map[string]RestrictionsIntersectionDictionary `plist:"intersection,omitempty" json:"intersection,omitempty"`
	// A dictionary of unioned profile restrictions. Unioned restrictions indicate that new
	// restrictions can add to the set.
	Union map[string]RestrictionsUnionDictionary `plist:"union,omitempty" json:"union,omitempty"`
}

RestrictionsRestrictionsDictionary: A dictionary that contains the global restrictions in effect. This value is available in iOS 4 and later, and tvOS 6.1 and later.

type RestrictionsUnionDictionary

type RestrictionsUnionDictionary struct {
	// The values of the restriction.
	Values []string `plist:"values,omitempty" json:"values,omitempty"`
}

RestrictionsUnionDictionary: The unioned restriction parameters.

type RestrictionsValueDictionary

type RestrictionsValueDictionary struct {
	// The value of the restriction.
	Value int64 `plist:"value" json:"value"`
}

RestrictionsValueDictionary: The numeric restriction parameters.

type RotateFileVaultKey

type RotateFileVaultKey struct {
	// The type of FileVault key you want to change the password for. Set this value to
	// `personal` and set a value for `Password` in the `FileVaultUnlock` dictionary to enable
	// unlocking a device with a password. Set this value to `institutional` and set values for
	// `PrivateKeyExport` and `PrivateKeyExportPassword` in the `FileVaultUnlock` dictionary.
	KeyType string `plist:"KeyType" json:"KeyType"`
	// A dictionary that contains FileVault unlock options.
	FileVaultUnlock RotateFileVaultKeyFileVaultUnlock `plist:"FileVaultUnlock,omitempty" json:"FileVaultUnlock,omitempty"`
	// A DER-encoded certificate for creating a new institutional recovery key, which the
	// system requires if `KeyType` is `institutional`.
	NewCertificate []byte `plist:"NewCertificate,omitempty" json:"NewCertificate,omitempty"`
	// A DER-encoded certificate for encrypting the new personal recovery key in a wrapper
	// conforming to the IETF Cryptographic Message Syntax (CMS) standard.
	ReplyEncryptionCertificate []byte `plist:"ReplyEncryptionCertificate,omitempty" json:"ReplyEncryptionCertificate,omitempty"`
}

RotateFileVaultKey: Change the FileVault primary password on a device.

RotateFileVaultKey corresponds to mdm/commands/rotate.file.vault.key.yaml (Rotate FileVault Key Command).

func (*RotateFileVaultKey) RequestTypeName

func (*RotateFileVaultKey) RequestTypeName() string

RequestTypeName returns "RotateFileVaultKey".

func (*RotateFileVaultKey) SchemaPath

func (*RotateFileVaultKey) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RotateFileVaultKey) Validate

func (x *RotateFileVaultKey) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RotateFileVaultKeyFileVaultUnlock

type RotateFileVaultKeyFileVaultUnlock struct {
	// A FileVault user's password, or if using a CoreStorage volume, the personal recovery
	// key.
	Password *string `plist:"Password,omitempty" json:"Password,omitempty"`
	// The data for a .p12 export of the private key for the current institutional recovery
	// key, which requires that `KeyType` is `institutional`. The system ignores this key on
	// APFS volumes.
	PrivateKeyExport []byte `plist:"PrivateKeyExport,omitempty" json:"PrivateKeyExport,omitempty"`
	// The password for `PrivateKeyExport`. Either `Password` or both `PrivateKeyExport` and
	// `PrivateKeyExportPassword` must be present. The system ignores this key on APFS volumes.
	PrivateKeyExportPassword *string `plist:"PrivateKeyExportPassword,omitempty" json:"PrivateKeyExportPassword,omitempty"`
}

RotateFileVaultKeyFileVaultUnlock: A dictionary that contains FileVault unlock options.

type RotateFileVaultKeyResponse

type RotateFileVaultKeyResponse struct {
	// The result of rotating the personal recovery key.
	RotateResult *RotateFileVaultKeyRotateResultItem `plist:"RotateResult,omitempty" json:"RotateResult,omitempty"`
}

RotateFileVaultKeyResponse: Response to RotateFileVaultKey.

RotateFileVaultKeyResponse corresponds to mdm/commands/rotate.file.vault.key.yaml (Rotate FileVault Key Command).

func (*RotateFileVaultKeyResponse) ResponseRequestTypeName

func (*RotateFileVaultKeyResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "RotateFileVaultKey".

func (*RotateFileVaultKeyResponse) SchemaPath

func (*RotateFileVaultKeyResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*RotateFileVaultKeyResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type RotateFileVaultKeyRotateResultItem

type RotateFileVaultKeyRotateResultItem struct {
	// A new personal recovery key that is encrypted using a `ReplyEncryptionCertificate` as a
	// CMS-compliant envelope.
	EncryptedNewRecoveryKey []byte `plist:"EncryptedNewRecoveryKey,omitempty" json:"EncryptedNewRecoveryKey,omitempty"`
}

RotateFileVaultKeyRotateResultItem: The result of rotating the personal recovery key.

type ScheduleOSUpdate

type ScheduleOSUpdate struct {
	// An array of dictionaries specifying the updates to download or install. If this value is
	// missing, the device applies the default behavior for handling updates. The device
	// ignores this command and an informational error is returned, if a software update is
	// managed by a Declarative Device Management `SoftwareUpdateEnforcementSpecific`
	// configuration, as the configuration takes precedence.
	Updates []ScheduleOSUpdateUpdates `plist:"Updates,omitempty" json:"Updates,omitempty"`
}

ScheduleOSUpdate: Schedule an update of the operating system on a device.

ScheduleOSUpdate corresponds to mdm/commands/system.update.schedule.yaml (Schedule OS Update Command).

func (*ScheduleOSUpdate) RequestTypeName

func (*ScheduleOSUpdate) RequestTypeName() string

RequestTypeName returns "ScheduleOSUpdate".

func (*ScheduleOSUpdate) SchemaPath

func (*ScheduleOSUpdate) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ScheduleOSUpdate) Validate

func (x *ScheduleOSUpdate) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ScheduleOSUpdateResponse

type ScheduleOSUpdateResponse struct {
	// An array of dictionaries that describes the results of processing operating-system
	// updates.
	UpdateResults []ScheduleOSUpdateResponseUpdateResults `plist:"UpdateResults,omitempty" json:"UpdateResults,omitempty"`
}

ScheduleOSUpdateResponse: Response to ScheduleOSUpdate.

ScheduleOSUpdateResponse corresponds to mdm/commands/system.update.schedule.yaml (Schedule OS Update Command).

func (*ScheduleOSUpdateResponse) ResponseRequestTypeName

func (*ScheduleOSUpdateResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ScheduleOSUpdate".

func (*ScheduleOSUpdateResponse) SchemaPath

func (*ScheduleOSUpdateResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ScheduleOSUpdateResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ScheduleOSUpdateResponseUpdateResults

type ScheduleOSUpdateResponseUpdateResults struct {
	// The product key that represents the update.
	ProductKey string `plist:"ProductKey" json:"ProductKey"`
	// The install action that the device scheduled, which is one of the following values:
	InstallAction string `plist:"InstallAction" json:"InstallAction"`
	// The status of the update, which is one of the following values:
	Status string `plist:"Status" json:"Status"`
	// A dictionary that describes an error chain.
	ErrorChain []ScheduleOSUpdateResponseUpdateResultsErrorChain `plist:"ErrorChain,omitempty" json:"ErrorChain,omitempty"`
}

ScheduleOSUpdateResponseUpdateResults: The response dictionary that describes the result of processing an operating-system update.

type ScheduleOSUpdateResponseUpdateResultsErrorChain

type ScheduleOSUpdateResponseUpdateResultsErrorChain struct {
	// The error details.
	ANY any `plist:"ANY,omitempty" json:"ANY,omitempty"`
}

ScheduleOSUpdateResponseUpdateResultsErrorChain: A dictionary that describes an error chain item.

type ScheduleOSUpdateScan

type ScheduleOSUpdateScan struct {
	// If `true`, force a scan to start immediately. Otherwise, the scan starts at a
	// system-determined time.
	Force *bool `plist:"Force,omitempty" json:"Force,omitempty"`
}

ScheduleOSUpdateScan: Schedule a background scan for operating-system updates on a device.

ScheduleOSUpdateScan corresponds to mdm/commands/system.update.scan.yaml (Schedule OS Update Scan Command).

func (*ScheduleOSUpdateScan) RequestTypeName

func (*ScheduleOSUpdateScan) RequestTypeName() string

RequestTypeName returns "ScheduleOSUpdateScan".

func (*ScheduleOSUpdateScan) SchemaPath

func (*ScheduleOSUpdateScan) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ScheduleOSUpdateScan) Validate

func (x *ScheduleOSUpdateScan) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ScheduleOSUpdateScanResponse

type ScheduleOSUpdateScanResponse struct {
	// If `true`, the scan started successfully.
	ScanInitiated bool `plist:"ScanInitiated" json:"ScanInitiated"`
}

ScheduleOSUpdateScanResponse: Response to ScheduleOSUpdateScan.

ScheduleOSUpdateScanResponse corresponds to mdm/commands/system.update.scan.yaml (Schedule OS Update Scan Command).

func (*ScheduleOSUpdateScanResponse) ResponseRequestTypeName

func (*ScheduleOSUpdateScanResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ScheduleOSUpdateScan".

func (*ScheduleOSUpdateScanResponse) SchemaPath

func (*ScheduleOSUpdateScanResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ScheduleOSUpdateScanResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ScheduleOSUpdateUpdates

type ScheduleOSUpdateUpdates struct {
	// The product key that represents the update.
	ProductKey *string `plist:"ProductKey,omitempty" json:"ProductKey,omitempty"`
	// The version of the update, which the system requires if `ProductKey` isn't present. This
	// value is available in iOS 11.3 and later, macOS 12 and later, and tvOS 12.2 and later.
	ProductVersion *string `plist:"ProductVersion,omitempty" json:"ProductVersion,omitempty"`
	// The install action, which is one of the following values:
	InstallAction string `plist:"InstallAction" json:"InstallAction"`
	// The maximum number of times the system allows the user to postpone an update before it's
	// installed. The system prompts the user once a day.
	MaxUserDeferrals *int64 `plist:"MaxUserDeferrals,omitempty" json:"MaxUserDeferrals,omitempty"`
	// The scheduling priority for downloading and preparing the requested update. This is only
	// supported for minor OS updates (macOS 12.x to 12.y).
	Priority *string `plist:"Priority,omitempty" json:"Priority,omitempty"`
}

ScheduleOSUpdateUpdates: A dictionary that describes the available operating-system updates item.

type SecurityInfo

type SecurityInfo struct {
}

SecurityInfo: Get security-related information about a device.

SecurityInfo corresponds to mdm/commands/information.security.yaml (Security Info Command).

func (*SecurityInfo) RequestTypeName

func (*SecurityInfo) RequestTypeName() string

RequestTypeName returns "SecurityInfo".

func (*SecurityInfo) SchemaPath

func (*SecurityInfo) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SecurityInfo) Validate

func (x *SecurityInfo) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SecurityInfoResponse

type SecurityInfoResponse struct {
	// A dictionary that contains security-related information.
	SecurityInfo SecurityInfoResponseSecurityInfo `plist:"SecurityInfo,omitempty" json:"SecurityInfo,omitempty"`
}

SecurityInfoResponse: Response to SecurityInfo.

SecurityInfoResponse corresponds to mdm/commands/information.security.yaml (Security Info Command).

func (*SecurityInfoResponse) ResponseRequestTypeName

func (*SecurityInfoResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "SecurityInfo".

func (*SecurityInfoResponse) SchemaPath

func (*SecurityInfoResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SecurityInfoResponse) Validate

func (x *SecurityInfoResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SecurityInfoResponseSecurityInfo

type SecurityInfoResponseSecurityInfo struct {
	// An integer that indicates the underlying hardware encryption capabilities of the device,
	// which is one of the following values:
	HardwareEncryptionCaps *int64 `plist:"HardwareEncryptionCaps,omitempty" json:"HardwareEncryptionCaps,omitempty"`
	// If `true`, the device has a passcode. This key doesn't apply to User-Enrolled devices.
	// This value is available in iOS 4 and later, and tvOS 6 and later.
	PasscodePresent *bool `plist:"PasscodePresent,omitempty" json:"PasscodePresent,omitempty"`
	// If `true`, the user's passcode is compliant with all requirements on the device,
	// including Exchange and other accounts. This value is available in iOS 4 and later, and
	// tvOS 6 and later.
	PasscodeCompliant *bool `plist:"PasscodeCompliant,omitempty" json:"PasscodeCompliant,omitempty"`
	// If `true`, the user's passcode is compliant with requirements from profiles. This key
	// doesn't apply to User-Enrolled devices. This value is available in iOS 4 and later, and
	// tvOS 6 and later.
	PasscodeCompliantWithProfiles *bool `plist:"PasscodeCompliantWithProfiles,omitempty" json:"PasscodeCompliantWithProfiles,omitempty"`
	// The user preference for the number of seconds before a locked screen requires the device
	// passcode to unlock it. This value is only available for Shared iPad.
	PasscodeLockGracePeriod *int64 `plist:"PasscodeLockGracePeriod,omitempty" json:"PasscodeLockGracePeriod,omitempty"`
	// The enforced value for the number of seconds before a locked screen requires the device
	// passcode to unlock it. If a device has a passcode, changing `PasscodeLockGracePeriod` to
	// a larger value doesn't take effect until the user logs out or removes the passcode. This
	// value is only available for Shared iPad.
	PasscodeLockGracePeriodEnforced *int64 `plist:"PasscodeLockGracePeriodEnforced,omitempty" json:"PasscodeLockGracePeriodEnforced,omitempty"`
	// The number of seconds before a device goes to sleep after being idle. This value is only
	// available on Shared iPad in iOS 17 and later.
	AutoLockTime *int64 `plist:"AutoLockTime,omitempty" json:"AutoLockTime,omitempty"`
	// If `true`, the device has enabled FileVault full disk encryption (FDE). This value is
	// available in macOS 10.9 and later.
	FDEEnabled *bool `plist:"FDE_Enabled,omitempty" json:"FDE_Enabled,omitempty"`
	// If `true`, FileVault FDE has a personal recovery key. This value is available in macOS
	// 10.9 and later.
	FDEHasPersonalRecoveryKey *bool `plist:"FDE_HasPersonalRecoveryKey,omitempty" json:"FDE_HasPersonalRecoveryKey,omitempty"`
	// If `true`, FileVault FDE has an institutional recovery key. This value is available in
	// macOS 10.9 and later.
	FDEHasInstitutionalRecoveryKey *bool `plist:"FDE_HasInstitutionalRecoveryKey,omitempty" json:"FDE_HasInstitutionalRecoveryKey,omitempty"`
	// If the FileVault personal recovery key has enabled escrow with a recovery key, this
	// value contains the key. The certificate from the `FDERecoveryKeyEscrow` profile encrypts
	// the key and wraps it as CMS data. This value is available in macOS 10.13 and later.
	FDEPersonalRecoveryKeyCMS []byte `plist:"FDE_PersonalRecoveryKeyCMS,omitempty" json:"FDE_PersonalRecoveryKeyCMS,omitempty"`
	// If the FileVault personal recovery key has enabled escrow with a recovery key, this
	// value is the device serial number. This is the value that displays to the user at the
	// EFI Login Window as part of the help message if they enter their password incorrectly
	// three times. The server also uses this value as an index when saving the device personal
	// recovery key. This replaces the `recordNumber` that the server returned in the previous
	// escrow mechanism. This value is available in macOS 10.13 and later.
	FDEPersonalRecoveryKeyDeviceKey *string `plist:"FDE_PersonalRecoveryKeyDeviceKey,omitempty" json:"FDE_PersonalRecoveryKeyDeviceKey,omitempty"`
	// If `true`, System Integrity Protection (SIP) is active on the device. This value is
	// available in macOS 10.12 and later.
	SystemIntegrityProtectionEnabled *bool `plist:"SystemIntegrityProtectionEnabled,omitempty" json:"SystemIntegrityProtectionEnabled,omitempty"`
	// A dictionary that contains the firewall settings. This value is available in macOS 10.12
	// and later.
	FirewallSettings *SecurityInfoResponseSecurityInfoFirewallSettings `plist:"FirewallSettings,omitempty" json:"FirewallSettings,omitempty"`
	// A dictionary that contains the status of the EFI firmware password. This value is
	// available in macOS 10.13 and later.
	FirmwarePasswordStatus *SecurityInfoResponseSecurityInfoFirmwarePasswordStatus `plist:"FirmwarePasswordStatus,omitempty" json:"FirmwarePasswordStatus,omitempty"`
	// A dictionary that contains the status of the device's MDM enrollment.
	ManagementStatus *SecurityInfoResponseSecurityInfoManagementStatus `plist:"ManagementStatus,omitempty" json:"ManagementStatus,omitempty"`
	// A dictionary that contains the device's Secure Boot settings. This value is available in
	// macOS 10.15 and later.
	SecureBoot *SecurityInfoResponseSecurityInfoSecureBoot `plist:"SecureBoot,omitempty" json:"SecureBoot,omitempty"`
	// If `true`, Remote Desktop is active on the device. This value is available in macOS
	// 10.14.4 and later.
	RemoteDesktopEnabled *bool `plist:"RemoteDesktopEnabled,omitempty" json:"RemoteDesktopEnabled,omitempty"`
	// If `true`, the system booted using an Authenticated Root Volume. This value is available
	// in macOS 11 and later.
	AuthenticatedRootVolumeEnabled *bool `plist:"AuthenticatedRootVolumeEnabled,omitempty" json:"AuthenticatedRootVolumeEnabled,omitempty"`
	// This value specifies whether the Secure Enclave Processor (SEP) supports and allows
	// secure operations to use the Bootstrap Token. The value is automatically set for devices
	// enrolled through the Device Enrollment Program (DEP). The user can also manually set
	// this value in the RecoveryOS.
	BootstrapTokenAllowedForAuthentication *string `plist:"BootstrapTokenAllowedForAuthentication,omitempty" json:"BootstrapTokenAllowedForAuthentication,omitempty"`
	// If `true`, the device can accept a Bootstrap Token from the MDM server instead of
	// prompting for user authentication prior to installation. This only applies when
	// `BootstrapTokenAllowedForAuthentication` is `true` in the `SecurityInfo` response.
	BootstrapTokenRequiredForSoftwareUpdate *bool `plist:"BootstrapTokenRequiredForSoftwareUpdate,omitempty" json:"BootstrapTokenRequiredForSoftwareUpdate,omitempty"`
	// If `true`, the device can accept a Bootstrap Token from the MDM server instead of
	// prompting for user authentication prior to enabling kernel extensions. This includes
	// enabling kexts through the `com.apple.syspolicy.kernel-extension-policy` payload or
	// triggering the `RestartDevice` command with `RebuildKernelCache` set to `true`. This
	// only applies when `BootstrapTokenAllowedForAuthentication` is `true` in the
	// `SecurityInfo` response.
	BootstrapTokenRequiredForKernelExtensionApproval *bool `` /* 132-byte string literal not displayed */
	// If `true`, a password is required to enter recovery (see `SetRecoveryLockCommand`).
	// Available in macOS 11.5 and later and only on a Mac with Apple silicon.
	IsRecoveryLockEnabled *bool `plist:"IsRecoveryLockEnabled,omitempty" json:"IsRecoveryLockEnabled,omitempty"`
}

SecurityInfoResponseSecurityInfo: A dictionary that contains security-related information.

type SecurityInfoResponseSecurityInfoFirewallSettings

type SecurityInfoResponseSecurityInfoFirewallSettings struct {
	// If `true`, the firewall is on.
	FirewallEnabled *bool `plist:"FirewallEnabled,omitempty" json:"FirewallEnabled,omitempty"`
	// If `true`, the firewall blocks all incoming connections.
	BlockAllIncoming *bool `plist:"BlockAllIncoming,omitempty" json:"BlockAllIncoming,omitempty"`
	// If true, stealth mode is active for the firewall.
	StealthMode *bool `plist:"StealthMode,omitempty" json:"StealthMode,omitempty"`
	// An array of dictionaries that describes the allowed applications.
	Applications []SecurityInfoResponseSecurityInfoFirewallSettingsApplications `plist:"Applications,omitempty" json:"Applications,omitempty"`
	// If `true`, logging is enabled.
	LoggingEnabled *bool `plist:"LoggingEnabled,omitempty" json:"LoggingEnabled,omitempty"`
	// The type of logging emitted by the firewall.
	LoggingOption *string `plist:"LoggingOption,omitempty" json:"LoggingOption,omitempty"`
}

SecurityInfoResponseSecurityInfoFirewallSettings: A dictionary that contains the firewall settings. This value is available in macOS 10.12 and later.

type SecurityInfoResponseSecurityInfoFirewallSettingsApplications

type SecurityInfoResponseSecurityInfoFirewallSettingsApplications struct {
	// If `true`, the app is an allowed app.
	Allowed *bool `plist:"Allowed,omitempty" json:"Allowed,omitempty"`
	// The app's bundle identifier.
	BundleID *string `plist:"BundleID,omitempty" json:"BundleID,omitempty"`
	// The app's display name if it's determinable from the `BundleID`.
	Name *string `plist:"Name,omitempty" json:"Name,omitempty"`
}

SecurityInfoResponseSecurityInfoFirewallSettingsApplications: A dictionary that describes the allowed apps.

type SecurityInfoResponseSecurityInfoFirmwarePasswordStatus

type SecurityInfoResponseSecurityInfoFirmwarePasswordStatus struct {
	// If `true`, the device has an EFI firmware password.
	PasswordExists *bool `plist:"PasswordExists,omitempty" json:"PasswordExists,omitempty"`
	// If `true`, a firmware password change is pending. A device restart is necessary for this
	// change to take effect. Until then, additional attempts to change the password fail.
	ChangePending *bool `plist:"ChangePending,omitempty" json:"ChangePending,omitempty"`
	// If `true`, enable ROMs.
	AllowOroms *bool `plist:"AllowOroms,omitempty" json:"AllowOroms,omitempty"`
}

SecurityInfoResponseSecurityInfoFirmwarePasswordStatus: A dictionary that contains the status of the EFI firmware password. This value is available in macOS 10.13 and later.

type SecurityInfoResponseSecurityInfoManagementStatus

type SecurityInfoResponseSecurityInfoManagementStatus struct {
	// If `true`, the device enrolled in MDM through the Device Enrollment Program (DEP). This
	// value is available in macOS 10.13.2 and later.
	EnrolledViaDEP *bool `plist:"EnrolledViaDEP,omitempty" json:"EnrolledViaDEP,omitempty"`
	// If `true`, the enrollment was user-approved. If `false`, the device may reject certain
	// security-sensitive payloads or commands. This value is available in macOS 10.13.2 and
	// later.
	UserApprovedEnrollment *bool `plist:"UserApprovedEnrollment,omitempty" json:"UserApprovedEnrollment,omitempty"`
	// If `true`, the device is user-enrolled. This value is available in iOS 13 and later, and
	// macOS 10.15 and later.
	IsUserEnrollment *bool `plist:"IsUserEnrollment,omitempty" json:"IsUserEnrollment,omitempty"`
	// If `true`, the type of enrollment allows the MDM to manage Activation Lock for this
	// device. This value is available in macOS 10.15 and later.
	IsActivationLockManageable *bool `plist:"IsActivationLockManageable,omitempty" json:"IsActivationLockManageable,omitempty"`
}

SecurityInfoResponseSecurityInfoManagementStatus: A dictionary that contains the status of the device's MDM enrollment.

type SecurityInfoResponseSecurityInfoSecureBoot

type SecurityInfoResponseSecurityInfoSecureBoot struct {
	// The security level for the bootable operating system versions.
	SecureBootLevel *string `plist:"SecureBootLevel,omitempty" json:"SecureBootLevel,omitempty"`
	// The device's external boot level, which indicates whether it allows booting from an
	// external device, disallows it, or doesn't support it.
	ExternalBootLevel *string `plist:"ExternalBootLevel,omitempty" json:"ExternalBootLevel,omitempty"`
	// Reports which security features the user disables in `recoveryOS`. This property is only
	// present for a Mac with Apple silicon when `SecureBootLevel` is `medium`.
	ReducedSecurity []string `plist:"ReducedSecurity,omitempty" json:"ReducedSecurity,omitempty"`
}

SecurityInfoResponseSecurityInfoSecureBoot: A dictionary that contains the device's Secure Boot settings. This value is available in macOS 10.15 and later.

type SetAutoAdminPassword

type SetAutoAdminPassword struct {
	// The unique identifier of the local administrator account. If this value doesn't match
	// the GUID of an administrator account that MDM created during Device Enrollment Program
	// (DEP) enrollment, the command returns an error.
	GUID string `plist:"GUID" json:"GUID"`
	// The precreated salted SHA-512 PBKDF2 password hash for the account.
	PasswordHash []byte `plist:"passwordHash,omitempty" json:"passwordHash,omitempty"`
}

SetAutoAdminPassword: Update the local administrator account password.

SetAutoAdminPassword corresponds to mdm/commands/set.auto.admin.password.yaml (Set Auto Admin Password Command).

func (*SetAutoAdminPassword) RequestTypeName

func (*SetAutoAdminPassword) RequestTypeName() string

RequestTypeName returns "SetAutoAdminPassword".

func (*SetAutoAdminPassword) SchemaPath

func (*SetAutoAdminPassword) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SetAutoAdminPassword) Validate

func (x *SetAutoAdminPassword) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SetAutoAdminPasswordResponse

type SetAutoAdminPasswordResponse struct {
}

SetAutoAdminPasswordResponse: Response to SetAutoAdminPassword.

SetAutoAdminPasswordResponse corresponds to mdm/commands/set.auto.admin.password.yaml (Set Auto Admin Password Command).

func (*SetAutoAdminPasswordResponse) ResponseRequestTypeName

func (*SetAutoAdminPasswordResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "SetAutoAdminPassword".

func (*SetAutoAdminPasswordResponse) SchemaPath

func (*SetAutoAdminPasswordResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SetAutoAdminPasswordResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SetFirmwarePassword

type SetFirmwarePassword struct {
	// The current password, which you must set if the device has a firmware password.
	CurrentPassword *string `plist:"CurrentPassword,omitempty" json:"CurrentPassword,omitempty"`
	// The new firmware password. Set to an empty string to clear the password. The characters
	// in this value must consist of low-ASCII, printable characters (`0x20` through `0x7E`) to
	// ensure that all characters are enterable on the EFI login screen.
	NewPassword string `plist:"NewPassword" json:"NewPassword"`
	// If `true`, enable ROMs.
	AllowOroms *bool `plist:"AllowOroms,omitempty" json:"AllowOroms,omitempty"`
}

SetFirmwarePassword: Change or clear the firmware password on a device.

SetFirmwarePassword corresponds to mdm/commands/passcode.firmware.set.yaml (Set Firmware Password Command).

func (*SetFirmwarePassword) RequestTypeName

func (*SetFirmwarePassword) RequestTypeName() string

RequestTypeName returns "SetFirmwarePassword".

func (*SetFirmwarePassword) SchemaPath

func (*SetFirmwarePassword) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SetFirmwarePassword) Validate

func (x *SetFirmwarePassword) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SetFirmwarePasswordResponse

type SetFirmwarePasswordResponse struct {
	// A dictionary containing the results of the command.
	SetFirmwarePassword SetFirmwarePasswordResponseSetFirmwarePassword `plist:"SetFirmwarePassword,omitempty" json:"SetFirmwarePassword,omitempty"`
}

SetFirmwarePasswordResponse: Response to SetFirmwarePassword.

SetFirmwarePasswordResponse corresponds to mdm/commands/passcode.firmware.set.yaml (Set Firmware Password Command).

func (*SetFirmwarePasswordResponse) ResponseRequestTypeName

func (*SetFirmwarePasswordResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "SetFirmwarePassword".

func (*SetFirmwarePasswordResponse) SchemaPath

func (*SetFirmwarePasswordResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SetFirmwarePasswordResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SetFirmwarePasswordResponseSetFirmwarePassword

type SetFirmwarePasswordResponseSetFirmwarePassword struct {
	// If `true`, the password change succeeded.
	PasswordChanged bool `plist:"PasswordChanged" json:"PasswordChanged"`
}

SetFirmwarePasswordResponseSetFirmwarePassword: A dictionary containing the results of the command.

type SetRecoveryLock

type SetRecoveryLock struct {
	// If the device has a Recovery Lock password set, the system requires the current
	// password.
	CurrentPassword *string `plist:"CurrentPassword,omitempty" json:"CurrentPassword,omitempty"`
	// The new password for Recovery Lock. Set as an empty string to clear the Recovery Lock
	// password.
	NewPassword string `plist:"NewPassword" json:"NewPassword"`
}

SetRecoveryLock: Set or clear the Recovery Lock password.

SetRecoveryLock corresponds to mdm/commands/passcode.recovery.set.yaml (Set Recovery Lock Command).

func (*SetRecoveryLock) RequestTypeName

func (*SetRecoveryLock) RequestTypeName() string

RequestTypeName returns "SetRecoveryLock".

func (*SetRecoveryLock) SchemaPath

func (*SetRecoveryLock) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SetRecoveryLock) Validate

func (x *SetRecoveryLock) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SetRecoveryLockResponse

type SetRecoveryLockResponse struct {
}

SetRecoveryLockResponse: Response to SetRecoveryLock.

SetRecoveryLockResponse corresponds to mdm/commands/passcode.recovery.set.yaml (Set Recovery Lock Command).

func (*SetRecoveryLockResponse) ResponseRequestTypeName

func (*SetRecoveryLockResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "SetRecoveryLock".

func (*SetRecoveryLockResponse) SchemaPath

func (*SetRecoveryLockResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SetRecoveryLockResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type Settings

type Settings struct {
	// An array of dictionaries that contains the settings.
	Settings []any `plist:"Settings,omitempty" json:"Settings,omitempty"`
}

Settings: Configure settings on a device.

Settings corresponds to mdm/commands/settings.yaml (Settings Command).

func (*Settings) RequestTypeName

func (*Settings) RequestTypeName() string

RequestTypeName returns "Settings".

func (*Settings) SchemaPath

func (*Settings) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*Settings) Validate

func (x *Settings) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SettingsResponse

type SettingsResponse struct {
	// A dictionary that describes the results of configuring settings.
	Settings *SettingsResponseSettings `plist:"Settings,omitempty" json:"Settings,omitempty"`
}

SettingsResponse: Response to Settings.

SettingsResponse corresponds to mdm/commands/settings.yaml (Settings Command).

func (*SettingsResponse) ResponseRequestTypeName

func (*SettingsResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "Settings".

func (*SettingsResponse) SchemaPath

func (*SettingsResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*SettingsResponse) Validate

func (x *SettingsResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type SettingsResponseSettings

type SettingsResponseSettings struct {
	// The status of the setting, which is one of the following values:
	Status string `plist:"Status" json:"Status"`
	// An array of dictionaries that describes any errors that occurred.
	ErrorChain []SettingsResponseSettingsErrorChain `plist:"ErrorChain,omitempty" json:"ErrorChain,omitempty"`
	// The app identifier to which this error applies.
	Identifier *string `plist:"Identifier,omitempty" json:"Identifier,omitempty"`
}

SettingsResponseSettings: A dictionary that describes the results of configuring settings.

type SettingsResponseSettingsErrorChain

type SettingsResponseSettingsErrorChain struct {
	// A dictionary that contains additional details about the error.
	ANY any `plist:"ANY,omitempty" json:"ANY,omitempty"`
}

SettingsResponseSettingsErrorChain: A dictionary that describes an error chain item.

type SettingsSettingsAccessibilitySettings

type SettingsSettingsAccessibilitySettings struct {
	// Sets various accessibility settings. The system allows only keys with explicitly
	// provided values.
	Item string `plist:"Item" json:"Item"`
	// If `true`, the system enables bold text.
	BoldTextEnabled *bool `plist:"BoldTextEnabled,omitempty" json:"BoldTextEnabled,omitempty"`
	// If `true`, the system enables increase contrast.
	IncreaseContrastEnabled *bool `plist:"IncreaseContrastEnabled,omitempty" json:"IncreaseContrastEnabled,omitempty"`
	// If `true`, the system enables reduced motion.
	ReduceMotionEnabled *bool `plist:"ReduceMotionEnabled,omitempty" json:"ReduceMotionEnabled,omitempty"`
	// If `true`, the system enables reduced transparency.
	ReduceTransparencyEnabled *bool `plist:"ReduceTransparencyEnabled,omitempty" json:"ReduceTransparencyEnabled,omitempty"`
	// The accessibility text size apps that support dynamic text use. `0` is the smallest
	// value, and `11` is the largest available.
	TextSize *int64 `plist:"TextSize,omitempty" json:"TextSize,omitempty"`
	// If `true`, the system enables touch accommodations.
	TouchAccommodationsEnabled *bool `plist:"TouchAccommodationsEnabled,omitempty" json:"TouchAccommodationsEnabled,omitempty"`
	// If `true`, the system enables voiceover.
	VoiceOverEnabled *bool `plist:"VoiceOverEnabled,omitempty" json:"VoiceOverEnabled,omitempty"`
	// If `true`, the system enables zoom.
	ZoomEnabled *bool `plist:"ZoomEnabled,omitempty" json:"ZoomEnabled,omitempty"`
	// If `true`, the system enables grayscale display.
	GrayscaleEnabled *bool `plist:"GrayscaleEnabled,omitempty" json:"GrayscaleEnabled,omitempty"`
}

SettingsSettingsAccessibilitySettings: A dictionary that contains accessibility settings. Available in iOS 16 and later.

type SettingsSettingsAppAnalytics

type SettingsSettingsAppAnalytics struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// If `true`, enable sharing app analytics with app developers. If `false`, disable sharing
	// app analytics.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsAppAnalytics: A dictionary that contains settings for sharing app analytics. This setting is available only for Shared iPad in iOS 9.3.2 and later.

type SettingsSettingsApplicationAttributes

type SettingsSettingsApplicationAttributes struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The bundle identifier of the app.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// A dictionary that contains the attributes to apply to the app. Omit this setting to
	// remove existing attributes. This setting is available in iOS 7 and later, and tvOS 10.2
	// and later.
	Attributes *SettingsSettingsApplicationAttributesAttributes `plist:"Attributes,omitempty" json:"Attributes,omitempty"`
}

SettingsSettingsApplicationAttributes: A dictionary that contains the attributes to apply to the app. Omit this setting to remove existing attributes. This setting supports user enrollment, is available in iOS 7 and later, and tvOS 10.2 and later. This setting fails for apps that Declarative Device Management manages.

type SettingsSettingsApplicationAttributesAttributes

type SettingsSettingsApplicationAttributesAttributes struct {
	// A per-app VPN unique identifier for this app. Available in iOS 7 and later.
	VPNUUID *string `plist:"VPNUUID,omitempty" json:"VPNUUID,omitempty"`
	// The content filter UUID for this app. Available in iOS 16 and later.
	ContentFilterUUID *string `plist:"ContentFilterUUID,omitempty" json:"ContentFilterUUID,omitempty"`
	// The DNS proxy UUID for this app. Available in iOS 16 and later.
	DNSProxyUUID *string `plist:"DNSProxyUUID,omitempty" json:"DNSProxyUUID,omitempty"`
	// The relay UUID for this app. Available in iOS 17 and later.
	RelayUUID *string `plist:"RelayUUID,omitempty" json:"RelayUUID,omitempty"`
	// An array that contains the associated domains to add to this app. Available in iOS 13
	// and later.
	AssociatedDomains []string `plist:"AssociatedDomains,omitempty" json:"AssociatedDomains,omitempty"`
	// If `true`, perform claimed site association verification directly at the domain, instead
	// of on Apple's servers. Only set this to `true` for domains that can't access the
	// internet. Available in iOS 14 and later.
	AssociatedDomainsEnableDirectDownloads *bool `plist:"AssociatedDomainsEnableDirectDownloads,omitempty" json:"AssociatedDomainsEnableDirectDownloads,omitempty"`
	// If `false`, this app isn't removable while it's managed. Available in iOS 14 and later,
	// and tvOS 14 and later.
	Removable *bool `plist:"Removable,omitempty" json:"Removable,omitempty"`
	// If true, the system require Tap to Pay on iPhone users to use Face ID or a passcode to
	// unlock their device after every transaction that requires a customer's card PIN. If
	// `false`, the user can configure this setting on their device.
	TapToPayScreenLock *bool `plist:"TapToPayScreenLock,omitempty" json:"TapToPayScreenLock,omitempty"`
	// The data network name (DNN) or app category. For DNN, the value is `DNN:name`, where
	// `name` is the carrier-provided DNN name. For app category, the value is
	// `AppCategory:category`, where `category` is a carrier-provided string like
	// "Enterprise1"`.`
	CellularSliceUUID *string `plist:"CellularSliceUUID,omitempty" json:"CellularSliceUUID,omitempty"`
	// If `false`, the system prevents the user from hiding the app. It doesn't affect the
	// user's ability to leave it in the App Library, while removing it from the Home Screen.
	Hideable *bool `plist:"Hideable,omitempty" json:"Hideable,omitempty"`
	// If `false`, the system prevents the user from locking the app. This also prevents the
	// user from hiding the app.
	Lockable *bool `plist:"Lockable,omitempty" json:"Lockable,omitempty"`
}

SettingsSettingsApplicationAttributesAttributes: A dictionary that contains the attributes to apply to the app. Omit this setting to remove existing attributes. This setting is available in iOS 7 and later, and tvOS 10.2 and later.

type SettingsSettingsApplicationConfiguration

type SettingsSettingsApplicationConfiguration struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The bundle identifier of the managed app.
	Identifier string `plist:"Identifier" json:"Identifier"`
	// A dictionary that contains the configurations to apply to the app. Omit this setting to
	// remove existing configurations.
	Configuration map[string]any `plist:"Configuration,omitempty" json:"Configuration,omitempty"`
}

SettingsSettingsApplicationConfiguration: A dictionary that contains the configurations to apply to the app. Omit this setting to remove existing configurations. This setting requires the App Management access right, supports user enrollment, and is available in iOS 7 and later, macOS 10.15 and later, and tvOS 10.2 and later. This setting fails for apps that Declarative Device Management manages.

type SettingsSettingsBluetooth

type SettingsSettingsBluetooth struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// If `true`, enable the Bluetooth setting. If `false`, disable the Bluetooth setting.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsBluetooth: A dictionary that contains Bluetooth settings. This setting requires the Network Information access right, doesn't support user enrollment, and is available only on supervised devices. Available in iOS 11.3 and later, and macOS 10.13.4 and later.

type SettingsSettingsDataRoaming

type SettingsSettingsDataRoaming struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// If `true`, enable data roaming, which also enables voice roaming. If `false`, disable
	// data roaming.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsDataRoaming: A dictionary that contains data roaming settings. This setting requires the Network Information access right, and doesn't support user enrollment. Available in iOS 5 and later.

type SettingsSettingsDefaultApplications

type SettingsSettingsDefaultApplications struct {
	// The bundle identifier of the app the system sets as the default web browser. This app
	// must be an eligible web browser for the region of the device.
	WebBrowser *string `plist:"WebBrowser,omitempty" json:"WebBrowser,omitempty"`
	// The bundle identifier of the app that the system sets as the default calling app. This
	// app must be an eligible calling app.
	Calling *string `plist:"Calling,omitempty" json:"Calling,omitempty"`
	// The bundle identifier of the app that the system sets as the default messaging app. This
	// app must be an eligible messaging app.
	Messaging *string `plist:"Messaging,omitempty" json:"Messaging,omitempty"`
}

SettingsSettingsDefaultApplications: A dictionary that contains default application bundle identifiers for each default application type that can be set.

type SettingsSettingsDeviceName

type SettingsSettingsDeviceName struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The device's name.
	DeviceName string `plist:"DeviceName" json:"DeviceName"`
}

SettingsSettingsDeviceName: A dictionary that contains device name settings. This setting doesn't support user enrollment, and is available only on supervised devices. Available in iOS 5 and later, macOS 10.10 and later, and visionOS 2 and later.

type SettingsSettingsDiagnosticSubmission

type SettingsSettingsDiagnosticSubmission struct {
	// The string that defines this setting type.
	Item string `plist:"Item" json:"Item"`
	// If `true`, enables diagnostic submission. If `false`, disables diagnostic submission.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsDiagnosticSubmission: A dictionary that contains diagnostic submission settings. This setting is available only for Shared iPad in iOS 9.3 and later.

type SettingsSettingsHostName

type SettingsSettingsHostName struct {
	// The string that defines this setting type.
	Item string `plist:"Item" json:"Item"`
	// The hostname for the device.
	HostName string `plist:"HostName" json:"HostName"`
}

SettingsSettingsHostName: A dictionary that contains hostname settings. This setting doesn't support user enrollment, and is available in macOS 10.11 and later.

type SettingsSettingsMDMOptions

type SettingsSettingsMDMOptions struct {
	// The string that defines this setting type.
	Item string `plist:"Item" json:"Item"`
	// A dictionary of MDM options.
	MDMOptions SettingsSettingsMDMOptionsMDMOptions `plist:"MDMOptions,omitempty" json:"MDMOptions,omitempty"`
}

SettingsSettingsMDMOptions: A dictionary that contains settings related to the MDM protocol. This setting doesn't support user enrollment. Available in iOS 7 and later, macOS 10.15 and later, and visionOS 2 and later.

type SettingsSettingsMDMOptionsMDMOptions

type SettingsSettingsMDMOptionsMDMOptions struct {
	// If `true`, a supervised device registers itself with Activation Lock when the user
	// enables Find My. This setting is available for supervised devices in iOS 7 and later,
	// and macOS 10.15 and later.
	ActivationLockAllowedWhileSupervised *bool `plist:"ActivationLockAllowedWhileSupervised,omitempty" json:"ActivationLockAllowedWhileSupervised,omitempty"`
	// If `true`, the server supports the Bootstrap Token commands.
	BootstrapTokenAllowed *bool `plist:"BootstrapTokenAllowed,omitempty" json:"BootstrapTokenAllowed,omitempty"`
	// If `true`, warn the user that they need to reboot into RecoveryOS and allow the MDM
	// server to use the Bootstrap Token for authentication for certain sensitive operations;
	// for example, enabling kernel extensions or installing certain types of software updates.
	// Set this value to `false` if your MDM server doesn't need to perform these operations.
	// The value provided here overrides the value specified in MDM, and only applies when
	// `BootstrapTokenAllowedForAuthentication` is `true` in the `SecurityInfo` response. This
	// value is available for a Mac with Apple silicon in macOS 11 and later.
	PromptUserToAllowBootstrapTokenForAuthentication *bool `` /* 132-byte string literal not displayed */
	// If `true`, the device automatically reboots while locked after several days of
	// inactivity. This is set to `false` by default when a supervised device enrolls.
	IdleRebootAllowed *bool `plist:"IdleRebootAllowed,omitempty" json:"IdleRebootAllowed,omitempty"`
}

SettingsSettingsMDMOptionsMDMOptions: A dictionary of MDM options.

type SettingsSettingsMaximumResidentUsers

type SettingsSettingsMaximumResidentUsers struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The maximum number of users that can use the device. If this value is greater than the
	// value for the maximum possible number of users that the device supports, the MDM server
	// uses that value instead.
	MaximumResidentUsers int64 `plist:"MaximumResidentUsers" json:"MaximumResidentUsers"`
}

SettingsSettingsMaximumResidentUsers: A dictionary that contains settings for maximum resident users. Apple deprecated this setting in iOS 13.4. Use 'SharedDeviceConfiguration` instead. This setting is available only for Shared iPad.

type SettingsSettingsOrganizationInfo

type SettingsSettingsOrganizationInfo struct {
	// The string that defines this setting type.
	Item string `plist:"Item" json:"Item"`
	// A dictionary that contains information about the organization operating the MDM server.
	// Omit this setting to remove existing information.
	OrganizationInfo *SettingsSettingsOrganizationInfoOrganizationInfo `plist:"OrganizationInfo,omitempty" json:"OrganizationInfo,omitempty"`
}

SettingsSettingsOrganizationInfo: A dictionary that contains settings about the organization operating the MDM server. This setting supports user enrollment. Available in iOS 5 and later.

type SettingsSettingsOrganizationInfoOrganizationInfo

type SettingsSettingsOrganizationInfoOrganizationInfo struct {
	// A string that describes the organization operating the MDM server for display to the
	// user during certain operations, such as purchasing or installing apps.
	OrganizationName string `plist:"OrganizationName" json:"OrganizationName"`
	// A shorter version of `OrganizationName`, preferably a single word or abbreviation,
	// suitable for display to the user in places where a very short name is necessary.
	OrganizationShortName *string `plist:"OrganizationShortName,omitempty" json:"OrganizationShortName,omitempty"`
	// The organization's address. Use the LF character (`&#10`) to insert line breaks.
	OrganizationAddress *string `plist:"OrganizationAddress,omitempty" json:"OrganizationAddress,omitempty"`
	// The organization's phone number.
	OrganizationPhone *string `plist:"OrganizationPhone,omitempty" json:"OrganizationPhone,omitempty"`
	// The organization's support email address.
	OrganizationEmail *string `plist:"OrganizationEmail,omitempty" json:"OrganizationEmail,omitempty"`
	// A unique identifier for the various services a single organization manages.
	OrganizationMagic *string `plist:"OrganizationMagic,omitempty" json:"OrganizationMagic,omitempty"`
}

SettingsSettingsOrganizationInfoOrganizationInfo: A dictionary that contains information about the organization operating the MDM server. Omit this setting to remove existing information.

type SettingsSettingsPasscodeLockGracePeriod

type SettingsSettingsPasscodeLockGracePeriod struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The number of seconds before a locked screen requires the user to enter the device
	// passcode to unlock it. The minimum value is `0` seconds and the maximum value is `14400`
	// seconds.
	PasscodeLockGracePeriod int64 `plist:"PasscodeLockGracePeriod" json:"PasscodeLockGracePeriod"`
}

SettingsSettingsPasscodeLockGracePeriod: A dictionary that contains password lock grace period settings. This setting is available only for Shared iPad in iOS 9.3.2 and later. This key is deprecated. Use 'PasscodeLockGracePeriod' in SettingsCommand.Command.Settings.SharedDeviceConfiguration.PasscodePolicy instead.

type SettingsSettingsPersonalHotspot

type SettingsSettingsPersonalHotspot struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// If `true`, enable Personal Hotspot. If `false`, disable Personal Hotspot.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsPersonalHotspot: A dictionary that contains Personal Hotspot settings. This setting requires the Network Information access right, and doesn't support user enrollment. Available in iOS 5 and later.

type SettingsSettingsSharedDeviceConfiguration

type SettingsSettingsSharedDeviceConfiguration struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The quota size, in megabytes (MB), for each user on the shared device, or if the quota
	// size is too small, the minimum quota size. Available to Temporary Sessions Only guest
	// users on iOS 17+.
	QuotaSize *int64 `plist:"QuotaSize,omitempty" json:"QuotaSize,omitempty"`
	// The expected number of users. If this value is greater than the value for the maximum
	// possible number of users that the device supports, the MDM server uses that value
	// instead.
	ResidentUsers *int64 `plist:"ResidentUsers,omitempty" json:"ResidentUsers,omitempty"`
	// The timeout, in seconds, for the user session. The user session logs out automatically
	// after the specified period of inactivity. The minimum value is 30 seconds. Setting this
	// value to `0` removes the timeout.
	UserSessionTimeout *int64 `plist:"UserSessionTimeout,omitempty" json:"UserSessionTimeout,omitempty"`
	// The timeout, in seconds, for the temporary session. The temporary session logs out
	// automatically after the specified period of inactivity. The minimum value is 30 seconds.
	// Setting this value to `0` removes the timeout.
	TemporarySessionTimeout *int64 `plist:"TemporarySessionTimeout,omitempty" json:"TemporarySessionTimeout,omitempty"`
	// If `true`, the user only sees the Guest Welcome pane and can only log in as a guest
	// user.
	TemporarySessionOnly *bool `plist:"TemporarySessionOnly,omitempty" json:"TemporarySessionOnly,omitempty"`
	// A list of domains that the Shared iPad login screen displays. The user can pick a domain
	// from the list to complete their Managed Apple Account.
	ManagedAppleIDDefaultDomains []string `plist:"ManagedAppleIDDefaultDomains,omitempty" json:"ManagedAppleIDDefaultDomains,omitempty"`
	// A grace period (in days) for Shared iPad online authentication. The Shared iPad only
	// verifies the user's passcode locally during login for users that already exist on the
	// device. However, the system requires an online authentication (against Apple's identity
	// server) after the number of days specified by this setting.
	OnlineAuthenticationGracePeriod *int64 `plist:"OnlineAuthenticationGracePeriod,omitempty" json:"OnlineAuthenticationGracePeriod,omitempty"`
	// If `true`, the system picks the system language and locale automatically for the new
	// Shared iPad user.
	SkipLanguageAndLocaleSetupForNewUsers *bool `plist:"SkipLanguageAndLocaleSetupForNewUsers,omitempty" json:"SkipLanguageAndLocaleSetupForNewUsers,omitempty"`
	// If enabled, the Shared iPad device enters Setup Assistant after the user triggers a
	// login. The MDM server has a chance to configure the device and user. After
	// configuration, the server needs to send a `User-Configured-Command` command to the user
	// channel to unblock the login. This feature requires the device to have network access
	// during the login process.
	AwaitUserConfiguration *SettingsSettingsSharedDeviceConfigurationAwaitUserConfiguration `plist:"AwaitUserConfiguration,omitempty" json:"AwaitUserConfiguration,omitempty"`
	// A dictionary that contains passcode policies.
	PasscodePolicy *SettingsSettingsSharedDeviceConfigurationPasscodePolicy `plist:"PasscodePolicy,omitempty" json:"PasscodePolicy,omitempty"`
}

SettingsSettingsSharedDeviceConfiguration: A dictionary that contains shared device configuration settings. This setting is available only for Shared iPad in iOS 13.4 and later.

type SettingsSettingsSharedDeviceConfigurationAwaitUserConfiguration

type SettingsSettingsSharedDeviceConfigurationAwaitUserConfiguration struct {
	// If `true`, the device stops at the Setup Assistant pane after user login. The user can't
	// use the device until it receives a `User-Configured-Command` command.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsSharedDeviceConfigurationAwaitUserConfiguration: If enabled, the Shared iPad device enters Setup Assistant after the user triggers a login. The MDM server has a chance to configure the device and user. After configuration, the server needs to send a `User-Configured-Command` command to the user channel to unblock the login. This feature requires the device to have network access during the login process.

type SettingsSettingsSharedDeviceConfigurationPasscodePolicy

type SettingsSettingsSharedDeviceConfigurationPasscodePolicy struct {
	// The number of seconds before a locked screen requires the user to enter the device
	// passcode to unlock it. The minimum value is `0` seconds and the maximum value is `14400`
	// seconds.
	PasscodeLockGracePeriod *int64 `plist:"PasscodeLockGracePeriod,omitempty" json:"PasscodeLockGracePeriod,omitempty"`
	// The number of seconds before a device goes to sleep after being idle. The minimum value
	// for this setting is `120` seconds.
	AutoLockTime *int64 `plist:"AutoLockTime,omitempty" json:"AutoLockTime,omitempty"`
}

SettingsSettingsSharedDeviceConfigurationPasscodePolicy: A dictionary that contains passcode policies.

type SettingsSettingsSoftwareUpdateSettings

type SettingsSettingsSoftwareUpdateSettings struct {
	// A string that represents the type of updates that should appear in the Software Update
	// pane in Settings. Supervised only.
	Item string `plist:"Item" json:"Item"`
	// This value defines how the system presents software updates to the user. When there's
	// more than one available update for the user, the system behaves as follows:
	RecommendationCadence int64 `plist:"RecommendationCadence" json:"RecommendationCadence"`
}

SettingsSettingsSoftwareUpdateSettings: A dictionary that contains software update settings. This setting doesn't support user enrollment. Available in iOS 14.5 and later.

type SettingsSettingsTimeZone

type SettingsSettingsTimeZone struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// The Internet Assigned Numbers Authority (IANA) time zone database name.
	TimeZone string `plist:"TimeZone" json:"TimeZone"`
}

SettingsSettingsTimeZone: A dictionary that contains time zone settings. This setting is available only on supervised devices and doesn't support user enrollment. Available in iOS 14 and later, tvOS 14 and later, and visionOS 2 and later.

type SettingsSettingsVoiceRoaming

type SettingsSettingsVoiceRoaming struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// If `true`, enable voice roaming. If `false`, disable voice roaming, which also disables
	// data roaming. The setting is only available for certain carriers.
	Enabled bool `plist:"Enabled" json:"Enabled"`
}

SettingsSettingsVoiceRoaming: A dictionary that contains voice roaming settings. This setting requires the Network Information access right, and doesn't support user enrollment. Available in iOS 5 and later.

type SettingsSettingsWallpaper

type SettingsSettingsWallpaper struct {
	// A string that identifies this setting.
	Item string `plist:"Item" json:"Item"`
	// A Base64-encoded image in either PNG or JPG format to use for wallpaper.
	Image []byte `plist:"Image,omitempty" json:"Image,omitempty"`
	// A number that indicates where to use the wallpaper, which is one of the following
	// values:
	Where int64 `plist:"Where" json:"Where"`
}

SettingsSettingsWallpaper: A dictionary that contains wallpaper settings. This setting doesn't support user enrollment. Available in iOS 8 and later. Starting in iOS 16 and iPadOS 17, when setting the wallpaper for the first time, both locations update. After that, you can set either location separately.

type ShutDownDevice

type ShutDownDevice struct {
}

ShutDownDevice: Remotely and immediately shut down a device.

ShutDownDevice corresponds to mdm/commands/device.shutdown.yaml (Shut Down Device Command).

func (*ShutDownDevice) RequestTypeName

func (*ShutDownDevice) RequestTypeName() string

RequestTypeName returns "ShutDownDevice".

func (*ShutDownDevice) SchemaPath

func (*ShutDownDevice) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ShutDownDevice) Validate

func (x *ShutDownDevice) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ShutDownDeviceResponse

type ShutDownDeviceResponse struct {
}

ShutDownDeviceResponse: Response to ShutDownDevice.

ShutDownDeviceResponse corresponds to mdm/commands/device.shutdown.yaml (Shut Down Device Command).

func (*ShutDownDeviceResponse) ResponseRequestTypeName

func (*ShutDownDeviceResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ShutDownDevice".

func (*ShutDownDeviceResponse) SchemaPath

func (*ShutDownDeviceResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ShutDownDeviceResponse) Validate

func (x *ShutDownDeviceResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type StopMirroring

type StopMirroring struct {
}

StopMirroring: Stop mirroring the display to another device.

StopMirroring corresponds to mdm/commands/mirroring.stop.yaml (Stop Mirroring Command).

func (*StopMirroring) RequestTypeName

func (*StopMirroring) RequestTypeName() string

RequestTypeName returns "StopMirroring".

func (*StopMirroring) SchemaPath

func (*StopMirroring) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*StopMirroring) Validate

func (x *StopMirroring) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type StopMirroringResponse

type StopMirroringResponse struct {
}

StopMirroringResponse: Response to StopMirroring.

StopMirroringResponse corresponds to mdm/commands/mirroring.stop.yaml (Stop Mirroring Command).

func (*StopMirroringResponse) ResponseRequestTypeName

func (*StopMirroringResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "StopMirroring".

func (*StopMirroringResponse) SchemaPath

func (*StopMirroringResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*StopMirroringResponse) Validate

func (x *StopMirroringResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UnlockUserAccount

type UnlockUserAccount struct {
	// The user name of the local account, which can be any local account on the system, not
	// just a managed user account.
	UserName string `plist:"UserName" json:"UserName"`
}

UnlockUserAccount: Unlock a user account that the system locked because of too many failed password attempts.

UnlockUserAccount corresponds to mdm/commands/user.unlock.yaml (Unlock User Account Command).

func (*UnlockUserAccount) RequestTypeName

func (*UnlockUserAccount) RequestTypeName() string

RequestTypeName returns "UnlockUserAccount".

func (*UnlockUserAccount) SchemaPath

func (*UnlockUserAccount) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*UnlockUserAccount) Validate

func (x *UnlockUserAccount) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UnlockUserAccountResponse

type UnlockUserAccountResponse struct {
}

UnlockUserAccountResponse: Response to UnlockUserAccount.

UnlockUserAccountResponse corresponds to mdm/commands/user.unlock.yaml (Unlock User Account Command).

func (*UnlockUserAccountResponse) ResponseRequestTypeName

func (*UnlockUserAccountResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "UnlockUserAccount".

func (*UnlockUserAccountResponse) SchemaPath

func (*UnlockUserAccountResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*UnlockUserAccountResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UserConfigured

type UserConfigured struct {
}

UserConfigured: Inform the device that it can continue past Setup Assistant and finish login.

UserConfigured corresponds to mdm/commands/user.configured.yaml (User Configured Command).

func (*UserConfigured) RequestTypeName

func (*UserConfigured) RequestTypeName() string

RequestTypeName returns "UserConfigured".

func (*UserConfigured) SchemaPath

func (*UserConfigured) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*UserConfigured) Validate

func (x *UserConfigured) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UserConfiguredResponse

type UserConfiguredResponse struct {
}

UserConfiguredResponse: Response to UserConfigured.

UserConfiguredResponse corresponds to mdm/commands/user.configured.yaml (User Configured Command).

func (*UserConfiguredResponse) ResponseRequestTypeName

func (*UserConfiguredResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "UserConfigured".

func (*UserConfiguredResponse) SchemaPath

func (*UserConfiguredResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*UserConfiguredResponse) Validate

func (x *UserConfiguredResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UserList

type UserList struct {
}

UserList: Get a list of users with active accounts on a device.

UserList corresponds to mdm/commands/user.list.yaml (User List Command).

func (*UserList) RequestTypeName

func (*UserList) RequestTypeName() string

RequestTypeName returns "UserList".

func (*UserList) SchemaPath

func (*UserList) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*UserList) Validate

func (x *UserList) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UserListResponse

type UserListResponse struct {
	// An array of user dictionaries that contains information about the active accounts.
	Users []UserListResponseUsers `plist:"Users,omitempty" json:"Users,omitempty"`
}

UserListResponse: Response to UserList.

UserListResponse corresponds to mdm/commands/user.list.yaml (User List Command).

func (*UserListResponse) ResponseRequestTypeName

func (*UserListResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "UserList".

func (*UserListResponse) SchemaPath

func (*UserListResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*UserListResponse) Validate

func (x *UserListResponse) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type UserListResponseUsers

type UserListResponseUsers struct {
	// The user name for the account. In macOS, this is the short name of the user account.
	// This value is available in iOS 9.3 and later, and macOS 10.13 and later.
	UserName string `plist:"UserName" json:"UserName"`
	// The user's full name. This value is available in macOS 10.13 and later.
	FullName string `plist:"FullName" json:"FullName"`
	// The user's unique identifier. This value is available in macOS 10.13 and later.
	UID int64 `plist:"UID" json:"UID"`
	// The user's `GeneratedUID`. This value is available in macOS 10.13 and later.
	UserGUID string `plist:"UserGUID" json:"UserGUID"`
	// If `true`, the user is currently logged in on the device. This value is available in iOS
	// 9.3 and later, and macOS 10.13 and later.
	IsLoggedIn bool `plist:"IsLoggedIn" json:"IsLoggedIn"`
	// If `true`, the user has data to sync to the cloud. This value is available in iOS 9.3
	// and later.
	HasDataToSync bool `plist:"HasDataToSync" json:"HasDataToSync"`
	// If present, the user's data quota in bytes. This isn't present if the account doesn't
	// enforce a quota. This value is available in iOS 9.3 and later.
	DataQuota int64 `plist:"DataQuota" json:"DataQuota"`
	// The amount of data, in bytes, that the user has used. This value is available in iOS 9.3
	// and later.
	DataUsed int64 `plist:"DataUsed" json:"DataUsed"`
	// If `true`, the account is a mobile account. This value is available in macOS 10.13 and
	// later.
	MobileAccount bool `plist:"MobileAccount" json:"MobileAccount"`
	// If `true`, the user currently has a secure token set. This value is available in macOS
	// 11 and later.
	HasSecureToken bool `plist:"HasSecureToken" json:"HasSecureToken"`
}

UserListResponseUsers: A dictionary that contains information about an active account on a device.

type ValidateApplications

type ValidateApplications struct {
	// The bundle identifiers of the enterprise apps to include for validation of associated
	// provisioning profiles, if you choose to provide them. Otherwise, validation occurs for
	// the provisioning profiles for the installed managed apps.
	Identifiers []string `plist:"Identifiers,omitempty" json:"Identifiers,omitempty"`
}

ValidateApplications: Force validation of developer and universal provisioning profiles for enterprise apps.

ValidateApplications corresponds to mdm/commands/application.validate.yaml (Validate Applications Command).

func (*ValidateApplications) RequestTypeName

func (*ValidateApplications) RequestTypeName() string

RequestTypeName returns "ValidateApplications".

func (*ValidateApplications) SchemaPath

func (*ValidateApplications) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ValidateApplications) Validate

func (x *ValidateApplications) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type ValidateApplicationsResponse

type ValidateApplicationsResponse struct {
}

ValidateApplicationsResponse: Response to ValidateApplications.

ValidateApplicationsResponse corresponds to mdm/commands/application.validate.yaml (Validate Applications Command).

func (*ValidateApplicationsResponse) ResponseRequestTypeName

func (*ValidateApplicationsResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "ValidateApplications".

func (*ValidateApplicationsResponse) SchemaPath

func (*ValidateApplicationsResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*ValidateApplicationsResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type VerifyFirmwarePassword

type VerifyFirmwarePassword struct {
	// The password to verify.
	Password string `plist:"Password" json:"Password"`
}

VerifyFirmwarePassword: Verify the firmware password on a device.

VerifyFirmwarePassword corresponds to mdm/commands/passcode.firmware.verify.yaml (Verify Firmware Password Command).

func (*VerifyFirmwarePassword) RequestTypeName

func (*VerifyFirmwarePassword) RequestTypeName() string

RequestTypeName returns "VerifyFirmwarePassword".

func (*VerifyFirmwarePassword) SchemaPath

func (*VerifyFirmwarePassword) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*VerifyFirmwarePassword) Validate

func (x *VerifyFirmwarePassword) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type VerifyFirmwarePasswordResponse

type VerifyFirmwarePasswordResponse struct {
	// A dictionary containing the results of the command.
	VerifyFirmwarePassword VerifyFirmwarePasswordResponseVerifyFirmwarePassword `plist:"VerifyFirmwarePassword,omitempty" json:"VerifyFirmwarePassword,omitempty"`
}

VerifyFirmwarePasswordResponse: Response to VerifyFirmwarePassword.

VerifyFirmwarePasswordResponse corresponds to mdm/commands/passcode.firmware.verify.yaml (Verify Firmware Password Command).

func (*VerifyFirmwarePasswordResponse) ResponseRequestTypeName

func (*VerifyFirmwarePasswordResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "VerifyFirmwarePassword".

func (*VerifyFirmwarePasswordResponse) SchemaPath

func (*VerifyFirmwarePasswordResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*VerifyFirmwarePasswordResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type VerifyFirmwarePasswordResponseVerifyFirmwarePassword

type VerifyFirmwarePasswordResponseVerifyFirmwarePassword struct {
	// If 'true', the provided password matched the firmware password set for the device.
	PasswordVerified bool `plist:"PasswordVerified" json:"PasswordVerified"`
}

VerifyFirmwarePasswordResponseVerifyFirmwarePassword: A dictionary containing the results of the command.

type VerifyRecoveryLock

type VerifyRecoveryLock struct {
	// The password to verify.
	Password string `plist:"Password" json:"Password"`
}

VerifyRecoveryLock: Verify the device's Recovery Lock password.

VerifyRecoveryLock corresponds to mdm/commands/passcode.recovery.verify.yaml (Verify Recovery Lock Command).

func (*VerifyRecoveryLock) RequestTypeName

func (*VerifyRecoveryLock) RequestTypeName() string

RequestTypeName returns "VerifyRecoveryLock".

func (*VerifyRecoveryLock) SchemaPath

func (*VerifyRecoveryLock) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*VerifyRecoveryLock) Validate

func (x *VerifyRecoveryLock) Validate(t support.Target) error

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

type VerifyRecoveryLockResponse

type VerifyRecoveryLockResponse struct {
	// If `true`, the device verified the password.
	PasswordVerified bool `plist:"PasswordVerified" json:"PasswordVerified"`
}

VerifyRecoveryLockResponse: Response to VerifyRecoveryLock.

VerifyRecoveryLockResponse corresponds to mdm/commands/passcode.recovery.verify.yaml (Verify Recovery Lock Command).

func (*VerifyRecoveryLockResponse) ResponseRequestTypeName

func (*VerifyRecoveryLockResponse) ResponseRequestTypeName() string

ResponseRequestTypeName returns "VerifyRecoveryLock".

func (*VerifyRecoveryLockResponse) SchemaPath

func (*VerifyRecoveryLockResponse) SchemaPath() string

SchemaPath returns the Apple schema file this type was generated from.

func (*VerifyRecoveryLockResponse) Validate

Validate checks x against the schema. With a non-zero target it also checks that every present key is supported on that OS version and enrollment context.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL