Skip to content

Account Configuration

Account configuration payloads let you pre-configure email, calendar, contacts, directory, and web clip accounts on managed devices. Each account type is a separate payload within a configuration profile.


Email

Configure IMAP, POP, or Exchange email accounts. The device prompts the user for their password on first sync unless you include the password in the payload (not recommended for security).

KeyTypeDescription
EmailAccountDescriptionStringUser-visible description of the account
EmailAccountNameStringDisplay name for the account (e.g., "Work Email")
EmailAccountTypeStringEmailTypeIMAP, EmailTypePOP, or EmailTypeExchange
EmailAddressStringFull email address
IncomingMailServerHostNameStringIMAP/POP server hostname
IncomingMailServerPortNumberIntegerIMAP/POP server port
IncomingMailServerUseSSLBooleanEnable SSL for incoming mail
IncomingMailServerUsernameStringUsername for incoming server
IncomingPasswordStringPassword (omit to prompt user)
OutgoingMailServerHostNameStringSMTP server hostname
OutgoingMailServerPortNumberIntegerSMTP server port
OutgoingMailServerUseSSLBooleanEnable SSL for outgoing mail
OutgoingMailServerUsernameStringUsername for outgoing server
OutgoingPasswordStringPassword (omit to prompt user)
PreventMoveBooleanPrevent messages from being moved out of this account
PreventAppSheetBooleanPrevent the account from appearing in the share sheet
SMIMEEnabledBooleanEnable S/MIME signing and encryption
SMIMESigningCertificateUUIDStringUUID referencing a certificate payload for signing
SMIMEEncryptionCertificateUUIDStringUUID referencing a certificate payload for encryption

Exchange ActiveSync

Microsoft Exchange integration for mail, calendar, contacts, and tasks.

KeyTypeDescription
EmailAddressStringUser's email address
HostStringExchange server hostname
PortIntegerServer port (default 443)
UseSSLBooleanEnable SSL
UserNameStringDomain\username or UPN
PasswordStringPassword (omit to prompt user)
MailNumberOfPastDaysToSyncIntegerDays of mail to sync (1–180)
MailSyncEnabledBooleanEnable mail sync
CalendarSyncEnabledBooleanEnable calendar sync
ContactsSyncEnabledBooleanEnable contacts sync
TasksSyncEnabledBooleanEnable tasks sync
AllowRemovalBooleanAllow user to remove the account
SMIMEEnabledBooleanEnable S/MIME
SMIMESigningCertificateUUIDStringCertificate UUID for signing
SMIMEEncryptionCertificateUUIDStringCertificate UUID for encryption

LDAP

Connect to an LDAP directory server for contact lookup.

KeyTypeDescription
LDAPAccountDescriptionStringUser-visible description
LDAPAccountHostNameStringLDAP server hostname
LDAPAccountPortNumberIntegerServer port (default 389)
LDAPAccountUseSSLBooleanEnable SSL (use port 636)
LDAPAccountUserNameStringBind DN
LDAPAccountPasswordStringBind password (omit to prompt)
LDAPSearchSettingsArray of dictionariesSearch base and scope per setting
LDAPSearchSettingDictionaryLDAPSearchSettingDesc (name), LDAPSearchSettingBase (search base DN), LDAPSearchSettingScope (LDAPSearchSettingScopeSubtree or LDAPSearchSettingScopeOneLevel)

CalDAV

Connect to a CalDAV-compatible calendar server.

KeyTypeDescription
CalDAVAccountDescriptionStringUser-visible description
CalDAVHostNameStringCalDAV server hostname
CalDAVPortIntegerServer port
CalDAVUseSSLBooleanEnable SSL
CalDAVPrincipalURLStringPrincipal URL (optional, auto-discovered if omitted)
CalDAVUsernameStringAccount username
CalDAVPasswordStringPassword (omit to prompt user)

CardDAV

Connect to a CardDAV-compatible contact server.

KeyTypeDescription
CardDAVAccountDescriptionStringUser-visible description
CardDAVHostNameStringCardDAV server hostname
CardDAVPortIntegerServer port
CardDAVUseSSLBooleanEnable SSL
CardDAVPrincipalURLStringPrincipal URL (optional, auto-discovered if omitted)
CardDAVUsernameStringAccount username
CardDAVPasswordStringPassword (omit to prompt user)

Subscribed Calendar

Subscribe to a read-only iCalendar feed (.ics URL). The calendar is read-only — users cannot modify events.

KeyTypeDescription
SubCalAccountDescriptionStringUser-visible description
SubCalAccountHostNameStringCalendar feed hostname
SubCalAccountUsernameStringUsername (if authentication is required)
SubCalAccountPasswordStringPassword (omit to prompt)
SubCalAccountUseSSLBooleanEnable SSL
SubCalCalendarURLStringFull URL to the .ics file

Web Clip

Add a web app shortcut to the device home screen. Behaves like a progressive web app bookmark.

KeyTypeDescription
URLStringFull URL the clip opens
LabelStringDisplay name on the home screen
IconDataPNG icon data (57x57 or 512x512 recommended)
IsRemovableBooleanAllow user to delete the web clip
PrecomposedBooleanDo not add iOS gloss effect to the icon
FullScreenBooleanOpen in full-screen mode (hides Safari chrome)
TargetApplicationBundleIdentifierStringBundle ID of the app to open the URL (e.g., com.apple.mobilesafari)

Released under the MIT License