Contents

AvailableOSUpdatesResponse.AvailableOSUpdatesItem

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

Declaration

object AvailableOSUpdatesResponse.AvailableOSUpdatesItem

Properties

NameTypeDescription
AllowsInstallLaterboolean

If true, download the software update and install it later.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

AppIdentifiersToClose Required[string]

An array that contains app identifiers of apps to close so you can install the update.

Available: macOS 10.11+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

Build Requiredstring

The build number of the update.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

DeferredUntildate

If present, the date when you want the update to install.

Available: macOS 10.12.4+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

DownloadSize Requiredinteger

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.

Available: iOS 9+ | iPadOS 9+ | macOS 10.12+ | tvOS 12+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

HumanReadableName Requiredstring

The human-readable name of the update in the current user’s current locale.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

HumanReadableNameLocale Requiredstring

The locale, in IOS639-1 Alpha-2 code format, of the HumanReadableName value.

Available: macOS 10.11+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

InstallSize Requiredinteger

The storage size necessary to install the update.

Available: iOS 9+ | iPadOS 9+ | tvOS 12+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

IsConfigDataUpdateboolean

If true, this is an update to a configuration file.

Available: macOS 10.11+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

IsCriticalboolean

If true, this is a critical update.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

IsFirmwareUpdateboolean

If true, this is an update to firmware.

Available: macOS 10.11+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

IsMajorOSUpdateboolean

If true, this is a major update; for example, 10.15.x to 11.

Available: macOS 10.11.4+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

IsSecurityResponse Requiredboolean

If true, this update is a Background Security Improvement.

Available: iOS 16.2+ | iPadOS 16.2+ | macOS 13.1+ | tvOS 16.2+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

MetadataURL Requiredstring

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.

Available: macOS 10.11+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

ProductKey Requiredstring

The product key that represents the update.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

ProductName Requiredstring

The product name; for example, iOS.

Available: iOS 9+ | iPadOS 9+ | tvOS 12+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

RequiresBootstrapTokenboolean

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 SecurityInfoResponse.SecurityInfo response. This value is available for a Mac with Apple silicon in macOS 11 and later.

Available: macOS 11+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

RestartRequiredboolean

If true, the device restarts after installing the update.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

SupplementalBuildVersionstring

The build version for the Background Security Improvement update, for example, 13A999, which is the same as Build.

Available: iOS 16.2+ | iPadOS 16.2+ | macOS 13.1+ | tvOS 16.2+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

SupplementalOSVersionExtrastring

The Background Security Improvement OS version suffix, for example, (a). Only present if this is a Background Security Improvement update.

Available: iOS 16.2+ | iPadOS 16.2+ | macOS 13.1+ | tvOS 16.2+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

Version Requiredstring

The version of the update.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

See Also

Objects