PayloadKit

Contacts

com.apple.carddav.account

The payload that configures a Contacts account.

iOS 4.0+macOS 10.7+visionOS 1.1+
Apple schemacombined

macOS: user channel only

Configuration Keys (9)

Showing 9 of 9 keys

KeyTypeDescriptionDefaultRange

Account description

macOS 10.7+

stringThe description of the account.Default: "My Contacts Account"Range: —

Account hostname

macOS 10.7+

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

Port number

macOS 10.7+

integerThe server's port.Default: 443Range: 0 – 65535

Principal URL

not on macOS

stringThe base URL to the user's address book.Default: —Range: —

Account username

macOS 10.7+

stringThe user name for logins.

Depends on:

Default: —Range: —

Account password

macOS 10.7+

stringThe user's password. Only use this in encrypted profiles.Default: —Range: —

Use SSL

macOS 10.7+

booleanIf 'true', the system enables SSL.Default: trueRange: —

Communication service rules

iOS 10.0+ · not on macOS

dictAn array of communication service rules for this account.Default: —Range: —

Default service handlers

iOS 10.0+ · not on macOS

dictA dictionary of service handlers for contacts from this account.Default: —Range: —
AudioCallstring

App for audio calls

iOS 10.0+ · not on macOS

stringThe bundle identifier for the default application that handles audio calls to contacts from this account.Default: —Range: —
VPNUUIDstring

VPNUUID

iOS 14.0+ · not on macOS

stringThe VPNUUID of the per-app VPN the account uses for network communication.Default: —Range: —