LockScreenMessage

The payload that configures a Lock Screen message.

Declaration

object LockScreenMessage

Properties

Name	Type	Description
`AssetTagInformation`	string	The asset tag information for the device, displayed in the Login Window and Lock Screen.
`IfLostReturnToMessage`	string	Deprecated. Use `LockScreenFootnote` instead.
`LockScreenFootnote`	string	The footnote displayed in the Login Window and Lock Screen.

Discussion

Specify com.apple.shareddeviceconfiguration as the payload type.

This payload allows administrators to specify optional text displayed in the Login Window and Lock Screen (for example, an “If Lost, Return To” message and asset tag information). There can only be one Lock Screen payload.

Profile availability


Device channel	iOS, Shared iPad
User channel	NA
Allow manual install	iOS
Requires supervision	iOS
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>AssetTagInformation</key>
            <string>1234</string>
            <key>IfLostReturnToMessage</key>
            <string>Example message</string>
            <key>PayloadIdentifier</key>
            <string>com.example.mylockscreenpayload</string>
            <key>PayloadType</key>
            <string>com.apple.shareddeviceconfiguration</string>
            <key>PayloadUUID</key>
            <string>b10c0436-a51b-4119-b604-bd580f396723</string>
            <key>PayloadVersion</key>
            <integer>1</integer>
        </dict>
    </array>
    <key>PayloadDisplayName</key>
    <string>Lock Screen Message</string>
    <key>PayloadIdentifier</key>
    <string>com.example.myprofile</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>588f1406-47be-47fc-9907-4e7955fb6d4a</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
</dict>
</plist>