Apple Device Policy
Back to Explorer
GitHub YAMLApple Docs

Common Payload Keys (CommonPayloadKeys)

CommonPayloadKeys

The properties common to all payloads.

iOS(4.0)macOS(10.7)tvOS(9.0)visionOS(1.0)watchOS(1.0)
Branch: release

Settings (7)

SettingTypeRequiredDefaultManual InstallSupported OS
PayloadIdentifier
PayloadIdentifier
The reverse-DNS-style identifier for the payload. This identifier is usually the same as the `TopLevel` value, with an additional appended component. This string must be unique within the profile. During a profile replacement, the system updates payloads with the same `PayloadIdentifier` and `PayloadUUID` in the old and new profiles.
stringrequired—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)
PayloadUUID
PayloadUUID
The globally unique identifier for the payload. The actual content is unimportant, but must be globally unique. In macOS, use `uuidgen` to generate UUIDs. During a profile replacement, the system updates payloads with the same `PayloadIdentifier` and `PayloadUUID` in the old and new profiles.
stringrequired—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)
PayloadType
PayloadType
The payload type, which each payload domain's reference page specifies.
stringrequired—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)
PayloadVersion
PayloadVersion
The version of this specific payload.
integerrequired—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)
PayloadDescription
PayloadDescription
The human-readable description of this payload. This description appears on the Detail screen.
stringoptional—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)
PayloadDisplayName
PayloadDisplayName
The human-readable name for the profile payload. The name appears on the Detail screen and doesn't need to be unique.
stringoptional—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)
PayloadOrganization
PayloadOrganization
The human-readable string containing the name of the organization that provides the profile. This value doesn't need to match the organization payload value in the enclosing dictionary.
stringoptional—
✓Yes
iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+)

Apple MDM & DDM Policy Explorer

Explore the full catalogue of Apple Mobile Device Management (MDM) and Declarative Device Management (DDM) policies for macOS and iOS. Search, filter, and reference policy keys for use with Microsoft Intune, Jamf, or any standards-compliant MDM solution.

Reference: policy categories & common keys

Policy categories

  • Configuration Profile
  • Declarative Configuration
  • Declarative Activation
  • Declarative Asset
  • Declarative Management

Common policy keys

  • com.apple.wifi.managed – Wi-Fi network configuration
  • com.apple.vpn.managed – VPN configuration
  • com.apple.applicationaccess – App and feature restrictions
  • com.apple.security.pkcs1 – Certificate (PKCS#1) payload
  • com.apple.security.pkcs12 – Identity certificate (PKCS#12) payload
  • com.apple.security.scep – SCEP certificate enrolment
  • com.apple.mail.managed – Mail account configuration
  • com.apple.eas.account – Exchange ActiveSync account
  • com.apple.MCX – Managed Client (macOS) preferences
  • com.apple.MCX.FileVault2 – FileVault 2 disk encryption
  • com.apple.dock – macOS Dock configuration
  • com.apple.screensaver – Screensaver configuration
  • com.apple.loginwindow – macOS login window configuration
  • com.apple.systempolicy.managed – Gatekeeper / system policy
  • com.apple.systempreferences – System Preferences pane restrictions
  • com.apple.SoftwareUpdate – Software update behaviour
  • com.apple.TCC.configuration-profile-policy – Privacy Preferences Policy Control (PPPC)
  • com.apple.notificationsettings – Per-app notification settings
  • com.apple.webcontent-filter – Web content filter
  • com.apple.dnsSettings.managed – DNS settings (DoH / DoT)
  • com.apple.relay.managed – Network relay configuration
  • com.apple.extensiblesso – Extensible Single Sign-On
  • com.apple.configuration.passcode.settings – DDM: passcode policy
  • com.apple.configuration.softwareupdate.enforcement.specific – DDM: enforced software update
  • com.apple.configuration.services.configuration-files – DDM: service configuration files
  • com.apple.configuration.management.status-subscriptions – DDM: status subscriptions
  • com.apple.activation.simple – DDM: simple activation predicate
  • com.apple.management.organization-info – DDM: organization information