Profile-Specific Payload Keys

Use the appropriate payload for your configuration needs.

Overview

In addition to the standard payload keys (described in Define a Profile) each payload can contain keys specific to a payload type. These payload specific keys are described in detail, below.

Topics

Top Level

object TopLevel

The top-level payload properties for configuring all profiles.

Accounts

object Accounts

The payload for configuring guest accounts.

object CalDAV

The payload for configuring a Calendar account. 

object CardDAV

The payload for configuring a Contacts account.

object GoogleAccount

The payload for configuring a Google account.

object LDAP

The payload for configuring an LDAP account.

object MobileAccounts

The payload for configuring mobile accounts on the device.

object SubscribedCalendars

The payload for configuring subscribed calendars.

AirPlay

object AirPlay

The payload for configuring AirPlay settings. 

object AirPlaySecurity

The payload for configuring Apple TV for a particular style of AirPlay Security.

App Management

object AppLock

The payload for configuring a device to run a single app.

object AssociatedDomains

The payload for configuring associated domains.

Beta
object AutonomousSingleAppMode

The payload for configuring Autonomous Single App mode. 

object NSExtensionManagement

The payload for configuring the extensions allowed to run on the device.

App Store

object AppStore

The payload for configuring macOS App Store restrictions. 

Apple TV

object ConferenceRoomDisplay

The payload for configuring Conference Room Display mode for Apple TV.

object TVRemote

The payload for configuring the Apple TV remote.

Authentication

object DirectoryService

The payload for configuring an Active Directory (AD) domain. 

object ExtensibleSingleSignOn

The payload for configuring an app extension that performs single sign-on.

Beta
object ExtensibleSingleSignOnKerberos

The payload for configuring an app extension that performs single sign-on with the Kerberos extension.

Beta
object Identification

The payload for configuring the names of the account user. 

object IdentityPreference

The payload for configuring the user's identity on the device.

object SingleSignOn

The payload for configuring single sign-on.

Certificates

object CertificatePEM

The payload for configuring a PEM-formatted certificate.

object CertificatePKCS1

The payload for configuring a PKCS #1-formatted certificate.

object CertificatePKCS12

The payload for configuring a PKCS #12-formatted certificate.

object CertificateRoot

The payload for configuring a root certificate.

object ActiveDirectoryCertificate

The payload for configuring Active Directory Certificate settings.

object CertificatePreference

The payload for configuring a certificate preference.

object CertificateTransparency

The payload for configuring certificate transparency enforcement.

object SCEP

The payload for configuring Simple Certificate Enrollment Protocol (SCEP).

Ethernet

type 8021XFirstActiveEthernet

The payload for configuring the first wired, active Ethernet interface.

type 8021XFirstEthernet

The payload for configuring the first wired Ethernet interface.

type 8021XGlobalEthernet

The payload for configuring the default fallback global Ethernet interface.

type 8021XSecondActiveEthernet

The payload for configuring the second wired, active Ethernet interface.

type 8021XSecondEthernet

The payload for configuring the second wired Ethernet interface.

type 8021XThirdActiveEthernet

The payload for configuring the third wired, active Ethernet interface.

type 8021XThirdEthernet

The payload for configuring the third wired Ethernet interface.

Full Disk Encryption

object FDEFileVault

The payload for configuring FileVault. 

object FDERecoveryKeyEscrow

The payload for configuring FileVault recovery key escrow.

Login

object LoginItemsManagedItems

The payload for configuring a device's login items.

object LoginItemsNetworkSharePoint

The payload for configuring login behavior.

object LoginWindow

The payload for configuring login window behavior.

object LoginWindowScripts

The payload for configuring scripts to run at login and logout.

Mail

object ExchangeActiveSync

The payload for configuring Exchange ActiveSync accounts. 

object ExchangeWebServices

The payload for configuring an Exchange Web Services account for Contacts, Mail, Notes, Reminders, and Calendar.

object Mail

The payload for configuring a mail account on the device.

Managed Devices

object EducationConfiguration

The payload for configuring the users, groups, and departments within an educational organization.

object ManagedPreferences

The payload for configuring managed preferences.

object MDM

The payload for configuring Mobile Device Management (MDM) settings.

Media Management

object MediaManagementAllowedMedia

The payload for configuring media management.

object MediaManagementDiscBurning

The payload for configuring disc-burning settings.

Networking

object Cellular

The payload for configuring cellular settings.

object ContentCaching

The payload for configuring the content-caching service.

object Domains

The payload for configuring the domains under an organization's management. 

object Firewall

The payload for configuring the firewall.

object NetworkUsageRules

The payload for configuring network-usage rules.

object WiFi

The payload for configuring WiFi on the device.

Parental Controls

object ParentalControlsApplicationRestrictions

The payload for configuring parental controls for apps.

object ParentalControlsContentFilter

The payload for configuring the parental control web content filters.

object ParentalControlsDictionary

The payload for configuring parental control dictionary restrictions.

object ParentalControlsGameCenter

The payload for configuring Game Center parental controls.

object ParentalControlsTimeLimits

The payload for configuring parental control time limits.

Preferences

object GlobalPreferences

The payload for configuring global preferences.

object SystemPreferences

The payload for configuring the preference panes.

object UserPreferences

The payload for configuring iCloud password preferences.

Printing

object AirPrint

The payload for configuring AirPrint printers in the user's printer list.

object Printing

The payload for configuring printers.

Privacy

object PrivacyPreferencesPolicyControl

The payload for configuring privacy preferences.

Proxies

object DNSProxy

The payload for configuring DNS proxies.

object GlobalHTTPProxy

The payload for configuring a global HTTP proxy.

object NetworkProxyConfiguration

The payload for configuring network proxies for a device.

Restrictions

object Restrictions

The payload for configuring restrictions on a device.

Security

object Passcode

The payload for configuring a passcode policy.

object ProfileRemovalPassword

The payload for configuring the password for profile removal.

object SecurityPreferences

The payload for configuring security preferences.

object SmartCard

The payload for configuring a smart card.

System Configuration

object EnergySaver

The payload for configuring energy-saver settings. 

object Font

The payload for configuring fonts.

object LockScreenMessage

The payload for configuring a lock-screen message.

object Screensaver

The payload for configuring the screen saver.

object SystemExtensions

The payload for configuring system extensions.

Beta
object SystemLogging

The payload for configuring system logging.

object TimeServer

The payload for configuring the time server.

System Policy

object SystemPolicyControl

The payload for configuring the system policy for assessments.

object SystemPolicyKernelExtensions

The payload for configuring the kernel extension policies.

object SystemPolicyManaged

The payload for configuring the Finder's contextual menu to bypass the system policy.

object SystemPolicyRule

The payload for configuring the system policy.

System Updates

object SoftwareUpdate

The payload for configuring the software update policy.

object SystemMigration

The payload for configuring system migration.

User Experience

object Accessibility

The payload for configuring the accessibility features of the device.

object Desktop

The payload for configuring the desktop.

object Dock

The payload for configuring the dock. 

object Finder

The payload for configuring Finder settings.

object HomeScreenLayout

The payload for configuring the Home screen layout. 

object ManagedMenuExtras

The payload for configuring menu extras.

object Notifications

The payload for configuring notifications.

object ScreensaverUser

The payload for configuring a user's screen-saver settings.

object SetupAssistant

The payload for configuring setup-assistant settings.

object TimeMachine

The payload for configuring Time Machine.

VPN

object AppLayerVPN

The payload for configuring add-on VPN software.

object AppToAppLayerVPNMapping

The payload for configuring per-app VPN settings.

object VPN

The payload for configuring a VPN.

Web

object WebClip

The profile for configuring web clips on the device.

object WebContentFilter

The payload for configuring web content filters. 

Xsan

object Xsan

The payload for configuring an Xsan client system.

object XsanPreferences

The payload for configuring the Xsan preferences that define the volumes that automatically mount at startup.

Deprecated

object AIMAccount

The payload for configuring an AIM account on the device.

Deprecated
object APN

The payload for configuring access point names. 

Deprecated
object FDERecoveryKeyRedirection

The payload for configuring FileVault recovery key redirection.

Deprecated
object JabberAccount

The payload for configuring a Jabber account. 

Deprecated
object MacOSServerAccount

The payload for configuring a macOS server account.

Deprecated
object ParentalControlsDashboardWidgetRestrictions

The payload for configuring the parental control dashboard whitelist.

Deprecated
object ParentalControlDictationAndProfanity

The payload for configuring parental control for dictation and profanity.

Deprecated
object ShareKit

The payload for configuring ShareKit.

Deprecated

See Also

Configuration Profiles

Using Configuration Profiles

Create and deploy configuration profiles to users within your organization.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software