PayloadKit

Login Window

com.apple.loginwindow

The payload that configures Login Window behavior.

macOS 10.7+
Apple schemacombined

Not available with User Enrollment · macOS: device channel only

Configuration Keys (39)

Showing 39 of 39 keys

KeyTypeDescriptionDefaultRange
string—Default: —Range: —

Show additional information in the menu bar

stringThe admin host info. If present in the payload, the system displays its value in the Login Window as additional computer information. Before macOS 10.10, this string could only contain host name, system version, or IP address. After macOS 10.10, setting this key to any value allows the user to click the time area of the menu bar to toggle through various computer information values.Default: "HostName"Range: HostName, SystemVersion, IPAddress

Banner

stringThe text to display in the Login Window.Default: —Range: —

Display login window as

booleanIf 'true', the system shows the name and password dialog. If 'false', the system displays a list of users.Default: falseRange: —

Show local users

booleanIf 'true', the system shows only network and system users when showing a user list.Default: falseRange: —

Show mobile accounts

booleanIf 'true', the system hides mobile account users in a user list. In some cases, mobile users show up as network users.Default: falseRange: —

Show network users

booleanIf 'true', the system shows network users when showing a user list.Default: falseRange: —

Show Mac computer's administrator accounts

booleanIf 'true', the system hides administrator users when showing a user list.Default: falseRange: —

Show "Other"

booleanIf 'true', the system displays "Other..." when it shows a list of users.Default: falseRange: —

Show the Sleep button

booleanIf 'true', the system disables the Sleep button.Default: falseRange: —

Show the Restart button

booleanIf 'true', the system disables the Restart item.Default: falseRange: —

Show the Shut Down button

booleanIf 'true', the system disables the Shut Down button.Default: falseRange: —

Disable the Restart menu item while logged in

booleanIf 'true', the system disables the Restart menu item when the user is logged in.Default: falseRange: —

Disable the Shut Down menu item while logged in

booleanIf 'true', the system disables the Shut Down menu item when the user is logged in.Default: falseRange: —

Disable the Power Off menu item while logged in

booleanIf 'true', the system disables the Power Off menu item when the user is logged in.Default: falseRange: —

Disable the Log Out menu item while logged in

macOS 10.13+

booleanIf 'true', the system disables the Log Out menu item when the user is logged in.Default: falseRange: —

Disable the immediate Screen Lock function

macOS 10.13+

booleanIf 'true', the system disables the immediate Screen Lock functions.Default: falseRange: —

Disable automatic login if FileVault is disabled

booleanA loginwindow password will be required to login.Default: trueRange: —

macOS 14.0+

stringThe user short name for an existing user to set up auto login.Default: —Range: —

macOS 14.0+

stringAn optional user password to set up auto login. This must match the 'AutologinUsername' user's current password.Default: —Range: —

Disable automatic login if FileVault is enabled

macOS 10.9+

booleanIf 'true', the system disables the automatic login option when using FileVault.Default: falseRange: —

Enable >console login

booleanIf 'true', the system disregards the '>console' special user name, which provides a command line UI.Default: falseRange: —

Enable external accounts

booleanAllows external accounts to log in.Default: trueRange: —

Mac computer administrators may refresh content or disable management

booleanIf 'true', a local administrator user can bypass or disable managed preferences (MCX settings) for their login session. The device presents the user with this option at login only when the user is a local administrator, and other users are not logged in.Default: falseRange: —

Reopen windows when logging back in

booleanReopens windows that were open at time of logoutDefault: trueRange: —

Set Mac computer name to computer record name

booleanForces the name of the Mac to be set as the computer record name.Default: trueRange: —

Allowed Users or Groups

arrayThe list of user GUIDs or group GUIDs of users that the system allows to log in. An asterisk ('*') string specifies all users or groups. This only applies to network accounts and mobile accounts.Default: —Range: —

User or Group GUID

required
stringA user or group GUID.Default: —Range: —

Denied Users or Groups

arrayThe list of user GUIDs or group GUIDs of users that the system disallows to log in. This list takes priority over the list in the 'AllowList' key. This only applies to network accounts and mobile accounts.Default: —Range: —

User or Group GUID

required
stringA user or group GUID.Default: —Range: —

Local-only users may log in

booleanPermit only local users to log in. Network users won't be allowed to log in.Default: —Range: —

Local-only users use available workgroup settings

booleanLocal users are forced to use any available workgroup settings.Default: —Range: —

Ignore workgroup nesting

booleanIf users are part of a nested workgroup, only the settings of the user's workgroup are enforced.Default: —Range: —

Combine available workgroup settings

booleanIf users are part of a nested workgroup, all nested workgroup settings are enforced.Default: —Range: —

Always show workgroup dialog during log in

booleanIf the workgroup has a specific dialog, that dialog is shown when users log in.Default: —Range: —

Allow user to change password

booleanEnable or disable the "Change Password…" button in the Users & Groups preference pane.Default: —Range: —

Show password hints after failed attempts

integerIf specified, allows a certain number of retries until the device shows a password hint. The device shows no hints if set to a value of 0.Default: 0Range: —

Show input menu in login window

macOS 10.8+

booleanIf 'true', the system shows the Input Menu in the Login Window.Default: falseRange: —

Hidden Users List

arrayHides users defined in the list from the login window under the Other buttonDefault: —Range: —
usernamestring

Username

string—Default: —Range: —

Enable WiFi network selection for login and unlock

macOS 27.0+

booleanIf 'true', the system allows the user to select WiFi networks at login or unlock.Default: falseRange: —

Enable captive WiFi portal for login and unlock

macOS 27.0+

booleanIf 'true', the system allows use of the captive WiFi portal at login or unlock.Default: falseRange: —