CalvinBackup/apple_device-management
1
0
Fork 0
mirror of https://github.com/apple/device-management.git synced 2026-03-30 16:00:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Release_iOS-17-4_macOS-14-4

Browse Source
This commit is contained in:
Cyrus Daboo
2024-03-05 17:52:42 -05:00
parent 1cb86e0e35
commit 39e2a82234
298 changed files with 4811 additions and 1280 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE.txt
View File

@@ -1,4 +1,4 @@
Copyright © 2022-2023 Apple Inc.
Copyright © 2022-2024 Apple Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the

34
README.md
View File

@@ -6,12 +6,34 @@ This repository contains Apple's Device Management Client schema data for the MD
This release corresponds to the following OS versions
| OS | Version |
|---------|---------|
| iOS | 17.2 |
| macOS | 14.2 |
| tvOS | 17.2 |
| watchOS | 10.2 |
| OS | Version |
|----------|---------|
| iOS | 17.4 |
| macOS | 14.4 |
| tvOS | 17.4 |
| visionOS | 1.1 |
| watchOS | 10.4 |
## Important Release Notes
### visionOS support
The 17.4/14.4 release adds a `visionOS` value to the `supportedOS` key to indicate support for visionOS devices.
### Declarative device management supervision state
The 17.4/14.4 release includes a major change to the `allowed-enrollments` key in declarative device management schema items. A new `supervised` value has been added. So now:
* `supervised` is used to indicate support for a supervised device enrollment
* `device` is used to indicate support for an unsupervised device enrollment.
On macOS, device enrollments are always supervised, so the `device` value has been replaced by `supervised` in all `allowed-enrollments`.
On other platforms, `supervision` has been added or `device` has been removed, as appropriate for actual support.
### Declarative device management combinetype values
The 17.4/14.4 release has renamed the `enum-lowest` and `enum-highest` combinetype values to `enum-first` and `enum-last` respectively.
## What's Available

2
declarative/declarations/activations/simple.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credential.acme.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credential.certificate.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credential.identity.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credential.scep.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credential.userpassword.yaml
View File

@@ -10,6 +10,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credentials/acme.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credentials/identity.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credentials/scep.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/credentials/usernameandpassword.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/data.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/assets/useridentity.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

12
declarative/declarations/configurations/account.caldav.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,15 +18,24 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: A CalDAV configuration defines a CalDAV calendar and reminders account
for a user.
payloadkeys:

12
declarative/declarations/configurations/account.carddav.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,15 +18,24 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: A CardDAV configuration defines a CardDAV contacts account for a user.
payloadkeys:
- key: VisibleName

22
declarative/declarations/configurations/account.exchange.yaml
View File

@@ -7,6 +7,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,15 +19,24 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: This payload configures an Exchange ActiveSync account on an iOS device.
payloadkeys:
- key: VisibleName
@@ -72,6 +82,8 @@ payloadkeys:
supportedOS:
iOS:
introduced: n/a
visionOS:
introduced: n/a
type: <integer>
presence: optional
content: The port number of the EWS server. The system uses this only when this
@@ -81,6 +93,8 @@ payloadkeys:
supportedOS:
iOS:
introduced: n/a
visionOS:
introduced: n/a
type: <string>
presence: optional
content: The path of the EWS server. The system uses this only when this declaration
@@ -90,6 +104,8 @@ payloadkeys:
supportedOS:
iOS:
introduced: n/a
visionOS:
introduced: n/a
type: <string>
presence: optional
content: The external hostname of the EWS server (or IP address). This is a required
@@ -100,6 +116,8 @@ payloadkeys:
supportedOS:
iOS:
introduced: n/a
visionOS:
introduced: n/a
type: <integer>
presence: optional
content: The external port number of the EWS server. The system uses this only when
@@ -109,6 +127,8 @@ payloadkeys:
supportedOS:
iOS:
introduced: n/a
visionOS:
introduced: n/a
type: <string>
presence: optional
content: The external path of the EWS server. The system uses this only when this

12
declarative/declarations/configurations/account.google.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,15 +18,24 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: A Google configuration defines a Google account for a user. The user will
be prompted to enter their credentials shortly after the configuration successfully
installs.

12
declarative/declarations/configurations/account.ldap.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,15 +18,24 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: An LDAP configuration defines an LDAP directory account for a user.
payloadkeys:
- key: VisibleName

12
declarative/declarations/configurations/account.mail.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,15 +18,24 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: An email configuration defines an email account for a user.
payloadkeys:
- key: VisibleName

12
declarative/declarations/configurations/account.subscribed-calendar.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,15 +18,24 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
content: A subscribed calendar configuration defines a subscribed calendar for a
user.
payloadkeys:

63
declarative/declarations/configurations/app.managed.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.2'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -17,33 +18,36 @@ payload:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: multiple
beta: true
payloadkeys:
- key: AppStoreID
title: App Store ID
type: <string>
presence: optional
content: Specifies the App Store ID of the managed app. One and only one of `AppStoreID`,
`BundleID`, or `ManifestURL` must be present.
content: The App Store ID of the managed app. One and only one of 'AppStoreID',
'BundleID', or 'ManifestURL' must be present.
- key: BundleID
title: Bundle ID
type: <string>
presence: optional
content: Specifies the Bundle ID of the managed app. One and only one of `AppStoreID`,
`BundleID`, or `ManifestURL` must be present.
content: The bundle ID of the managed app. One and only one of 'AppStoreID', 'BundleID',
or 'ManifestURL' must be present.
- key: ManifestURL
title: Manifest URL
type: <string>
presence: optional
content: Specifies the URL of the manifest for the managed app. One and only one
of `AppStoreID`, `BundleID`, or `ManifestURL` must be present.
content: The URL of the manifest for the managed app. One and only one of 'AppStoreID',
'BundleID', or 'ManifestURL' must be present.
- key: InstallBehavior
title: Install Behavior
type: <dictionary>
presence: optional
content: Describes how and when the app will be installed.
content: A dictionary that describes how and when to install the app.
subkeys:
- key: Install
title: Install
@@ -54,15 +58,17 @@ payloadkeys:
- Required
default: Optional
content: |-
Describes whether the app must remain on the device at all times, or if the user can freely install and remove it:
* Optional - the user can install and remove the app after the configuration is activated.
* Required - the app is installed when the configuration is activated. The user may not remove the app.
On supervised devices apps are installed automatically. Otherwise the device prompts the user to approve the install of the app.
A string that specifies if the app needs to remain on the device at all times or if the user can freely install and remove it, which is one of the following values:
* Optional: The user can install and remove the app after the system activates the configuration.
* Required: The system installs the app after it activates the configuration. The user can't remove the app.
The system automatically installs apps on supervised devices. Otherwise, the device prompts the user to approve installation of the app.
- key: License
title: License
type: <dictionary>
presence: optional
content: Describes how the app is licensed.
content: A dictionary that describes the app's license.
subkeys:
- key: VPPType
title: VPP Type
@@ -72,17 +78,18 @@ payloadkeys:
- Device
- User
content: |-
Indicates what type of VPP license is used for the app when installed via the App Store:
* Device - the app has a VPP device license.
* User - the app has a VPP user license.
This key must be present when an App Store app is being installed.
The type of VPP license that the app uses for installation through the App Store, which is one of the following values:
* Device: The app has a VPP device license.
* User: The app has a VPP user license.
This key needs to be present to install an app through the App Store.
- key: IncludeInBackup
title: Include in Backup
type: <boolean>
presence: optional
default: true
content: If `true`, backups will contain the app and its data. If `false`, backups
will not contain the app and its data.
content: If 'true', backups contain the app and its data.
- key: Attributes
title: App Attributes
supportedOS:
@@ -90,7 +97,7 @@ payloadkeys:
introduced: n/a
type: <dictionary>
presence: optional
content: A dictionary of values associated with the app.
content: A dictionary of values to associate with the app.
subkeys:
- key: AssociatedDomains
title: Associated Domains
@@ -108,16 +115,15 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, direct downloads will be enabled for associated domains.
content: If 'true', the system enables direct downloads for the 'AssociatedDomains'.
- key: CellularSliceUUID
title: Cellular Slice UUID
type: <string>
presence: optional
content: Either data network name (DNN) or traffic category can be set as the
enterprise slice identifier. For DNN, the value must be encoded as "DNN:name”,
where "name" is the carrier provided DNN name. For app category, the value must
be encoded as "AppCategory:category", where "category" is a carrier provided
string like "Enterprise1".
content: The cellular slice identifier, which can be the data network name (DNN)
or app category. For DNN, encode the value as “DNN:name”, where “name” is the
carrier-provided DNN name. For app category, encode the value as “AppCategory:category”,
where “category” is a carrier-provided string such as “Enterprise1”.
- key: ContentFilterUUID
title: Content Filter UUID
type: <string>
@@ -132,15 +138,14 @@ payloadkeys:
title: Relay UUID
type: <string>
presence: optional
content: The UUID of the Relay to associated with the app.
content: The UUID of the relay to associate with the app.
- key: TapToPayScreenLock
title: Tap to Pay Screen Lock
type: <boolean>
presence: optional
default: false
content: If `true`, the device will automatically lock after every transaction
that requires a customer's card PIN. If `false`, the user of the device may
choose the behavior they prefer.
content: If 'true', the device automatically locks after every transaction that
requires a customer's card PIN. If 'false', the user can choose the behavior.
- key: VPNUUID
title: VPN UUID
type: <string>

12
declarative/declarations/configurations/legacy.interactive.yaml
View File

@@ -7,6 +7,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -16,7 +17,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
allowed-scopes:
- system
@@ -24,11 +25,20 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
allowed-scopes:
- system
watchOS:
introduced: n/a
apply: multiple
payloadkeys:
- key: ProfileURL
title: Profile's URL.

15
declarative/declarations/configurations/legacy.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,17 +28,27 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
apply: multiple
payloadkeys:
- key: ProfileURL
title: Profile's URL.

15
declarative/declarations/configurations/management.status-subscriptions.yaml
View File

@@ -7,6 +7,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
allowed-scopes:
- system
@@ -26,20 +27,30 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
apply: combined
payloadkeys:
- key: StatusItems
title: Status Items
type: <array>
presence: required
combinetype: set-union
content: An array of status items that the device notifies subscribers about.
subkeys:
- key: StatusItem

15
declarative/declarations/configurations/management.test.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,17 +28,27 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
apply: multiple
payloadkeys:
- key: Echo
title: Status Echo

20
declarative/declarations/configurations/passcode.settings.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -16,26 +17,30 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
- user
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
apply: combined
payloadkeys:
- key: RequirePasscode
title: Require Passcode on Device
type: <boolean>
presence: optional
default: false
combinetype: boolean-or
content: If 'true', the system requires the user to set a passcode without any requirements
about the length or quality of the passcode. The presence of any other keys implicitly
requires a passcode, and overrides this key's value.
@@ -51,6 +56,7 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
combinetype: boolean-or
content: If 'true', the passcode needs to consist of at least one alphabetic character
and at least one number.
- key: RequireComplexPasscode
@@ -58,6 +64,7 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
combinetype: boolean-or
content: If 'true', the system requires a complex passcode. A complex passcode is
one that doesn't contain repeated characters or increasing or decreasing characters
(such as 123 or CBA).
@@ -69,6 +76,7 @@ payloadkeys:
min: 0
max: 16
default: 0
combinetype: number-max
content: The minimum number of characters a passcode can contain.
- key: MinimumComplexCharacters
title: Minimum Complex Characters
@@ -85,6 +93,7 @@ payloadkeys:
min: 0
max: 4
default: 0
combinetype: number-max
content: Specifies the minimum number of complex characters in the password. A complex
character is a character other than a number or a letter, such as '&', '%', '$',
and '#'.
@@ -96,6 +105,7 @@ payloadkeys:
min: 2
max: 11
default: 11
combinetype: number-min
content: |-
The number of failed passcode attempts that the system allows the user before iOS erases the device or macOS locks the device. If you don't change this setting, after six failed attempts, the device imposes a time delay before the user can enter a passcode again. The time delay increases with each failed attempt.
After the final failed attempt, the system securely erases all data and settings from the iOS device. A macOS device locks after the final attempt. The passcode time delay begins after the sixth attempt, so if this value is six or lower, the system has no time delay and triggers the erase or lock as soon as the user exceeds the limit.
@@ -110,6 +120,7 @@ payloadkeys:
introduced: n/a
type: <integer>
presence: optional
combinetype: number-min
content: The number of minutes before the login is reset after the maximum number
of failed attempts. Also set the 'MaximumFailedAttempts' key for this to take
effect.
@@ -117,6 +128,7 @@ payloadkeys:
title: Maximum Grace Period
type: <integer>
presence: optional
combinetype: number-min
content: The maximum period that a user can select, during which the user can unlock
the device without a passcode. A value of '0' means no grace period, and the device
requires a passcode immediately. In the absence of this key, the user can select
@@ -128,6 +140,7 @@ payloadkeys:
range:
min: 0
max: 15
combinetype: number-min
content: The maximum period that a user can select, during which the device can
be idle before the system automatically locks it. When the device reaches this
limit, the device locks and the user must enter the passcode to unlock it. In
@@ -145,6 +158,7 @@ payloadkeys:
range:
min: 0
max: 730
combinetype: number-min
content: Specifies the maximum number of days that the passcode can remain unchanged.
After this number of days, the system forces the user to change the passcode before
it unlocks the device.
@@ -155,6 +169,7 @@ payloadkeys:
range:
min: 1
max: 50
combinetype: number-min
content: The number of historical passcode entries the system checks when validating
a new passcode. The device refuses a new passcode if it matches a previously used
passcode within the specified passcode history range. In the absence of this key,
@@ -171,6 +186,7 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
combinetype: boolean-or
content: If 'true', the system forces a password reset the next time the user tries
to authenticate. If you set this key in a configuration in the system scope (device
channel), the setting takes effect for all users, and admin authentication may

5
declarative/declarations/configurations/screensharing.connection.group.yaml
View File

@@ -8,7 +8,7 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -16,8 +16,11 @@ payload:
- user
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: multiple
payloadkeys:
- key: ConnectionGroupUUID
title: Unique Identifier

5
declarative/declarations/configurations/screensharing.connection.yaml
View File

@@ -8,7 +8,7 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -16,8 +16,11 @@ payload:
- user
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: multiple
payloadkeys:
- key: ConnectionUUID
title: Unique Identifier

5
declarative/declarations/configurations/screensharing.host.settings.yaml
View File

@@ -8,14 +8,17 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: single
payloadkeys:
- key: MaximumVirtualDisplays
title: Maximum number of Virtual Displays

15
declarative/declarations/configurations/security.certificate.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,17 +28,27 @@ payload:
tvOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
apply: multiple
payloadkeys:
- key: CredentialAssetReference
title: Credential asset reference

23
declarative/declarations/configurations/security.identity.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,17 +28,27 @@ payload:
tvOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
apply: multiple
payloadkeys:
- key: CredentialAssetReference
title: Credential asset reference
@@ -55,6 +66,10 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <boolean>
presence: optional
default: false
@@ -66,6 +81,10 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <boolean>
presence: optional
default: true

6
declarative/declarations/configurations/security.passkey.attestation.yaml
View File

@@ -7,6 +7,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
@@ -15,13 +16,16 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: multiple
payloadkeys:
- key: AttestationIdentityAssetReference
title: Attestation identity asset reference.

5
declarative/declarations/configurations/services.configuration-files.yaml
View File

@@ -8,13 +8,16 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: multiple
payloadkeys:
- key: ServiceType
title: Service Type

6
declarative/declarations/configurations/softwareupdate.enforcement.specific.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
@@ -15,13 +16,16 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: multiple
payloadkeys:
- key: TargetOSVersion
title: Target OS Version

5
declarative/declarations/configurations/watch.enrollment.yaml
View File

@@ -6,7 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
sharedipad:
@@ -15,8 +15,11 @@ payload:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: single
payloadkeys:
- key: EnrollmentProfileURL
title: Watch Enrollment Profile's URL.

7
declarative/declarations/declarationbase.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:
@@ -19,12 +21,13 @@ payloadkeys:
- key: Identifier
type: <string>
presence: required
content: A string uniquely identifying this declaration.
content: A string uniquely identifying this declaration. The size of this string
should not exceed 64 octets. A UUID string value is a good choice.
- key: ServerToken
type: <string>
presence: required
content: A unique token generated by the server specifying a particular revision
of the declaration.
of the declaration. The size of this string should not exceed 64 octets.
- key: Payload
type: <dictionary>
presence: required

2
declarative/declarations/management/organization-info.yaml
View File

@@ -10,6 +10,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/management/properties.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/declarations/management/server-capabilities.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/protocol/declarationitemsresponse.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/protocol/statusreport.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

2
declarative/protocol/tokensresponse.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

11
declarative/status/account.list.caldav.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.carddav.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.exchange.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.google.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.ldap.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.mail.incoming.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.mail.outgoing.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

11
declarative/status/account.list.subscribed-calendar.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -17,13 +18,21 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
- user
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:

65
declarative/status/app.managed.list.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.2'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -17,6 +18,8 @@ payload:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
beta: true
@@ -25,7 +28,8 @@ payloadkeys:
title: Status item value.
type: <array>
presence: required
content: Status value.
content: An array of dictionaries that describe the device's declarative managed
apps.
subkeytype: App
subkeys:
- key: status_value
@@ -35,7 +39,7 @@ payloadkeys:
title: Unique identifier of the app.
type: <string>
presence: required
content: The unique identifier of the app. This will be the app's bundle id.
content: The app's bundle id, which is unique.
- key: _removed
title: Indicates removal of the app.
type: <boolean>
@@ -58,13 +62,9 @@ payloadkeys:
title: External version id
type: <integer>
presence: optional
content: The application's external version ID. This can also be retrieved from
the store from the "contentMetadataLookupUrl" from the VPPServiceConfigSrv
endpoint. In the response from uclient-api.itunes.apple.com URL, there's a
key named "externalId" at the path results.<adamId>.offers[0].version.externalId.
If the current external version identifier of an app on the store does not
match the external version identifier reported by the device, there may be
an app update available for the device.
content: |-
The app's external version ID. You can also retrieve this value from the store through the contentMetadataLookupUrl <https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/MobileDeviceManagementProtocolRef/5-Web_Service_Protocol_VPP/webservice.html#//apple_ref/doc/uid/TP40017387-CH8-SW209> of VPPServiceConfigSrv <https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/MobileDeviceManagementProtocolRef/5-Web_Service_Protocol_VPP/webservice.html#//apple_ref/doc/uid/TP40017387-CH8-SW15>.
In the response from 'uclient-api.itunes.apple.com' URL, there's an 'externalId' at the path 'results.<adamId>.offers[0].version.externalId'. If the current external version identifier of an app on the store doesn't match the external version identifier reported by the device, there may be an app update available for the device.
- key: version
title: Version
type: <string>
@@ -91,17 +91,18 @@ payloadkeys:
- managed-but-uninstalled
- failed
content: |-
The status of the app.
* optional - the app is optional and the user has to trigger its installation
* queued - installation of the app has started
* prompting-for-consent - a prompt is being shown to the user to proceed with app installation
* prompting-for-login - a prompt to sign in to the App Store is being shown to the user to allow installation
* prompting-for-management - a prompt is being shown to the user to allow changing the installed app to a managed app
* downloading - an update is being downloaded
* installing - the app is being installed
* managed - the app is installed and managed
* managed-but-uninstalled - the app is managed, but has been removed by the user. If installed again, it will be managed
* failed - the app installation has failed
The status of the app, which has the following possible values:
* 'optional': The app is optional and the user has to trigger its installation.
* 'queued': Installation of the app started.
* 'prompting-for-consent': The system is displaying a prompt to the user to proceed with app installation.
* 'prompting-for-login': The system is displaying an App Store sign-in prompt to the user to allow app installation.
* 'prompting-for-management': The system is displaying a prompt to the user to allow changing the installed app to a managed app.
* 'downloading': The system is downloading an app update.
* 'installing': The system is installing an app update.
* 'managed': The app is installed and managed.
* 'managed-but-uninstalled': The app is managed, but the user removed it. The app remains managed if the system installs it again.
* 'failed': An app update failed.
- key: update-state
title: Managed application update status
type: <string>
@@ -113,17 +114,21 @@ payloadkeys:
- updating
- failed
content: |-
The update status of the app. This key is only present when the "state" key is set to "managed" and when there is an app update available.
* available - an update is available for the app
* prompting-for-update - a prompt is being shown to the user to proceed with app update
* prompting-for-update-login - a prompt to sign in to the App Store is being shown to the user to allow app update
* updating - the app is being updated
* failed - the app update has failed
The update status of the app, which has the following possible values:
* 'available': An update is available for the app.
* 'prompting-for-update': The system is displaying a prompt to the user to proceed with app installation.
* 'prompting-for-update-login': The system is displaying an App Store sign-in prompt to the user to allow app installation.
* 'updating': The app is updating.
* 'failed': The app update failed.
This key is only present if 'state' is 'managed' and an update is available.
- key: reasons
title: Status Reasons
type: <array>
presence: optional
content: Additional detail about app state, including errors.
content: An array that contains additional details about the app state, including
errors.
subkeytype: StatusReason
subkeys:
- key: _reasons
@@ -136,17 +141,17 @@ payloadkeys:
title: Error Code
type: <string>
presence: required
content: The error code for this error.
content: A code for the state.
- key: description
title: Error Description
type: <string>
presence: optional
content: The description of this error.
content: A description of the state.
- key: details
title: Error Details
type: <dictionary>
presence: optional
content: A dictionary that contains further details about this error.
content: A dictionary that contains additional details about the state.
subkeys:
- key: ANY
type: <any>

13
declarative/status/device.identifier.serial-number.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
@@ -17,7 +18,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
@@ -25,6 +26,14 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- local
allowed-scopes:
@@ -32,7 +41,7 @@ payload:
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

13
declarative/status/device.identifier.udid.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
@@ -17,7 +18,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
@@ -25,6 +26,14 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- local
allowed-scopes:
@@ -32,7 +41,7 @@ payload:
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.model.family.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.model.identifier.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.model.marketing-name.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.model.number.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.operating-system.build-version.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.operating-system.family.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.operating-system.marketing-name.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.operating-system.supplemental.build-version.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.1'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.1'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.operating-system.supplemental.extra-version.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.1'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.1'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/device.operating-system.version.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

24
declarative/status/device.power.battery-health.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
@@ -14,9 +15,16 @@ payload:
allowed-scopes:
- system
macOS:
introduced: n/a
introduced: '14.4'
allowed-enrollments:
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
@@ -32,9 +40,11 @@ payloadkeys:
- unsupported
content: |-
The battery health status, which has the following values:
* 'non-genuine' - the battery isn't a genuine Apple battery.
* 'normal' - the battery is operating normally.
* 'service-recommended' - the system recommends battery service.
* 'unknown' - the system couldn't determine battery health information.
* 'unsupported' - the device doesn't support battery health reporting.
This field is available in iOS 17 and later on iPhone only. iPad returns 'unsupported'.
* 'non-genuine': The battery isn't a genuine Apple battery.
* 'normal': The battery is operating normally.
* 'service-recommended': The system recommends battery service.
* 'unknown': The system couldn't determine battery health information.
* 'unsupported': The device doesn't support battery health reporting.
Available in iOS 17 and later on iPhone only, and macOS 14.4 and later on Apple silicon Mac computers. iPad and Intel-based Macs return 'unsupported'.

4
declarative/status/diskmanagement.filevault.enabled.yaml
View File

@@ -8,12 +8,14 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:

13
declarative/status/management.client-capabilities.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -17,7 +18,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
allowed-scopes:
- system
@@ -25,13 +26,21 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
payloadkeys:

13
declarative/status/management.declarations.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '15.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -17,7 +18,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
allowed-scopes:
- system
@@ -25,13 +26,21 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
payloadkeys:

18
declarative/status/mdm.app.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
@@ -19,13 +20,21 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
payloadkeys:
@@ -50,8 +59,9 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If 'true', the app is removed and the status item object only contains
this key and the 'identifier' key.
content: To indicate removal of an app, this key's value is set to true, and
only this key and the "identifier" key will be present in the status item
object.
- key: name
title: App name
type: <string>
@@ -102,4 +112,4 @@ payloadkeys:
- update-rejected
- management-rejected
- failed
content: The status of the app reported by ManagedApplicationListCommand.
content: The status of the app that ManagedApplicationListCommand reports.

11
declarative/status/passcode.is-compliant.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -19,10 +20,18 @@ payload:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

11
declarative/status/passcode.is-present.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -19,10 +20,18 @@ payload:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

13
declarative/status/screensharing.connection.group.unresolved-connection.yaml
View File

@@ -9,7 +9,7 @@ payload:
macOS:
introduced: '14.1'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -17,6 +17,8 @@ payload:
- user
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
@@ -24,7 +26,7 @@ payloadkeys:
title: Connection Groups status
type: <array>
presence: required
content: Status value.
content: A status item that contains an array of unresolved connection groups.
subkeytype: UnresolvedGroup
subkeys:
- key: unresolved_group
@@ -34,8 +36,7 @@ payloadkeys:
title: Unique identifier of the connection group.
type: <string>
presence: required
content: The unique identifier (i.e., ConnectionGroupUUID) of the connection
group.
content: The unique 'ConnectionGroupUUID' identifier of the connection group.
- key: _removed
title: Indicates removal of the unresolved connection group.
type: <boolean>
@@ -48,8 +49,8 @@ payloadkeys:
title: Unique identifiers of unresolved connections.
type: <array>
presence: optional
content: An array of ConnectionUUID values (as specifed by the 'Members' key
in the group's declaration) which were not resolved.
content: An array of 'ConnectionUUID' values specified in the 'Members' key
in the group's declaration for the unresolved connections.
subkeys:
- key: ConnectionUUID
title: Connection Unique Identifier

19
declarative/status/security.certificate.list.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
@@ -60,8 +70,9 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If 'true', the certificate is removed and the status item object only
contains this key and the 'identifier' key.
content: To indicate removal of a certificate, this key's value is set to true,
and only this key and the "identifier" key will be present in the status item
object.
- key: declaration-identifier
title: Asset declaration identifier.
type: <string>

4
declarative/status/services.background-task.yaml
View File

@@ -8,12 +8,14 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:

5
declarative/status/softwareupdate.failure-reason.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
@@ -15,11 +16,13 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:

5
declarative/status/softwareupdate.install-reason.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
@@ -15,11 +16,13 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:

8
declarative/status/softwareupdate.install-state.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
@@ -15,11 +16,13 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
@@ -34,7 +37,8 @@ payloadkeys:
- installing
- failed
content: |-
The software update install status:
The software update install status, which has the following values:
* 'none': There's no software update pending, and any previous software update succeeded.
* 'waiting': A software update is waiting to start.
* 'downloading': The system is downloading data for a software update.

5
declarative/status/softwareupdate.pending-version.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '17.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
@@ -15,11 +16,13 @@ payload:
macOS:
introduced: '14.0'
allowed-enrollments:
- device
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:

2
declarative/status/statusreason.yaml
View File

@@ -9,6 +9,8 @@ payload:
introduced: '13.0'
tvOS:
introduced: '16.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:

14
declarative/status/test.array-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/test.boolean-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/test.dictionary-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/test.error-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/test.integer-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/test.real-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

14
declarative/status/test.string-value.yaml
View File

@@ -6,6 +6,7 @@ payload:
iOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- user
- local
@@ -18,7 +19,7 @@ payload:
macOS:
introduced: '13.0'
allowed-enrollments:
- device
- supervised
- user
- local
allowed-scopes:
@@ -27,14 +28,23 @@ payload:
tvOS:
introduced: '16.0'
allowed-enrollments:
- supervised
- device
- local
allowed-scopes:
- system
visionOS:
introduced: '1.1'
allowed-enrollments:
- device
- user
- local
allowed-scopes:
- system
watchOS:
introduced: '10.0'
allowed-enrollments:
- device
- supervised
- local
allowed-scopes:
- system

12
docs/errata.md
View File

@@ -4,12 +4,20 @@ This document lists errata for the YAML schema. This is used when older versions
## iOS 17 / macOS 14
### profiles/com.apple.education.yaml
The `GroupBeaconIDs` key in the `DepartmentsItem` dictionary in the `com.apple.education` profile payload incorrectly listed its type as an array of `string`. The correct type is an array of `integer`.
### profiles/com.apple.vpn.managed.yaml
The `CertificateType` key in the `com.apple.vpn.managed` profile payload incorrectly listed `Ed25519` as a supported certificate type. That type was never supported and has now been removed.
The `PPTP` VPNType has not been supported since iOS 10 and macOS 10.12, see https://support.apple.com/en-us/HT206844. The `PPTP` VPNType has been removed.
There were a number of keys in the VPN dictionary that were implied to appear in other VPN types. These keys have now been explicitly added in all VPN types.
The `ActionParameters` key in the profile payload has always been an array of dictionaries.
### mdmprotocol/commands passcode.firmware.set.yaml passcode.firmware.verify.yaml
The response keys were incorrectly listed as being top-level keys in the response dictionary when in fact they were nested one-level deep.
@@ -35,3 +43,7 @@ The `contrast` key in the `com.apple.universalaccess` profile payload incorrectl
### profiles/com.apple.extensiblesso.yaml
The `AuthorizationGroups` key was updated as the key values-pairs in the dictionary were incorrectly stated.
### profiles/com.apple.dnsSettings.managed
The `ActionParameters` key in the `com.apple.dnsSettings.managed` profile payload has always been an array of dictionaries.

3
docs/schema.md
View File

@@ -35,13 +35,14 @@ The definition of the schema used here is in the `schema.yaml` file. That file c
| iOS | object | Supported features on this iOS |
| macOS | object | Supported features on this macOS |
| tvOS | object | Supported features on this tvOS |
| visionOS | object | Supported features on this visionOS |
| watchOS | object | Supported features on this watchOS |
__Notes__
The `supportedOS` object is used in the `payload` object to indicate overall support for this object on each OS, as well as which enrollment modes are supported per OS. The `supportedOS` key may also appear on any payload key defined in `payloadkeys` or `responsekeys` array item objects. Each payload key is assumed to "inherit" the `supportedOS` values from the `payload` object, but that is then updated with any items in the key's own `supportedOS` object if present. This also overriding specific values in `supportedOS` on a per-key basis without the need to duplicate the entire `supportedOS` value from the `payload`.
### iOS, macOS, tvOS, watchOS Objects
### iOS, macOS, tvOS, visionOS, watchOS Objects
| Name | Type | Description |
|---------------------|---------|-------------|

10
docs/schema.yaml
View File

@@ -79,6 +79,7 @@ properties:
items:
type: string
enum:
- supervised
- device
- user
- local
@@ -155,6 +156,7 @@ properties:
description: Indicates that this payload should be considered a beta release for this OS. It may change in an incompatible way prior to final release.
macOS: *supportedOSItem
tvOS: *supportedOSItem
visionOS: *supportedOSItem
watchOS: *supportedOSItem
apply:
type: string
@@ -279,8 +281,8 @@ properties:
* boolean-and - multiple <boolean> values are combined using a logical AND operation
* number-min - multiple <integer> or <real> values are combined by using the smallest value
* number-max - multiple <integer> or <real> values are combined by using the largest value
* enum-lowest - multiple <string> values with a rangelist are combined by using the value whose position is lowest in the range list
* enum-highest - multiple <string> values with a rangelist are combined by using the value whose position is highest in the range list
* enum-first - multiple <string> values with a rangelist are combined by using the value whose position is first in the range list
* enum-last - multiple <string> values with a rangelist are combined by using the value whose position is last in the range list
* first - multiple values are combined by using the first value that is processed
* array-append - multiple <array> values are combined by concatenating the values in each array into a new array
* set-union - multiple <array> values are combined by returning the unique union of all values in each array
@@ -290,8 +292,8 @@ properties:
- boolean-and
- number-min
- number-max
- enum-lowest
- enum-highest
- enum-first
- enum-last
- first
- array-append
- set-union

36
mdm/checkin/authenticate.yaml
View File

@@ -23,6 +23,12 @@ payload:
tvOS:
introduced: '10.2'
supervised: false
visionOS:
introduced: '1.1'
supervised: false
requiresdep: false
userenrollment:
mode: allowed
watchOS:
introduced: '10.0'
supervised: false
@@ -34,6 +40,8 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -45,6 +53,8 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -56,6 +66,8 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -79,6 +91,9 @@ payloadkeys:
macOS:
userenrollment:
mode: forbidden
visionOS:
userenrollment:
mode: forbidden
type: <string>
presence: required
content: The device's UDID (Unique Device ID).
@@ -94,6 +109,9 @@ payloadkeys:
mode: required
tvOS:
introduced: n/a
visionOS:
userenrollment:
mode: required
watchOS:
introduced: n/a
type: <string>
@@ -105,6 +123,8 @@ payloadkeys:
iOS:
introduced: '9.0'
accessrights: AllowQueryDeviceInformation
visionOS:
accessrights: AllowQueryDeviceInformation
watchOS:
introduced: '10.0'
accessrights: AllowQueryDeviceInformation
@@ -116,6 +136,8 @@ payloadkeys:
iOS:
introduced: '9.0'
accessrights: AllowQueryDeviceInformation
visionOS:
accessrights: AllowQueryDeviceInformation
watchOS:
introduced: '10.0'
accessrights: AllowQueryDeviceInformation
@@ -127,6 +149,8 @@ payloadkeys:
iOS:
introduced: '9.0'
accessrights: AllowQueryDeviceInformation
visionOS:
accessrights: AllowQueryDeviceInformation
watchOS:
introduced: '10.0'
accessrights: AllowQueryDeviceInformation
@@ -144,6 +168,10 @@ payloadkeys:
accessrights: AllowQueryDeviceInformation
userenrollment:
mode: forbidden
visionOS:
accessrights: AllowQueryDeviceInformation
userenrollment:
mode: forbidden
watchOS:
introduced: '10.0'
accessrights: AllowQueryDeviceInformation
@@ -161,6 +189,10 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
accessrights: AllowQueryDeviceInformation
userenrollment:
mode: forbidden
watchOS:
introduced: '10.0'
accessrights: AllowQueryDeviceInformation
@@ -178,6 +210,10 @@ payloadkeys:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
accessrights: AllowQueryDeviceInformation
userenrollment:
mode: forbidden
watchOS:
introduced: '10.0'
accessrights: AllowQueryDeviceInformation

12
mdm/checkin/checkout.yaml
View File

@@ -23,6 +23,12 @@ payload:
tvOS:
introduced: '10.2'
supervised: false
visionOS:
introduced: '1.1'
supervised: false
requiresdep: false
userenrollment:
mode: allowed
watchOS:
introduced: '10.0'
supervised: false
@@ -43,6 +49,9 @@ payloadkeys:
iOS:
userenrollment:
mode: forbidden
visionOS:
userenrollment:
mode: forbidden
type: <string>
presence: required
content: The device's UDID (Unique Device ID).
@@ -58,6 +67,9 @@ payloadkeys:
mode: required
tvOS:
introduced: n/a
visionOS:
userenrollment:
mode: required
watchOS:
introduced: n/a
type: <string>

20
mdm/checkin/declarativemanagement.yaml
View File

@@ -25,6 +25,12 @@ payload:
introduced: '16.0'
supervised: false
requiresdep: false
visionOS:
introduced: '1.1'
supervised: false
requiresdep: false
userenrollment:
mode: allowed
watchOS:
introduced: '10.0'
supervised: false
@@ -58,6 +64,9 @@ payloadkeys:
macOS:
userenrollment:
mode: forbidden
visionOS:
userenrollment:
mode: forbidden
type: <string>
presence: required
content: The device's UDID.
@@ -71,6 +80,9 @@ payloadkeys:
mode: required
tvOS:
introduced: n/a
visionOS:
userenrollment:
mode: required
watchOS:
introduced: n/a
type: <string>
@@ -86,6 +98,8 @@ payloadkeys:
mode: required
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -100,6 +114,8 @@ payloadkeys:
devicechannel: false
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -116,6 +132,8 @@ payloadkeys:
devicechannel: false
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -131,6 +149,8 @@ payloadkeys:
devicechannel: false
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>

8
mdm/checkin/getbootstraptoken.yaml
View File

@@ -3,6 +3,8 @@ description: Check-in protocol get bootstrap token data.
payload:
requesttype: GetBootstrapToken
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.15'
devicechannel: true
@@ -11,6 +13,12 @@ payload:
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: Check-in protocol get bootstrap token data request and response.
payloadkeys:
- key: MessageType

26
mdm/checkin/gettoken.yaml
View File

@@ -23,6 +23,12 @@ payload:
mode: allowed
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
supervised: false
requiresdep: false
userenrollment:
mode: allowed
watchOS:
introduced: n/a
content: Check-in protocol get token data request and response.
@@ -55,6 +61,8 @@ payloadkeys:
mode: forbidden
macOS:
introduced: n/a
visionOS:
introduced: n/a
type: <string>
presence: optional
content: A security token to generate the server token. Required by the 'com.apple.watch.pairing'
@@ -69,6 +77,8 @@ payloadkeys:
mode: forbidden
macOS:
introduced: n/a
visionOS:
introduced: n/a
type: <string>
presence: optional
content: The identifier of the phone paired to the watch. Required by the 'com.apple.watch.pairing'
@@ -83,6 +93,8 @@ payloadkeys:
mode: forbidden
macOS:
introduced: n/a
visionOS:
introduced: n/a
type: <string>
presence: optional
content: The identifier of the watch paired to the phone. Required by the 'com.apple.watch.pairing'
@@ -95,6 +107,9 @@ payloadkeys:
macOS:
userenrollment:
mode: forbidden
visionOS:
userenrollment:
mode: forbidden
type: <string>
presence: required
content: The device's UDID.
@@ -106,6 +121,9 @@ payloadkeys:
macOS:
userenrollment:
mode: required
visionOS:
userenrollment:
mode: required
type: <string>
presence: required
content: A per-enrollment identifier that identifies the device for user enrollments.
@@ -117,6 +135,8 @@ payloadkeys:
devicechannel: false
userenrollment:
mode: required
visionOS:
introduced: n/a
type: <string>
presence: required
content: A per-enrollment identifier that identifies the user for user enrollments.
@@ -127,6 +147,8 @@ payloadkeys:
mode: required
macOS:
devicechannel: false
visionOS:
introduced: n/a
type: <string>
presence: optional
content: On Shared iPad, this value returns the Managed Apple ID of the user. When
@@ -139,6 +161,8 @@ payloadkeys:
mode: required
macOS:
devicechannel: false
visionOS:
introduced: n/a
type: <string>
presence: optional
content: In macOS, this value returns the ID of the user. On Shared iPad, this value
@@ -149,6 +173,8 @@ payloadkeys:
introduced: n/a
macOS:
devicechannel: false
visionOS:
introduced: n/a
type: <string>
presence: required
content: The full name of the user.

8
mdm/checkin/setbootstraptoken.yaml
View File

@@ -3,6 +3,8 @@ description: Check-in protocol set bootstrap token data.
payload:
requesttype: SetBootstrapToken
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.15'
devicechannel: true
@@ -11,6 +13,12 @@ payload:
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: Check-in protocol set bootstrap token data request and response.
payloadkeys:
- key: MessageType

26
mdm/checkin/tokenupdate.yaml
View File

@@ -23,6 +23,12 @@ payload:
tvOS:
introduced: '10.2'
supervised: false
visionOS:
introduced: '1.1'
supervised: false
requiresdep: false
userenrollment:
mode: allowed
watchOS:
introduced: '10.0'
supervised: false
@@ -35,6 +41,8 @@ payloadkeys:
macOS:
introduced: '10.11'
devicechannel: false
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <boolean>
@@ -58,6 +66,9 @@ payloadkeys:
macOS:
userenrollment:
mode: forbidden
visionOS:
userenrollment:
mode: forbidden
type: <string>
presence: required
content: The device's UDID.
@@ -73,6 +84,9 @@ payloadkeys:
mode: required
tvOS:
introduced: n/a
visionOS:
userenrollment:
mode: required
watchOS:
introduced: n/a
type: <string>
@@ -90,6 +104,8 @@ payloadkeys:
mode: required
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -106,6 +122,8 @@ payloadkeys:
devicechannel: false
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -123,6 +141,8 @@ payloadkeys:
devicechannel: false
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -138,6 +158,8 @@ payloadkeys:
devicechannel: false
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
type: <string>
@@ -161,6 +183,10 @@ payloadkeys:
mode: forbidden
macOS:
introduced: n/a
visionOS:
accessrights: AllowPasscodeRemovalAndLock
userenrollment:
mode: forbidden
watchOS:
accessrights: AllowPasscodeRemovalAndLock
type: <data>

8
mdm/checkin/userauthenticate.yaml
View File

@@ -3,6 +3,8 @@ description: Authenticate network or mobile users with MDM.
payload:
requesttype: UserAuthenticate
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.7'
devicechannel: false
@@ -10,6 +12,12 @@ payload:
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: Authenticate network or mobile users with MDM.
payloadkeys:
- key: MessageType

8
mdm/commands/account.configuration.yaml
View File

@@ -4,6 +4,8 @@ description: This command can be sent to the device to have it create the local
payload:
requesttype: AccountConfiguration
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.11'
accessrights: None
@@ -12,6 +14,12 @@ payload:
requiresdep: true
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: When a macOS (v10.11 and later) device is configured via DEP to enroll
in an MDM server and the DEP profile has the await_device_configuration flag set
to true, the AccountConfiguration command can be sent to the device to have it

8
mdm/commands/application.extensions.listactive.yaml
View File

@@ -3,6 +3,8 @@ description: Returns information about the active NSExtensions for a particular
payload:
requesttype: ActiveNSExtensions
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.13'
accessrights: QueryInstalledApps
@@ -11,6 +13,12 @@ payload:
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: |-
Returns information about the active NSExtensions for a particular user.
NSExtensions are installed and enabled at the user level. There is no concept of "device" NSExtensions.

8
mdm/commands/application.extensions.mappings.yaml
View File

@@ -3,6 +3,8 @@ description: This command returns information about installed extensions for a u
payload:
requesttype: NSExtensionMappings
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.13'
accessrights: QueryInstalledApps
@@ -11,6 +13,12 @@ payload:
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: |-
This command returns information about installed extensions for a user.
The purpose of this command is to allow the server to build a mapping of

Some files were not shown because too many files have changed in this diff Show More