CalDAV Payload

../../_images/com.apple.caldav.account.png

Template

This payload configures a CalDAV account.

Summary

PayloadType:com.apple.caldav.account
Supervised Only:
 N/A
macOS:N/A
macOS Deprecated:
 N/A
iOS:N/A
iOS Deprecated:N/A
Highlander:False

Keys

CalDAVAccountDescription

Account Description

The display name of the account (e.g. “Company Calendar Account”)

Type Default Required Regex iOS macOS Supervised
string My Calendar Account N/A N/A N/A N/A N/A

CalDAVPort

Port Number

The port on which to connect to the CalDAV server.

Type Default Required Regex iOS macOS Supervised
integer 443 N/A N/A N/A N/A N/A

CalDAVHostName

Account Hostname

The IP address or fully qualified domain name (FQDN) of the CalDAV server.

Type Default Required Regex iOS macOS Supervised
string N/A always N/A N/A N/A N/A

CalDAVUseSSL

Use SSL

Enable Secure Socket Layer communication with CalDAV server

Type Default Required Regex iOS macOS Supervised
boolean True N/A N/A N/A N/A N/A

CalDAVPrincipalURL

Principal URL

The base URL to the user’s calendar. In macOS this URL is required if the user doesn’t provide a password, because auto-discovery of the service will fail and the account won’t be created.

Type Default Required Regex iOS macOS Supervised
string N/A N/A N/A N/A N/A N/A

CalDAVUsername

Account Username

The user name for the CalDAV account.

Type Default Required Regex iOS macOS Supervised
string N/A push N/A N/A N/A N/A

CalDAVPassword

Account Password

The CalDAV password

Type Default Required Regex iOS macOS Supervised
string N/A N/A N/A N/A N/A N/A