CardDAV (com.apple.carddav.account)

com.apple.carddav.account

The payload that configures a Contacts account.

iOS(4.0)macOS(10.7)visionOS(1.1)
Branch: release

Settings (11)

SettingTypeRequiredDefaultManual InstallSupported OS
Account Description
CardDAVAccountDescription
The description of the account.
stringoptional
Yes
macOS (10.7+)
Account Hostname
CardDAVHostName
The server's address.
stringrequired
Yes
macOS (10.7+)
Account Username
CardDAVUsername
The user name for logins.
stringoptional
Yes
macOS (10.7+)
Account Password
CardDAVPassword
The user's password. Only use this in encrypted profiles.
stringoptional
Yes
macOS (10.7+)
Principal URL
CardDAVPrincipalURL
The base URL to the user's address book.
stringoptional
No
Use SSL
CardDAVUseSSL
If `true`, the system enables SSL.
booleanoptionaltrue
Yes
macOS (10.7+)
Port Number
CardDAVPort
The server's port.
integeroptional
Yes
macOS (10.7+)
Communication Service Rules
CommunicationServiceRules
An array of communication service rules for this account.
1 subkey
dictionaryoptional
Yes
iOS (10.0+)
└─
Default Service Handlers
DefaultServiceHandlers
A dictionary of service handlers for contacts from this account.
1 subkey
dictionaryoptional
Yes
iOS (10.0+)
└─ └─
App for audio calls
AudioCall
The bundle identifier for the default application that handles audio calls to contacts from this account.
stringoptional
Yes
iOS (10.0+)
VPNUUID
VPNUUID
The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later.
stringoptional
Yes
iOS (14.0+)