CalvinBackup/apple-device-management-mdm
1
0
Fork 0
mirror of https://github.com/apple/device-management.git synced 2026-09-23 01:50:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Release-v27.0

Browse Source
This commit is contained in:
Cyrus Daboo
2026-09-17 09:59:16 -04:00
parent 67045e2fa0
commit 09f249a06e
759 changed files with 22171 additions and 2539 deletions
Download Patch File Download Diff File Expand all files Collapse all files
declarative/status/account.list.caldav.yaml
+15 -5
View File
@@ -1,5 +1,5 @@
title: Status Account List CalDAV
description: A status report of the client's Calendar accounts.
description: The status item that lists the devices's Calendar accounts.
payload:
statusitemtype: account.list.caldav
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's Calendar account details.
content: A Calendar account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device has removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -77,7 +78,7 @@ payloadkeys:
presence: optional
content: The server host name for the account.
- key: port
title: Server Port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
@@ -97,3 +98,12 @@ payloadkeys:
type: <boolean>
presence: optional
content: If `true`, the Reminders app is displaying reminders for the account.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.caldav/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.caldav/example2.json
declarative/status/account.list.carddav.yaml
+15 -5
View File
@@ -1,5 +1,5 @@
title: Status Account List CardDAV
description: A status report of the client's Contacts accounts.
description: The status item that lists the devices's Contacts accounts.
payload:
statusitemtype: account.list.carddav
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's Contacts account details.
content: A Contacts account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device has removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -77,7 +78,7 @@ payloadkeys:
presence: optional
content: The server host name for the account.
- key: port
title: Server Port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
@@ -86,3 +87,12 @@ payloadkeys:
type: <string>
presence: optional
content: The user name for the account.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.carddav/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.carddav/example2.json
declarative/status/account.list.exchange.yaml
+15 -5
View File
@@ -1,5 +1,5 @@
title: Status Account List Exchange
description: A status report of the client's Exchange accounts.
description: The status item that lists the devices's Exchange accounts.
payload:
statusitemtype: account.list.exchange
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's Exchange account details.
content: An Exchange account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device has removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -77,7 +78,7 @@ payloadkeys:
presence: optional
content: The server host name for the account.
- key: port
title: Server Port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
@@ -116,3 +117,12 @@ payloadkeys:
presence: optional
content: A Boolean value that indicates whether the Reminders app displays reminders
for this account.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.exchange/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.exchange/example2.json
declarative/status/account.list.google.yaml
+14 -4
View File
@@ -1,5 +1,5 @@
title: Status Account List Google
description: A status report of the client's Google accounts.
description: The status item that lists the client's Google accounts.
payload:
statusitemtype: account.list.google
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's Google account details.
content: A Google account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -100,3 +101,12 @@ payloadkeys:
presence: optional
content: A Boolean value that indicates whether the Notes app displays notes
for this account.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.google/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.google/example2.json
declarative/status/account.list.ldap.yaml
+16 -6
View File
@@ -1,6 +1,6 @@
title: Status Account List LDAP
description: A status report of the client's Lightweight Directory Access Protocol
(LDAP) accounts.
description: The status item that lists the devices's Lightweight Directory Access
Protocol (LDAP) accounts.
payload:
statusitemtype: account.list.ldap
supportedOS:
@@ -46,8 +46,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's LDAP account details.
content: An LDAP account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -59,8 +60,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -78,7 +79,7 @@ payloadkeys:
presence: optional
content: The server host name for the account.
- key: port
title: Server Port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
@@ -93,3 +94,12 @@ payloadkeys:
presence: optional
content: A Boolean value that indicates whether the account is enabled for use
with the Contacts app.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.ldap/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.ldap/example2.json
declarative/status/account.list.mail.incoming.yaml
+15 -5
View File
@@ -1,5 +1,5 @@
title: Status Account List Mail Incoming
description: A status report of the client's incoming Mail accounts.
description: The status item that lists the devices's incoming Mail accounts.
payload:
statusitemtype: account.list.mail.incoming
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's incoming Mail account details.
content: An incoming Mail account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -77,7 +78,7 @@ payloadkeys:
presence: optional
content: The server host name for the account.
- key: port
title: Server Port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
@@ -98,3 +99,12 @@ payloadkeys:
presence: optional
content: A Boolean value that indicates whether the Notes app displays notes
for this account.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.mail.incoming/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.mail.incoming/example2.json
declarative/status/account.list.mail.outgoing.yaml
+15 -5
View File
@@ -1,5 +1,5 @@
title: Status Account List Mail Outgoing
description: A status report of the client's outgoing Mail accounts.
description: The status item that lists the devices's outgoing Mail accounts.
payload:
statusitemtype: account.list.mail.outgoing
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's outgoing Mail account details.
content: An outgoing Mail account.
subkeys:
- key: identifier
title: Unique identifier of the account.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the account is removed and the status item object only contains
this key and the `identifier` key.
content: If `true`, the device removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
@@ -77,7 +78,7 @@ payloadkeys:
presence: optional
content: The server host name for the account.
- key: port
title: Server Port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
@@ -86,3 +87,12 @@ payloadkeys:
type: <string>
presence: optional
content: The user name for the account.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.mail.outgoing/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.mail.outgoing/example2.json
declarative/status/account.list.subscribed-calendar.yaml
+14 -4
View File
@@ -1,5 +1,5 @@
title: Status Account List Subscribed Calendar
description: A status report of the client's subscribed calendars.
description: The status item that lists the devices's subscribed calendars.
payload:
statusitemtype: account.list.subscribed-calendar
supportedOS:
@@ -45,8 +45,9 @@ payloadkeys:
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of the client's subscribed calendar details.
content: A subscribed calendar.
subkeys:
- key: identifier
title: Unique identifier of the subscribed calendar.
@@ -58,8 +59,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the subscribed calendar is removed and the status item object
only contains this key and the `identifier` key.
content: If `true`, the device removed the subscribed calendar and the status
item object only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the subscribed calendar.
type: <string>
@@ -87,3 +88,12 @@ payloadkeys:
presence: optional
content: A Boolean value that indicates whether the Calendar app displays this
subscribed calendar.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: examples/declarative/status/account.list.subscribed-calendar/example1.json
- tab: Removed account
description: Reports a removed account.
file: examples/declarative/status/account.list.subscribed-calendar/example2.json
declarative/status/app.managed.list.yaml
+26 -13
View File
@@ -1,5 +1,5 @@
title: Status App Managed List
description: The device's declarative managed apps.
description: The status item that lists the device's declarative managed apps.
payload:
statusitemtype: app.managed.list
supportedOS:
@@ -44,8 +44,9 @@ payloadkeys:
subkeytype: App
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A dictionary that describes a declarative managed app.
content: A managed app.
subkeys:
- key: identifier
title: Unique identifier of the app.
@@ -74,7 +75,7 @@ payloadkeys:
type: <integer>
presence: optional
content: |-
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`.
The app's external version identifier. You can also retrieve this value from the App Store. For more information, see `Apps and books metadata for organizations`.
If the current external version identifier of an app on the App Store doesn't match the external version identifier reported by the device, there may be an app update available for the device.
- key: version
@@ -108,7 +109,7 @@ payloadkeys:
- `optional`: The app is optional and the user has to trigger its installation.
- `queued`: The system has started installation of the app.
- `not-present`: Management of the app occurs after it is installed.
- `not-present`: Management of the app occurs after it's installed.
- `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.
@@ -144,7 +145,7 @@ payloadkeys:
iOS:
introduced: '18.4'
macOS:
introduced: n/a
introduced: '27.0'
type: <dictionary>
presence: optional
content: The status of app or extension managed configurations. This key is
@@ -170,9 +171,9 @@ payloadkeys:
- valid
content: |-
The managed configuration status.
- `unknown`: The managed configuration has not been read
- `invalid`: The managed configuration was read and deemed to be invalid
- `valid`: The managed configuration was read and deemed to be valid
- `unknown`: The device hasn't read the managed configuration.
- `invalid`: The device read the managed configuration and found it to be invalid.
- `valid`: The device read the managed configuration and found it to be valid.
- key: extension-config-state
title: Extensions managed configuration status
type: <dictionary>
@@ -189,7 +190,7 @@ payloadkeys:
subkeytype: ManagedConfigurationState
subkeys: *id001
- key: reasons
title: Status Reasons
title: Status reasons
type: <array>
presence: optional
content: An array that contains additional details about the app state, including
@@ -197,23 +198,23 @@ payloadkeys:
subkeytype: StatusReason
subkeys:
- key: _reasons
title: Status Reason
title: Status reason
type: <dictionary>
content: Information about a status error.
subkeytype: StatusReason
subkeys:
- key: code
title: Error Code
title: Error code
type: <string>
presence: required
content: A code for the state.
- key: description
title: Error Description
title: Error description
type: <string>
presence: optional
content: A description of the state.
- key: details
title: Error Details
title: Error details
type: <dictionary>
presence: optional
content: A dictionary that contains additional details about the state.
@@ -230,6 +231,7 @@ reasons:
details:
- key: Timestamp
type: <string>
valuetype: timestamp
description: The RFC 3339 timestamp of the last download failure.
- value: Error.DuplicateConfiguredApp
description: The app is already being managed.
@@ -238,6 +240,7 @@ reasons:
details:
- key: Timestamp
type: <string>
valuetype: timestamp
description: The RFC 3339 timestamp of the last install failure.
- value: Error.InvalidAppID
description: The app id could not be found.
@@ -263,4 +266,14 @@ reasons:
details:
- key: Timestamp
type: <string>
valuetype: timestamp
description: The RFC 3339 timestamp of the last update failure.
examples:
- title: Status item example
files:
- tab: New or updated app
description: Reports a new or updated app.
file: examples/declarative/status/app.managed.list/example1.json
- tab: Removed app
description: Reports a removed app.
file: examples/declarative/status/app.managed.list/example2.json
declarative/status/content-cache.info.yaml
+100
View File
@@ -0,0 +1,100 @@
title: Status Content Cache Info
description: The status item that reports information about the Content Cache service.
payload:
statusitemtype: content-cache.info
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: content-cache.info
title: Cache info
type: <dictionary>
presence: required
content: A dictionary that contains info about the usage of the Content Cache on
the device
subkeys:
- key: cache-details
title: Cache details
type: <array>
presence: optional
content: The amount of disk space that various categories of cached content use.
Apple defines these categories and they're subject to change.
subkeys:
- key: detail-item
title: Example file category
type: <string>
presence: required
content: The amount of disk space in bytes, that this category of cached content
uses.
- key: cache-free
title: Cache free space
type: <integer>
presence: optional
content: The amount of disk space in bytes, available to the Content Cache.
- key: cache-limit
title: Cache limit
type: <integer>
presence: optional
content: 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` configuration.
- key: cache-status
title: Cache status
type: <string>
presence: optional
rangelist:
- LOWSPACE
- OK
content: The level of cache pressure. `LOWSPACE` means cache pressure is high.
- key: cache-used
title: Cache used
type: <integer>
presence: optional
content: The amount of disk space in bytes, cached content uses. The Content Cache
allocates space in its cache for entire files even when it stores only part
of those files in its cache.
- key: max-cache-pressure-last-hour
title: Maximum cache pressure
type: <real>
presence: optional
range:
min: 0.0
max: 1.0
content: 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.
- key: personal-cache-free
title: Personal cache free
type: <integer>
presence: optional
content: The amount of disk space in bytes, available to the Content Cache for
personal iCloud content.
- key: personal-cache-limit
title: Personal cache limit
type: <integer>
presence: optional
content: 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.
- key: personal-cache-used
title: Personal cache used
type: <integer>
presence: optional
content: The amount of disk space, in bytes, available to the Content Cache for
personal iCloud content.
examples:
- title: Status item example
files:
- file: examples/declarative/status/content-cache.info/example1.json
declarative/status/content-cache.parents.yaml
+76
View File
@@ -0,0 +1,76 @@
title: Status Content Cache Parents
description: The status item that reports information about the Content Cache service
parent caches.
payload:
statusitemtype: content-cache.parents
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: content-cache.parents
title: Content cache parents
type: <array>
presence: optional
content: An array of dictionaries that describes parent Content Caches.
subkeys:
- key: parents-item
title: Parent item
type: <dictionary>
presence: optional
content: A parent Content Cache.
subkeys:
- key: identifier
title: Parent GUID
type: <string>
presence: required
content: The unique identifier of the parent Content Cache.
- key: _removed
title: Indicates removal of the entry.
type: <boolean>
presence: optional
default: false
content: If `true`, the system removed the parent entry and only this key and
the `identifier` key are present in the status item object.
- key: address
title: IP address
type: <string>
presence: required
content: The local IPv4 address of the parent Content Cache.
- key: port
title: Port
type: <integer>
presence: required
content: The IP port number the parent Content Cache listens to for requests.
- key: healthy
title: Cache health
type: <boolean>
presence: required
content: If `true,` the parent Content Cache is able to respond to requests
from this Content Cache.
- key: version
title: Version
type: <string>
presence: required
content: The version number of the parent Content Cache software.
examples:
- title: Status item example
files:
- tab: New or updated parent
description: Reports a new or updated parent.
file: examples/declarative/status/content-cache.parents/example1.json
- tab: Removed parent
description: Reports a removed parent.
file: examples/declarative/status/content-cache.parents/example2.json
declarative/status/content-cache.peers.yaml
+82
View File
@@ -0,0 +1,82 @@
title: Status Content Cache Peers
description: The status item that reports information about the Content Cache service
peer caches.
payload:
statusitemtype: content-cache.peers
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: content-cache.peers
title: Content cache peers
type: <array>
presence: required
content: An array of dictionaries that describes peer Content Caches.
subkeys:
- key: peer-item
title: Peer item
type: <dictionary>
presence: optional
content: A peer Content Cache.
subkeys:
- key: identifier
title: Peer GUID
type: <string>
presence: required
content: The unique identifier of the peer Content Cache.
- key: _removed
title: Indicates removal of the entry.
type: <boolean>
presence: optional
default: false
content: If `true`, the system removed the peer entry and only this key and
the `identifier` key are present in the status item object.
- key: address
title: IP address
type: <string>
presence: required
content: The local IPv4 address of the peer Content Cache.
- key: port
title: Port
type: <integer>
presence: required
content: The IP port number the peer Content Cache listens to for requests.
- key: friendly
title: Friendly
type: <boolean>
presence: required
content: If `true`, the peer Content Cache is willing to respond to requests
from this Content Cache.
- key: healthy
title: Cache health
type: <boolean>
presence: required
content: If `true`, the peer Content Cache is able to respond to requests from
this Content Cache.
- key: version
title: Version
type: <string>
presence: required
content: The version number of the peer Content Cache software.
examples:
- title: Status item example
files:
- tab: New or updated peer
description: Reports a new or updated peer.
file: examples/declarative/status/content-cache.peers/example1.json
- tab: Removed peer
description: Reports a removed peer.
file: examples/declarative/status/content-cache.peers/example2.json
declarative/status/content-cache.status.yaml
+159
View File
@@ -0,0 +1,159 @@
title: Status Content Cache Status
description: The status item that reports the status of the Content Cache service.
payload:
statusitemtype: content-cache.status
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- local
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: content-cache.status
title: Status of the content cache service
type: <dictionary>
presence: required
content: The basic set of AssetCache status items
subkeys:
- key: server-guid
title: Server GUID
type: <string>
presence: required
content: The unique identifier of the Content Cache.
- key: activated
title: Activated
type: <boolean>
presence: optional
default: false
content: If `true`, the device has enabled the Content Cache. Enabling the Content
Caching doesn't guarantee service. See the `Active` key for the readiness of
the Content Cache to serve requests.
- key: active
title: Active
type: <boolean>
presence: optional
default: false
content: If `true`, the Content Cache is ready to serve requests.
- key: cache-status
title: Cache status
type: <string>
presence: optional
rangelist:
- LOWSPACE
- OK
content: The level of cache pressure. `LOWSPACE` means cache pressure is high.
- key: private-addresses
title: Private addresses
type: <array>
presence: optional
content: An array of the Content Cache's local IP addresses.
subkeys:
- key: private-address-item
title: Private address
type: <string>
presence: required
content: Local IP address at which the Content Cache listens for requests from
clients, peers, and children.
- key: public-address
title: Public address
type: <string>
presence: optional
content: The public IP address of the Content Cache.
- key: port
title: Port
type: <integer>
presence: optional
content: The IP port number the Content Cache listens to for requests from clients,
peers, and children.
- key: registration-status
title: Registration status
type: <integer>
presence: optional
rangelist:
- -1
- 0
- 1
content: |-
The status of the Content Cache's registration with Apple, which is one of the following values:
- `-1`: The registration failed.
- `0`: The registration is pending.
- `1`: The registration succeeded.
- key: registration-started
title: Registration timestamp
type: <string>
presence: optional
content: The RFC 3339 timestamp for when the Content Cache began registering itself
with Apple. This value is only available during registration attempts.
- key: registration-response-code
title: Registration response code
type: <integer>
presence: optional
content: If present, the HTTP response code that the Content Cache received when
it failed to register itself with Apple.
- key: registration-error
title: Registration error
type: <string>
presence: optional
content: If present, the reason the Content Cache failed to register itself with
Apple.
- key: startup-status
title: Startup status
type: <string>
presence: optional
rangelist:
- FAILED
- MIGRATING_DATA
- OK
- PENDING
content: The status of the Content Cache's registration with Apple.
- key: tetherator-status
title: Tetherator status
type: <integer>
presence: optional
rangelist:
- -1
- 0
- 1
content: |-
The status of tethered caching, which is the Content Cache with a shared internet connection, which is one of the following values:
- '-1' : Unknown
- '0' : Disabled
- '1' : Enabled
- key: sending-reports
title: Sending metrics reports
type: <boolean>
presence: optional
content: When present, a value of `true` indicates that the cache is sending metrics
reports to the URL specified in the `ManagementStatusTarget` key in the installed
`ContentCaching` configuration.
- key: report-response-code
title: Metrics report response code
type: <integer>
presence: optional
content: When present, contains the HTTP response code that the Content Cache
received when it failed to send the metrics report to the target URL.
- key: report-error
title: Metrics report error
type: <string>
presence: optional
content: When present, indicates why the Content Cache failed to send the metrics.
- key: version
title: Version
type: <string>
presence: required
content: The version number of the Content Cache software.
examples:
- title: Status item example
files:
- file: examples/declarative/status/content-cache.status/example1.json
declarative/status/device.identifier.serial-number.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Serial Number
description: A status report of the device's serial number.
description: The status item that reports the device's serial number.
payload:
statusitemtype: device.identifier.serial-number
supportedOS:
@@ -52,3 +52,7 @@ payloadkeys:
type: <string>
presence: required
content: The device's serial number.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.identifier.serial-number/example1.json
declarative/status/device.identifier.udid.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device UDID
description: A status report of the device's UDID.
description: The status item that reports the device's UDID.
payload:
statusitemtype: device.identifier.udid
supportedOS:
@@ -54,3 +54,7 @@ payloadkeys:
content: The device's UDID. This value is always available on the device channel.
This value is only available on user channels whose organization matches that
of the device channel.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.identifier.udid/example1.json
declarative/status/device.model.family.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Model Family
description: A status report of the device's hardware family.
description: The status item that reports the device's hardware model family.
payload:
statusitemtype: device.model.family
supportedOS:
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The hardware family of the device, such as `Mac`, `iPhone`, or `iPad`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.model.family/example1.json
declarative/status/device.model.identifier.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Model Identifier
description: A status report of the device's hardware identifier.
description: The status item that reports the device's hardware model identifier.
payload:
statusitemtype: device.model.identifier
supportedOS:
@@ -59,3 +59,7 @@ payloadkeys:
model's version is a comma-separated number where the first part of the number
is the version, and the second part is a variant, such as `MacBookPro15,1` or
`iPhone13,2`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.model.identifier/example1.json
declarative/status/device.model.marketing-name.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Model Marketing Name
description: A status report of the device's marketing name.
description: The status item that reports the device's model marketing name.
payload:
statusitemtype: device.model.marketing-name
supportedOS:
@@ -56,3 +56,7 @@ payloadkeys:
presence: required
content: The device's marketing name, such as `iPhone 12`. This value may not always
be available.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.model.marketing-name/example1.json
declarative/status/device.model.number.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Model Number
description: A status report of the device's hardware number.
description: The status item that reports the device's hardware number.
payload:
statusitemtype: device.model.number
supportedOS:
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The device's model number.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.model.number/example1.json
declarative/status/device.operating-system.build-version.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Operating System Build Version
description: A status report of the device's software build identifier.
description: The status item that reports the device's operating system build version.
payload:
statusitemtype: device.operating-system.build-version
supportedOS:
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The operating system's build version on the device, such as `18F132`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.operating-system.build-version/example1.json
declarative/status/device.operating-system.family.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Operating System Family
description: A status report of the device's operating system family.
description: The status item that reports the device's operating system family.
payload:
statusitemtype: device.operating-system.family
supportedOS:
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The operating system family in use on the device, such as `macOS` or `iOS`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.operating-system.family/example1.json
declarative/status/device.operating-system.marketing-name.yaml
+6 -1
View File
@@ -1,5 +1,6 @@
title: Status Device Operating System Marketing Name
description: A status report of the device's operating system marketing name.
description: The status item that reports the device's operating system marketing
name.
payload:
statusitemtype: device.operating-system.marketing-name
supportedOS:
@@ -55,3 +56,7 @@ payloadkeys:
type: <string>
presence: required
content: The operating system's marketing name in use on the device, such as `Catalina`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.operating-system.marketing-name/example1.json
declarative/status/device.operating-system.supplemental.build-version.yaml
+6 -1
View File
@@ -1,5 +1,6 @@
title: Status Device Operating System Supplemental Build Version
description: A status report of the device's operating system supplemental build identifier.
description: The status item that reports the device's operating system supplemental
build version and Background Security Improvement version.
payload:
statusitemtype: device.operating-system.supplemental.build-version
supportedOS:
@@ -56,3 +57,7 @@ payloadkeys:
presence: required
content: The operating system's build and Background Security Improvement versions
in use on the device, for example, `20A123a` or `20B27c`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.operating-system.supplemental.build-version/example1.json
declarative/status/device.operating-system.supplemental.extra-version.yaml
+6 -2
View File
@@ -1,6 +1,6 @@
title: Status Device Operating System Supplemental Extra Version
description: A status report of the device's operating system's Background Security
Improvement identifier.
description: The status item that reports the device's operating system Background
Security Improvement version.
payload:
statusitemtype: device.operating-system.supplemental.extra-version
supportedOS:
@@ -57,3 +57,7 @@ payloadkeys:
presence: required
content: The operating system's Background Security Improvement version in use on
the device, for example, `a`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.operating-system.supplemental.extra-version/example1.json
declarative/status/device.operating-system.version.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Device Operating System Version
description: A status report of the device's operating system version.
description: The status item that reports the device's operating system version.
payload:
statusitemtype: device.operating-system.version
supportedOS:
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The operating system's version in use on the device, such as `15.0`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.operating-system.version/example1.json
declarative/status/device.power.battery-health.yaml
+6 -2
View File
@@ -1,5 +1,5 @@
title: Status Device Battery Health
description: The device's battery health.
description: The status item that reports the device's battery health.
payload:
statusitemtype: device.power.battery-health
supportedOS:
@@ -47,7 +47,7 @@ payloadkeys:
- `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, iPadOS 18.4 and later on supported iPad models, and macOS 14.4 and later on a Mac with Apple silicon.
Supported on iPhones, specific iPad models, and Mac computers with Apple silicon.
notes:
- title: ''
content: |-
@@ -56,3 +56,7 @@ notes:
- [iPhone devices](https://support.apple.com/101575)
- [iPad devices](https://support.apple.com/117759)
- [macOS devices](https://support.apple.com/108376)
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.power.battery-health/example1.json
declarative/status/device.system.health.yaml
+128
View File
@@ -0,0 +1,128 @@
title: Status Device System Health
description: The status item that reports the device's system health.
payload:
statusitemtype: device.system.health
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
macOS:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: device.system.health
title: Status item value.
type: <dictionary>
presence: required
content: |-
A dictionary where each key represents a hardware component name and each value is a string indicating the component's health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- `non-genuine`: The component isn't a genuine Apple component.
Not all keys are supported on each device. The dictionary includes only components that are present and reportable on the device.
subkeys:
- key: Baseband
title: Baseband health status
type: <string>
presence: optional
rangelist:
- ok
- error
content: |-
The baseband health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- key: Camera
title: Camera health status
type: <string>
presence: optional
rangelist:
- ok
- error
- non-genuine
content: |-
The camera health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- `non-genuine`: The component isn't a genuine Apple component.
- key: Display
title: Display health status
type: <string>
presence: optional
rangelist:
- ok
- error
- non-genuine
content: |-
The display health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- `non-genuine`: The component isn't a genuine Apple component.
- key: FaceID
title: Face ID health status
type: <string>
presence: optional
rangelist:
- ok
- error
content: |-
The Face ID health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- key: NFC
title: NFC health status
type: <string>
presence: optional
rangelist:
- ok
- error
content: |-
The NFC (Near Field Communication) health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- key: TouchID
title: Touch ID health status
type: <string>
presence: optional
rangelist:
- ok
- error
content: |-
The Touch ID health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
- key: UWB
title: Ultra-wideband radio health status
type: <string>
presence: optional
rangelist:
- ok
- error
content: |-
The UWB (Ultra-Wideband) radio health status, which has the following values:
- `ok`: The component is operating normally.
- `error`: The component has a detected error or failure.
examples:
- title: Status item example
files:
- file: examples/declarative/status/device.system.health/example1.json
declarative/status/diskmanagement.filevault.enabled.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Disk Management File Vault Enabled
description: The enabled status of the File Vault.
description: The status item that reports whether FileVault is enabled.
payload:
statusitemtype: diskmanagement.filevault.enabled
supportedOS:
@@ -24,3 +24,7 @@ payloadkeys:
type: <boolean>
presence: required
content: A Boolean value that specifies the File Vault enabled status on the device.
examples:
- title: Status item example
files:
- file: examples/declarative/status/diskmanagement.filevault.enabled/example1.json
declarative/status/enhanced-logging.applecare-token.yaml
+42
View File
@@ -0,0 +1,42 @@
title: Status Enhanced Logging AppleCare Token
description: The status item that reports the device's enhanced log collection session
AppleCare token.
payload:
statusitemtype: enhanced-logging.applecare-token
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: enhanced-logging.applecare-token
title: AppleCare token value.
type: <string>
presence: optional
content: The current enhanced log collection session AppleCare token. The device
returns an empty string if there's no session status to report.
examples:
- title: Status item example
files:
- file: examples/declarative/status/enhanced-logging.applecare-token/example1.json
declarative/status/enhanced-logging.status.yaml
+64
View File
@@ -0,0 +1,64 @@
title: Status Enhanced Logging Status
description: The status item that reports the device's enhanced log collection session
status.
payload:
statusitemtype: enhanced-logging.status
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: enhanced-logging.status
title: Status item value.
type: <string>
presence: required
rangelist:
- none
- waiting-for-consent
- collecting
- follow-up-question
- upload-consent
- uploading
- finished
- failed
- cancelled
- declined
content: |-
The enhanced log collection session status, which has the following values:
- `none`: The device has never run an enhanced log collection session.
- `waiting-for-consent`: The device is waiting for the user to consent to the enhanced log collection.
- `collecting`: The enhanced log collection is in progress.
- `follow-up-question`: The device is waiting for follow-up response from the user.
- `upload-consent`: The device is waiting for the user to approve upload of the enhanced logs.
- `uploading`: The device is uploading the enhanced logs.
- `finished`: The device completed the enhanced log collection session.
- `failed`: The device failed to complete the enhanced log collection session.
- `cancelled` - The device management service cancelled the enhanced log collection session.
- `declined` - The user declined the enhanced log collection session.
examples:
- title: Status item example
files:
- file: examples/declarative/status/enhanced-logging.status/example1.json
declarative/status/enhanced-logging.timestamp.yaml
+43
View File
@@ -0,0 +1,43 @@
title: Status Enhanced Logging Timestamp
description: The status item that reports the device's enhanced log collection session
timestamp.
payload:
statusitemtype: enhanced-logging.timestamp
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: enhanced-logging.timestamp
title: Timestamp value.
type: <string>
presence: optional
content: The enhanced log collection session RFC 3339 timestamp that the device
reports for the last session status change. The device returns an empty string
if there's no session status to report.
examples:
- title: Status item example
files:
- file: examples/declarative/status/enhanced-logging.timestamp/example1.json
declarative/status/management.client-capabilities.yaml
+20 -16
View File
@@ -1,5 +1,5 @@
title: Status Management Client Capabilities
description: A status report of the client's protocol capabilities.
description: The status item that reports the devices's protocol capabilities.
payload:
statusitemtype: management.client-capabilities
supportedOS:
@@ -56,17 +56,17 @@ payloadkeys:
subkeytype: Capabilities
subkeys:
- key: supported-versions
title: Supported Protocol Versions
title: Supported protocol versions
type: <array>
presence: required
content: A list of protocol versions that the client supports.
subkeys:
- key: _supported-versions
title: Supported Protocol Version
title: Supported protocol version
type: <string>
content: A protocol version supported by the client.
- key: supported-features
title: Supported Features
title: Supported features
type: <dictionary>
presence: required
content: A set of optional protocol features that the client supports. Each object's
@@ -78,67 +78,71 @@ payloadkeys:
presence: optional
content: Optional protocol features supported by the client.
- key: supported-payloads
title: Supported Payloads
title: Supported payloads
type: <dictionary>
presence: required
content: A set of declaration and status items that the client supports.
subkeys:
- key: declarations
title: Supported Declarations
title: Supported declarations
type: <dictionary>
presence: required
content: A set of declarations that the client supports.
subkeys:
- key: activations
title: Supported Activations
title: Supported activations
type: <array>
presence: optional
content: An array of strings that represents the activation types that the
client supports.
subkeys:
- key: _activations
title: Activation Type
title: Activation type
type: <string>
content: Supported activation type.
- key: assets
title: Supported Assets
title: Supported assets
type: <array>
presence: optional
content: An array of strings that represents the assets that the client supports.
subkeys:
- key: _assets
title: Asset Type
title: Asset type
type: <string>
content: Supported asset type.
- key: configurations
title: Supported Configurations
title: Supported configurations
type: <array>
presence: optional
content: An array of strings that represents the configuration types that
the client supports.
subkeys:
- key: _configurations
title: Configuration Type
title: Configuration type
type: <string>
content: Supported configuration type.
- key: management
title: Supported Management Declarations
title: Supported management declarations
type: <array>
presence: optional
content: An array of strings that represents the declaration types that the
client supports.
subkeys:
- key: _management
title: Management Declaration Type
title: Management declaration type
type: <string>
content: Supported management declaration type.
- key: status-items
title: Supported Status Items
title: Supported status items
type: <array>
presence: required
content: A list of status items that the client supports.
subkeys:
- key: _status_items
title: Status Item
title: Status item
type: <string>
content: Supported status item.
examples:
- title: Status item example
files:
- file: examples/declarative/status/management.client-capabilities/example1.json
declarative/status/management.declarations.yaml
+17 -13
View File
@@ -1,5 +1,5 @@
title: Status Management Declarations
description: A status report of the client's processed declarations.
description: The status item that reports the device's processed declarations.
payload:
statusitemtype: management.declarations
supportedOS:
@@ -61,7 +61,7 @@ payloadkeys:
subkeytype: Declaration
subkeys:
- key: _activations
title: Status Declaration Item
title: Status declaration item
type: <dictionary>
content: Status for a declaration processed by the client.
subkeytype: Declaration
@@ -72,17 +72,17 @@ payloadkeys:
presence: required
content: The `identifier` of the declaration this status report refers to.
- key: server-token
title: Server-Token
title: Server-token
type: <string>
presence: required
content: The `ServerToken` of the declaration this status report refers to.
- key: active
title: Declaration's Active State
title: Declaration's active state
type: <boolean>
presence: required
content: If `true`, the declaration is active on the device.
- key: valid
title: Declaration's Valid State
title: Declaration's valid state
type: <string>
presence: required
rangelist:
@@ -92,30 +92,30 @@ payloadkeys:
content: This string defines the validity of the declaration. If it's `invalid`,
the `reasons` property contains more details.
- key: reasons
title: Status Reasons
title: Status reasons
type: <array>
presence: optional
content: The details of any client errors.
subkeytype: StatusReason
subkeys:
- key: _reasons
title: Status Reason
title: Status reason
type: <dictionary>
content: Information about a status error.
subkeytype: StatusReason
subkeys:
- key: code
title: Error Code
title: Error code
type: <string>
presence: required
content: The error code for this error.
- key: description
title: Error Description
title: Error description
type: <string>
presence: optional
content: The description for this error.
- key: details
title: Error Details
title: Error details
type: <dictionary>
presence: optional
content: A dictionary that contains further details about this error.
@@ -133,7 +133,7 @@ payloadkeys:
subkeytype: Declaration
subkeys:
- key: _configurations
title: Status Declaration Item
title: Status declaration item
type: <dictionary>
content: Status for a declaration processed by the client.
subkeytype: Declaration
@@ -146,7 +146,7 @@ payloadkeys:
subkeytype: Declaration
subkeys:
- key: _assets
title: Status Declaration Item
title: Status declaration item
type: <dictionary>
content: Status for a declaration processed by the client.
subkeytype: Declaration
@@ -160,7 +160,7 @@ payloadkeys:
subkeytype: Declaration
subkeys:
- key: _management
title: Status Declaration Item
title: Status declaration item
type: <dictionary>
content: Status for a declaration processed by the client.
subkeytype: Declaration
@@ -168,3 +168,7 @@ payloadkeys:
notes:
- title: ''
content: The name of the declaration status item is `management.declarations`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/management.declarations/example1.json
declarative/status/mdm.app.yaml
+14 -4
View File
@@ -1,5 +1,5 @@
title: Status MDM App
description: A status report of the client's MDM-installed apps.
description: The status item that lists the devices's MDM-installed apps.
payload:
statusitemtype: mdm.app
supportedOS:
@@ -43,11 +43,12 @@ payloadkeys:
title: Status item value.
type: <array>
presence: required
content: The list of apps. The response doesn't include apps that are managed by
Declarative Device Management.
content: The list of apps. The response doesn't include apps that Declarative Device
Management manages.
subkeytype: App
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report that contains details about an MDM-installed app.
subkeys:
@@ -75,7 +76,7 @@ payloadkeys:
type: <string>
presence: optional
content: |-
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`.
The app's external version identifier. You can also retrieve this value from the App Store. For more information, see `Apps and books metadata for organizations`.
If the current external version identifier of an app on the App Store doesn't match the external version identifier reported by the device, there may be an app update available for the device.
- key: version
@@ -114,3 +115,12 @@ payloadkeys:
- management-rejected
- failed
content: The status of the app that `ManagedApplicationListCommand` reports.
examples:
- title: Status item example
files:
- tab: New or updated app
description: Reports a new or updated app.
file: examples/declarative/status/mdm.app/example1.json
- tab: Removed app
description: Reports a removed app.
file: examples/declarative/status/mdm.app/example2.json
declarative/status/mdm.enrollment-type.yaml
+67
View File
@@ -0,0 +1,67 @@
title: Status MDM Enrollment Type
description: The status item that reports the device's management enrollment type.
payload:
statusitemtype: mdm.enrollment-type
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
- user
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- user
allowed-scopes:
- system
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
payloadkeys:
- key: mdm.enrollment-type
title: Status item value.
type: <string>
presence: required
rangelist:
- none
- supervised
- device
- user
content: |-
The device management enrollment type that indicates how the device is enrolled, which has the following possible values:
- `none`: Device isn't enrolled
- `supervised`: Device is supervised
- `device`: Device enrollment
- `user`: User enrollment
examples:
- title: Status item example
files:
- file: examples/declarative/status/mdm.enrollment-type/example1.json
declarative/status/mdm.is-awaiting-configuration.yaml
+53
View File
@@ -0,0 +1,53 @@
title: Status MDM Is Awaiting Configuration
description: The status item that reports the device management awaiting configuration
state.
payload:
statusitemtype: mdm.is-awaiting-configuration
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
- user
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- user
allowed-scopes:
- system
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:
- key: mdm.is-awaiting-configuration
title: Status item value.
type: <boolean>
presence: required
content: If `true`, the device is awaiting configuration from the MDM server.
examples:
- title: Status item example
files:
- file: examples/declarative/status/mdm.is-awaiting-configuration/example1.json
declarative/status/mdm.is-return-to-service.yaml
+43
View File
@@ -0,0 +1,43 @@
title: Status MDM Is Return to Service
description: The status item that reports the device's return to service with app
preservation state.
payload:
statusitemtype: mdm.is-return-to-service
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
- user
macOS:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
watchOS:
introduced: n/a
payloadkeys:
- key: mdm.is-return-to-service
title: Status item value.
type: <boolean>
presence: required
content: If `true`, the device is using the return to service with app preservation
mode.
examples:
- title: Status item example
files:
- file: examples/declarative/status/mdm.is-return-to-service/example1.json
declarative/status/mdm.is-shared-ipad.yaml
+35
View File
@@ -0,0 +1,35 @@
title: Status MDM Is Shared iPad
description: The status item that reports the device's Shared iPad state.
payload:
statusitemtype: mdm.is-shared-ipad
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
- user
macOS:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
payloadkeys:
- key: mdm.is-shared-ipad
title: Status item value.
type: <boolean>
presence: required
content: If `true`, the device is a Shared iPad.
examples:
- title: Status item example
files:
- file: examples/declarative/status/mdm.is-shared-ipad/example1.json
declarative/status/mdm.push-magic.yaml
+57
View File
@@ -0,0 +1,57 @@
title: Status MDM Push Magic
description: The status item that reports the device's push magic value.
payload:
statusitemtype: mdm.push-magic
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
- user
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- user
allowed-scopes:
- system
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
payloadkeys:
- key: mdm.push-magic
title: Status item value.
type: <string>
presence: required
content: The push magic value that the device expects the MDM server to include
in Apple Push Notification service messages.
examples:
- title: Status item example
files:
- file: examples/declarative/status/mdm.push-magic/example1.json
declarative/status/mdm.push-token.yaml
+57
View File
@@ -0,0 +1,57 @@
title: Status MDM Push Token
description: The status item that reports the device's push token.
payload:
statusitemtype: mdm.push-token
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
- user
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- user
allowed-scopes:
- system
- user
tvOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
allowed-scopes:
- system
visionOS:
introduced: '27.0'
allowed-enrollments:
- supervised
- device
- user
allowed-scopes:
- system
watchOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
payloadkeys:
- key: mdm.push-token
title: Status item value.
type: <data>
presence: required
content: The device push token that the MDM server uses for Apple Push Notification
service messages.
examples:
- title: Status item example
files:
- file: examples/declarative/status/mdm.push-token/example1.json
declarative/status/migration-assistant.report.yaml
+15 -11
View File
@@ -1,5 +1,5 @@
title: Status Migration Assistant Report
description: Reports the status of a completed migration.
description: The status item that reports the state of a completed migration.
payload:
statusitemtype: migration-assistant.report
supportedOS:
@@ -19,59 +19,63 @@ payload:
introduced: n/a
payloadkeys:
- key: migration-assistant.report
title: Migration Assistant Report
title: Migration Assistant report
type: <dictionary>
presence: required
content: The Migration Assistant migration status.
subkeys:
- key: completed-data-size
title: Migration Completed Data Size
title: Migration completed data size
type: <integer>
presence: optional
content: The total amount of data the system successfully migrated from the source
system.
- key: completed-file-count
title: Migration Completed File Count
title: Migration completed file count
type: <integer>
presence: optional
content: The number of files successfully migrated from the source system.
- key: completion-time
title: Migration Completion Time
title: Migration completion time
type: <string>
presence: optional
content: The RFC 3339 timestamp for when the system completed migration.
- key: source-user
title: Migration Source User
title: Migration source user
type: <string>
presence: optional
content: The username of the user that the system migrated from the source system.
- key: start-time
title: Migration Start Time
title: Migration start time
type: <string>
presence: optional
content: The RFC 3339 timestamp for when the system started migration.
- key: target-user
title: Migration Target User
title: Migration target user
type: <string>
presence: optional
content: The username of the target user account on the destination system.
- key: total-data-size
title: Migration Total Data Size
title: Migration total data size
type: <integer>
presence: optional
content: The total amount of data the system considers in scope for migration
from the source system.
- key: total-file-count
title: Migration Total File Count
title: Migration total file count
type: <integer>
presence: optional
content: The number of files the system considers in scope for migration from
the source system.
- key: errors
title: Migration Errors
title: Migration errors
type: <array>
presence: optional
content: The descriptions of migration errors that the system reports.
subkeys:
- key: _errors
type: <string>
examples:
- title: Status item example
files:
- file: examples/declarative/status/migration-assistant.report/example1.json
declarative/status/migration-assistant.state.yaml
+7 -3
View File
@@ -1,5 +1,5 @@
title: Status Migration Assistant State
description: The current migration state of the system.
description: A status item that shows the device's current migration state.
payload:
statusitemtype: migration-assistant.state
supportedOS:
@@ -19,7 +19,7 @@ payload:
introduced: n/a
payloadkeys:
- key: migration-assistant.state
title: Migration Assistant State
title: Migration Assistant state
type: <string>
presence: required
rangelist:
@@ -31,9 +31,13 @@ payloadkeys:
- unknown
content: |-
The current migration state of the system, which has the following possible values:
- `none`: Migration has not started yet or no migration has taken place.
- `none`: Migration hasn't started yet or no migration has taken place.
- `migrating`: Migration is in progress.
- `completed`: Migration has completed successfully.
- `failed`: Migration has failed.
- `cancelled`: The user cancelled migration.
- `unknown`: Migration status is unknown.
examples:
- title: Status item example
files:
- file: examples/declarative/status/migration-assistant.state/example1.json
declarative/status/package.list.yaml
+18 -6
View File
@@ -1,5 +1,5 @@
title: Status Package List
description: The client's declarative packages.
description: The status item that lists the device's declarative packages.
payload:
statusitemtype: package.list
supportedOS:
@@ -26,6 +26,7 @@ payloadkeys:
subkeytype: Package
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A dictionary that describes a declarative package.
subkeys:
@@ -81,7 +82,7 @@ payloadkeys:
- `installed`: The package is installed.
- `failed`: The package install failed.
- key: reasons
title: Status Reasons
title: Status reasons
type: <array>
presence: optional
content: An array that contains additional details about the package state,
@@ -89,23 +90,23 @@ payloadkeys:
subkeytype: StatusReason
subkeys:
- key: _reasons
title: Status Reason
title: Status reason
type: <dictionary>
content: Information about a status error.
subkeytype: StatusReason
subkeys:
- key: code
title: Error Code
title: Error code
type: <string>
presence: required
content: A code for the state.
- key: description
title: Error Description
title: Error description
type: <string>
presence: optional
content: A description of the state.
- key: details
title: Error Details
title: Error details
type: <dictionary>
presence: optional
content: A dictionary that contains additional details about the state.
@@ -120,10 +121,21 @@ reasons:
details:
- key: Timestamp
type: <string>
valuetype: timestamp
description: The RFC 3339 timestamp of the last download failure.
- value: Error.InstallFailed
description: The package install failed.
details:
- key: Timestamp
type: <string>
valuetype: timestamp
description: The RFC 3339 timestamp of the last install failure.
examples:
- title: Status item example
files:
- tab: New or updated package
description: Reports a new or updated package.
file: examples/declarative/status/package.list/example1.json
- tab: Removed package
description: Reports a removed package.
file: examples/declarative/status/package.list/example2.json
declarative/status/passcode.is-compliant.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Passcode Compliance
description: A status report of passcode compliance.
description: The status item that reports the device's passcode compliance.
payload:
statusitemtype: passcode.is-compliant
supportedOS:
@@ -45,3 +45,7 @@ payloadkeys:
on the device. If `false`, the passcode isn't in compliance with one or more passcode
policies set on the device. When there are no passcode policies on the device,
this value `true`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/passcode.is-compliant/example1.json
declarative/status/passcode.is-present.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Passcode Is Present
description: A status report of the passcode on the device.
description: The status item that reports whether the device has a passcode.
payload:
statusitemtype: passcode.is-present
supportedOS:
@@ -46,3 +46,7 @@ payloadkeys:
of the passcode, such as length or number of complex characters, aren't reported.
Instead, use the `passcode.is-compliant` status item to verify that the passcode
complies with all passcode policies set on the device.
examples:
- title: Status item example
files:
- file: examples/declarative/status/passcode.is-present/example1.json
declarative/status/screensharing.connection.group.unresolved-connection.yaml
+16 -6
View File
@@ -1,6 +1,6 @@
title: Status Screen Sharing Connection Group Unresolved Connections
description: Information about connection groups with member connection references
that the system couldn't resolve.
description: The status item that lists connection groups with member connection references
that the device couldn't resolve.
payload:
statusitemtype: screensharing.connection.group.unresolved-connection
supportedOS:
@@ -23,15 +23,16 @@ payload:
introduced: n/a
payloadkeys:
- key: screensharing.connection.group.unresolved-connection
title: Connection Groups status
title: Connection groups status
type: <array>
presence: required
content: A status item that contains an array of unresolved connection groups.
content: The status item that contains an array of unresolved connection groups.
subkeytype: UnresolvedGroup
subkeys:
- key: unresolved_group
title: Unresolved group
type: <dictionary>
content: A status item that contains an unresolved connection group.
content: The status item that contains an unresolved connection group.
subkeys:
- key: identifier
title: Unique identifier of the connection group.
@@ -53,7 +54,16 @@ payloadkeys:
in the group's declaration for the unresolved connections.
subkeys:
- key: ConnectionUUID
title: Connection Unique Identifier
title: Connection unique identifier
type: <string>
content: The unique identifier (i.e., ConnectionUUID) of a connection which
could not be resolved.
examples:
- title: Status item example
files:
- tab: New or updated connection group
description: Reports a new or updated connection group.
file: examples/declarative/status/screensharing.connection.group.unresolved-connection/example1.json
- tab: Removed connection group
description: Reports a removed connection group.
file: examples/declarative/status/screensharing.connection.group.unresolved-connection/example2.json
declarative/status/security.certificate.list.yaml
+16 -6
View File
@@ -1,5 +1,5 @@
title: Status Security Certificate List
description: A status report of the client's managed certificates.
description: The status item that lists the device's managed certificates.
payload:
statusitemtype: security.certificate.list
supportedOS:
@@ -58,8 +58,9 @@ payloadkeys:
subkeytype: Certificate
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of a security certificate.
content: A security certificate.
subkeys:
- key: identifier
title: Unique identifier of the certificate.
@@ -72,8 +73,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the system removed the app and only this key and the `identifier`
key are present in the status item object.
content: If `true`, the system removed the certificate and only this key and
the `identifier` key are present in the status item object.
- key: declaration-identifier
title: Asset declaration identifier.
type: <string>
@@ -86,12 +87,21 @@ payloadkeys:
presence: required
content: The summary of the certificate's subject.
- key: is-identity
title: Is Identity
title: Is identity
type: <boolean>
presence: required
content: If `true`, the certificate is an identity certificate.
- key: data
title: Certificate Data
title: Certificate data
type: <data>
presence: required
content: The certificate data in DER-encoded X.509 format.
examples:
- title: Status item example
files:
- tab: New or updated certificate
description: Reports a new or updated certificate.
file: examples/declarative/status/security.certificate.list/example1.json
- tab: Removed certificate
description: Reports a removed certificate.
file: examples/declarative/status/security.certificate.list/example2.json
declarative/status/security.lockdown-mode.yaml
+39
View File
@@ -0,0 +1,39 @@
title: Status Security Lockdown Mode
description: The status item that reports the device's Lockdown Mode state.
payload:
statusitemtype: security.lockdown-mode
supportedOS:
iOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
sharedipad:
allowed-scopes: []
macOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: '27.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
payloadkeys:
- key: security.lockdown-mode
title: Status item value.
type: <boolean>
presence: required
content: If `true`, indicates that Lockdown Mode is enabled.
examples:
- title: Status item example
files:
- file: examples/declarative/status/security.lockdown-mode/example1.json
declarative/status/services.background-task.yaml
+18 -8
View File
@@ -1,5 +1,5 @@
title: Status Services Background Task
description: A status report of the device's background task details.
description: The status item that reports the device's background task details.
payload:
statusitemtype: services.background-task
supportedOS:
@@ -27,8 +27,9 @@ payloadkeys:
subkeytype: Background Task
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status report of a background task.
content: The status item that reports a background task.
subkeys:
- key: identifier
title: Identifier
@@ -40,8 +41,8 @@ payloadkeys:
type: <boolean>
presence: optional
default: false
content: If `true`, the background task is removed and the status item object
only contains this key and the `identifier` key.
content: If `true`, the system removed the background task and the status item
object only contains this key and the `identifier` key.
- key: code-signature
title: Code signature
type: <string>
@@ -112,7 +113,7 @@ payloadkeys:
presence: required
content: The hash value of the `launchd` `plist` file.
- key: device-management
title: Device Management
title: Device management
supportedOS:
macOS:
introduced: '15.0'
@@ -124,20 +125,29 @@ payloadkeys:
for the task.
subkeys:
- key: configuration-identifier
title: Configuration Identifier
title: Configuration identifier
type: <string>
presence: required
content: The identifier of the `ServicesBackgroundTasks` configuration that
created this task.
- key: asset-identifier
title: Asset Identifier
title: Asset identifier
type: <string>
presence: required
content: The `Identifier` of the declaration asset that provided the launchd
plist for this task.
- key: asset-server-token
title: Asset Server Token
title: Asset server token
type: <string>
presence: required
content: The `ServerToken` of the declaration asset that provided the launchd
plist for this task.
examples:
- title: Status item example
files:
- tab: New or updated task
description: Reports a new or updated background task.
file: examples/declarative/status/services.background-task/example1.json
- tab: Removed task
description: Reports a removed background task.
file: examples/declarative/status/services.background-task/example2.json
declarative/status/softwareupdate.beta-enrollment.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Software Update Beta Enrollment
description: A status report of the device's enrolled beta program.
description: The status item that reports the device's enrolled beta program.
payload:
statusitemtype: softwareupdate.beta-enrollment
supportedOS:
@@ -32,3 +32,7 @@ payloadkeys:
presence: required
content: The device's enrolled beta program name, or an empty string if there's
no enrolled beta program.
examples:
- title: Status item example
files:
- file: examples/declarative/status/softwareupdate.beta-enrollment/example1.json
declarative/status/softwareupdate.device-id.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Software Update Device ID
description: A status report of the device's update device ID.
description: The status item that reports the device's software update device ID.
payload:
statusitemtype: softwareupdate.device-id
supportedOS:
@@ -42,3 +42,7 @@ payloadkeys:
presence: required
content: The device identifier to use when looking up available software updates
via `https://gdmf.apple.com/v2/pmv`.
examples:
- title: Status item example
files:
- file: examples/declarative/status/softwareupdate.device-id/example1.json
declarative/status/softwareupdate.failure-reason.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Software Update Failure Reason
description: A status report of a software update failure reason.
description: The status item that reports the device's software update failure reason.
payload:
statusitemtype: softwareupdate.failure-reason
supportedOS:
@@ -62,3 +62,7 @@ payloadkeys:
content: If present, this is the RFC 3339 timestamp of the last software update
failure. This key isn't present if there are no failures or no pending software
update.
examples:
- title: Status item example
files:
- file: examples/declarative/status/softwareupdate.failure-reason/example1.json
declarative/status/softwareupdate.install-reason.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Software Update Install Reason
description: A status report of the reason for a pending software update on the device.
description: The status item that reports the device's pending software update reason.
payload:
statusitemtype: softwareupdate.install-reason
supportedOS:
@@ -80,3 +80,7 @@ payloadkeys:
content: The identifier of the declaration that caused the software update to
occur. This key is present only if the `reason` array contains the `declaration`
value.
examples:
- title: Status item example
files:
- file: examples/declarative/status/softwareupdate.install-reason/example1.json
declarative/status/softwareupdate.install-state.yaml
+5 -2
View File
@@ -1,5 +1,5 @@
title: Status Software Update Install State
description: A status report of the software update install state.
description: The status item that reports the device's software update install state.
payload:
statusitemtype: softwareupdate.install-state
supportedOS:
@@ -50,8 +50,11 @@ payloadkeys:
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.
- `prepared`: The system prepared the software update and it's ready for installation.
- `installing`: The system is installing the software update.
- `failed`: The software update failed.
examples:
- title: Status item example
files:
- file: examples/declarative/status/softwareupdate.install-state/example1.json
declarative/status/softwareupdate.pending-version.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
title: Status Software Update Pending Version
description: A status report of the pending software update version.
description: The status item that reports the device's pending software update version.
payload:
statusitemtype: softwareupdate.pending-version
supportedOS:
@@ -63,3 +63,7 @@ payloadkeys:
content: The local date time value that indicates when the pending software update
will be installed. This key is only present when the pending software update
is being enforced.
examples:
- title: Status item example
files:
- file: examples/declarative/status/softwareupdate.pending-version/example1.json
declarative/status/statusreason.yaml
+7 -3
View File
@@ -15,17 +15,17 @@ payload:
introduced: '10.0'
payloadkeys:
- key: code
title: Error Code
title: Error code
type: <string>
presence: required
content: The error code for this error.
- key: description
title: Error Description
title: Error description
type: <string>
presence: optional
content: A description of this error.
- key: details
title: Error Details
title: Error details
type: <dictionary>
presence: optional
content: A dictionary that contains additional details about the error.
@@ -33,3 +33,7 @@ notes:
- title: ''
content: Each status item defines its own set of `code`, `description`, and `details`
values.
examples:
- title: Status item example
files:
- file: examples/declarative/status/statusreason/example1.json
declarative/status/test.array-value.yaml
+7 -2
View File
@@ -58,16 +58,21 @@ payloadkeys:
subkeytype: Array
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: A status value for the test status item array.
subkeys:
- key: key1
title: First Key Value
title: First key value
type: <string>
presence: required
content: The value of the first sub-key.
- key: key2
title: Second Key Value
title: Second key value
type: <string>
presence: optional
content: The value of the second sub-key.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.array-value/example1.json
declarative/status/test.boolean-value.yaml
+4
View File
@@ -55,3 +55,7 @@ payloadkeys:
type: <boolean>
presence: required
content: The test status Boolean value.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.boolean-value/example1.json
declarative/status/test.dictionary-value.yaml
+6 -2
View File
@@ -58,12 +58,16 @@ payloadkeys:
subkeytype: Dictionary
subkeys:
- key: key1
title: First Key Value
title: First key value
type: <string>
presence: required
content: The value of the first sub-key.
- key: key2
title: Second Key Value
title: Second key value
type: <string>
presence: optional
content: The value of the second sub-key.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.dictionary-value/example1.json
declarative/status/test.error-value.yaml
+4
View File
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The test status error value.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.error-value/example1.json
declarative/status/test.integer-value.yaml
+4
View File
@@ -55,3 +55,7 @@ payloadkeys:
type: <integer>
presence: required
content: The test status integer value.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.integer-value/example1.json
declarative/status/test.real-value.yaml
+4
View File
@@ -55,3 +55,7 @@ payloadkeys:
type: <real>
presence: required
content: The test status real value.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.real-value/example1.json
declarative/status/test.string-value.yaml
+4
View File
@@ -55,3 +55,7 @@ payloadkeys:
type: <string>
presence: required
content: The test status string value.
examples:
- title: Status item example
files:
- file: examples/declarative/status/test.string-value/example1.json