PayloadKit

Screensaver

com.apple.screensaver

The payload that configures the screen saver.

macOS 10.11+
Apple schemaexclusive

Not available with User Enrollment · Only one instance per profile · macOS: device channel only

Configuration Keys (5)

KeyTypeDescriptionDefaultRange

Require password to unlock screen.

macOS 10.13+

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

Depends on: askForPasswordDelay

Default: falseRange: —

Require password delay

macOS 10.13+

integerThe number of seconds to delay before the device requires a password 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' immediately requires the password. To use this option, you must set 'askForPassword' to 'true'.

Depends on: askForPassword ∈ [true]

Default: 0Range: —

Screensaver path

stringThe full path to the screen-saver module to use.Default: —Range: —
idleTimeinteger

Screensaver idle time

integerThe number of seconds of inactivity before the screen saver activates (0 = Never activate).Default: 300Range: —

Screensaver Module Name

required
stringThe name of the screen saver module.Default: "Flurry"Range: —