Contents

Screensaver

The payload that configures the screen saver.

Declaration

object Screensaver

Properties

NameTypeDescription
askForPasswordboolean

If true, the user is prompted for a password when the screen saver is unlocked or stopped. When you use this prompt, you must also provide askForPasswordDelay.

Available: macOS 10.13+

askForPasswordDelayinteger

The number of seconds to delay before the password will be required to unlock or stop the screen saver (the grace period). A value of 2147483647 (hexadecimal equivalent of 0x7FFFFFFF) disables this requirement, and a value of 0 can be used to immediately require the password. To use this option, you must set askForPassword to true.

Available: macOS 10.13+

idleTimeinteger

The number of seconds of inactivity before the screen saver activates (0 = Never activate).

loginWindowModulePathstring

The full path to the screen-saver module to use.

moduleName Requiredstring

The name of the screen saver module.

Discussion

Specify com.apple.screensaver as the payload type.

Profile availability

Device channel

macOS

User channel

N/A

Allow manual install

macOS

Requires supervision

N/A

Requires user-approved MDM

N/A

Allowed in user enrollment

N/A

Allow multiple payloads

N/A

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>idleTime</key>
            <integer>60</integer>
            <key>loginWindowIdleTime</key>
            <integer>60</integer>
            <key>loginWindowModulePath</key>
            <string>/System/Library/Screen Savers/Example-Name.saver</string>
            <key>moduleName</key>
            <string>Example Name</string>
            <key>askForPassword</key>
            <true/>
            <key>askForPasswordDelay</key>
            <integer>5</integer>
            <key>PayloadIdentifier</key>
            <string>com.example.myscreensaverpayload</string>
            <key>PayloadType</key>
            <string>com.apple.screensaver</string>
            <key>PayloadUUID</key>
            <string>ba9abec1-ee44-413d-b75f-63748644ca71</string>
            <key>PayloadVersion</key>
            <integer>1</integer>
        </dict>
    </array>
    <key>PayloadDisplayName</key>
    <string>Screen Saver Device</string>
    <key>PayloadIdentifier</key>
    <string>com.example.myprofile</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>4ffe721a-f2e6-4191-a3fe-1d1a463fbbac</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
</dict>
</plist>

See Also

System configuration