Contents

DeclarativeManagementRequest

The declarative management request details.

Declaration

object DeclarativeManagementRequest

Properties

NameTypeDescription
Datadata

A Base64-encoded JSON object using the SynchronizationTokens schema.

Endpoint Requiredstring

The type of operation the declaration is requesting. This key needs to be one of these values:

  • tokens: For fetching synchronization tokens from the server

  • declaration-items: For fetching the declaration manifest from the server

  • status: For sending a status report to the server

  • declaration/…/…: For fetching a specific declaration from the server. Include the declaration type and identifier separated by slash characters (/).

EnrollmentID Requiredstring

The per-enrollment identifier for the device. The system requires this value if the enrollment type is a user enrollment.

Available: iOS 15+ | iPadOS 15+ | macOS 13+ | visionOS 1.1+

EnrollmentUserID Requiredstring

The per-enrollment identifier for the user. The system requires this value if the enrollment type is a user enrollment on the user channel.

Available: macOS 13+

MessageType Requiredstring

The message type, which requires a value of DeclarativeManagement.

UDID Requiredstring

The device’s UDID (unique device identifier). The system requires this value if the enrollment type is a device enrollment.

UserIDstring

For macOS, this value is the ID of the user.

For Shared iPad, this value is FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF to indicate that authentication doesn’t occur.

Available: iOS 15+ | iPadOS 15+ | macOS 13+

UserLongName Requiredstring

The full name of the user.

Available: macOS 13+

UserShortNamestring

For macOS, this value is the short name of the user.

For Shared iPad, this value is the Managed Apple Account identifier of the user on Shared iPad. It indicates that the token is for the user channel.

Available: iOS 15+ | iPadOS 15+ | macOS 13+

Topics

Declaration Endpoints

Declaration Response