PayloadKit

macOS Server Account

com.apple.osxserver.account

The payload that configures a macOS Server account.

iOS 9.0+ · removed 12.0
Apple schemacombined

Not available with User Enrollment

Configuration Keys (5)

KeyTypeDescriptionDefaultRange

Account description

required
stringThe description of the account.Default: "My macOS Server Account"Range: —
HostNamestring

Account hostname

required
stringThe server's address.Default: —Range: —
UserNamestring

Account username

required
stringThe user's user name.Default: —Range: —
Passwordstring

Account password

stringThe user's password.Default: —Range: —

Configured accounts

required
arrayAn array of dictionaries containing configured account types and relevant settingsDefault: —Range: — – 1

Configured account

dictConfigured account type and relevant settingsDefault: —Range: —
Typestring

Account type

required
stringcom.apple.osxserver.documents (the Documents account type).Default: "com.apple.osxserver.documents"Range: com.apple.osxserver.documents
Portinteger

Port number

integerDesignates the port number to use when contacting the server. If no port number is specified, the default port is used.Default: 8071Range: 0 – 65535