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)

KeyTypeTitle
CardDAVAccountDescription

macOS 10.7+

The description of the account.

Default: "My Contacts Account"

stringAccount description
CardDAVHostNamerequired

macOS 10.7+

The server's address.

stringAccount hostname
CardDAVPort

macOS 10.7+

The server's port.

Default: 443

Range: 0 – 65535

integerPort number
CardDAVPrincipalURL

not on macOS

The base URL to the user's address book.

stringPrincipal URL
CardDAVUsername

macOS 10.7+

The user name for logins.

Depends on:

stringAccount username
CardDAVPassword

macOS 10.7+

The user's password. Only use this in encrypted profiles.

stringAccount password
CardDAVUseSSL

macOS 10.7+

If 'true', the system enables SSL.

Default: true

booleanUse SSL
CommunicationServiceRules

iOS 10.0+ · not on macOS

An array of communication service rules for this account.

dictCommunication service rules
DefaultServiceHandlers

iOS 10.0+ · not on macOS

A dictionary of service handlers for contacts from this account.

dictDefault service handlers
AudioCall

iOS 10.0+ · not on macOS

The bundle identifier for the default application that handles audio calls to contacts from this account.

stringApp for audio calls
VPNUUID

iOS 14.0+ · not on macOS

The VPNUUID of the per-app VPN the account uses for network communication.

stringVPNUUID