Contents

Desktop

The payload that configures the desktop wallpaper.

Declaration

object Desktop

Properties

NameTypeDescription
lockedboolean

If true, locks the desktop picture. Replaced with allowWallpaperModification in macOS 10.13.

override-picture-pathstring

The path to the desktop picture. If set, this picture is always locked.

Discussion

Specify com.apple.desktop as the payload type.

Profile availability

Device channel

macOS

User channel

macOS

Allow manual install

macOS

Requires supervision

NA

Requires user-approved MDM

NA

Allowed in user enrollment

NA

Allow multiple payloads

NA

Profile example

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>PayloadContent</key>
    <array>
        <dict>
            <key>locked</key>
            <true/>
            <key>override-picture-path</key>
            <string>~/Desktop/background.png</string>
            <key>PayloadIdentifier</key>
            <string>com.example.mydesktoppayload</string>
            <key>PayloadType</key>
            <string>com.apple.desktop</string>
            <key>PayloadUUID</key>
            <string>77a7ad50-9e32-4afb-8aee-79ae0c392848</string>
            <key>PayloadVersion</key>
            <integer>1</integer>
        </dict>
    </array>
    <key>PayloadDisplayName</key>
    <string>Desktop</string>
    <key>PayloadIdentifier</key>
    <string>com.example.myprofile</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>2e00699a-8e37-417d-94b2-97b85ff722a2</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
</dict>
</plist>

See Also

User Experience