---
title: AccountExchange
framework: devicemanagement
role: symbol
role_heading: Object
path: devicemanagement/accountexchange
---

# AccountExchange

The declaration to configure an Exchange account.

## Declaration

```data
object AccountExchange
```

## Properties

AuthenticationCredentialsAssetReference: The identifier of an asset declaration that contains the credentials for this account to authenticate with an Exchange server. Set the corresponding asset type to CredentialUserNameAndPassword. AuthenticationIdentityAssetReference: The identifier of a credential asset declaration that contains the identity that this account requires to authenticate with the Exchange server. CalendarServiceActive: If true, activates the calendar service for this account. ContactsServiceActive: If true, activates the address book service for this account. EnabledProtocolTypes: The set of protocol types to enable on the Exchange server, in order of preference. This is an array of unique strings with possible values: EAS: Exchange ActiveSync EWS: Exchange Web Services If the device supports one or more of the listed protocol types, it sets up an account for the first supported type. If the device doesn’t support any of the listed protocol types, it doesn’t set up an account and the system reports an error. External Path: The external path of the EWS server. The system uses this only when this declaration has a ExternalHostName value. Available: macOS 13+ ExternalHostName: The external hostname of the EWS server (or IP address). Available: macOS 13+ ExternalPort: The external port number of the EWS server. The system uses this only when this declaration has a ExternalHostName value. Available: macOS 13+ HostName: The IP address or fully qualified domain name (FQDN) of the Exchange host. LockCalendarService: If true, the system prevents the user from changing the status of the calendar service for this account. Available: iOS 15+ | iPadOS 15+ | visionOS 1.1+ LockContactsService: If true, the system prevents the user from changing the status of the address book service for this account. Available: iOS 15+ | iPadOS 15+ | visionOS 1.1+ LockMailService: If true, the system prevents the user from changing the status of the mail service for this account. Available: iOS 15+ | iPadOS 15+ | visionOS 1.1+ LockNotesService: If true, the system prevents the user from changing the status of the notes service for this account. Available: iOS 15+ | iPadOS 15+ | visionOS 1.1+ LockRemindersService: If true, the system prevents the user from changing the status of the reminders service for this account. Available: iOS 15+ | iPadOS 15+ | visionOS 1.1+ MailServiceActive: If true, the system activates the mail service for this account. NotesServiceActive: If true, the system activates the notes service for this account. OAuth: The configuration settings for OAuth for this account. Path: The path of the EWS server. The system uses this only when this declaration has a HostName value. Available: macOS 13+ Port: The port number of the EWS server. The system uses this only when this declaration has a HostName value. Available: macOS 13+ RemindersServiceActive: If true, the system activates the reminders service for this account. SMIME: Settings for S/MIME. Available: iOS 17+ | iPadOS 17+ | visionOS 1.1+ UserIdentityAssetReference: The identifier of an asset declaration that contains the user identity for this account. The corresponding asset must be of type UserIdentity. VisibleName: The name that apps show to the user for this Exchange account. If not present, the system generates a suitable default.

## Discussion

Discussion Specify com.apple.configuration.account.exchange as the declaration type. Configuration availability  |   |   |   |   |   |   |   |  Configuration example This configuration sets up a Microsoft Exchange account. {     "Type": "com.apple.configuration.account.exchange",     "Identifier": "EB13EE2B-5D63-4EBA-810F-5B81D07F5017",     "ServerToken": "E180CA9A-F089-4FA3-BBDF-94CC159C4AE8",     "Payload": {         "VisibleName": "Work Exchange",         "HostName": "exchange.example.com",         "EnabledProtocolTypes": [             "EAS",             "EWS"         ],         "UserIdentityAssetReference": "CB3E6C7F-2318-437B-8A9E-D50C69376DE4",         "AuthenticationCredentialsAssetReference": "64BF8F5C-8CFD-40AA-9082-A0B594D4E100",         "LockMailService": true,         "NotesServiceActive": false,         "LockNotesService": true     } }

## Topics

### Objects

- [AccountExchangeOAuthObject](devicemanagement/accountexchangeoauthobject.md)
- [AccountExchangeSMIMEObject](devicemanagement/accountexchangesmimeobject.md)

## See Also

### Configurations

- [AccountCalDAV](devicemanagement/accountcaldav.md)
- [AccountCardDAV](devicemanagement/accountcarddav.md)
- [AccountGoogle](devicemanagement/accountgoogle.md)
- [AccountLDAP](devicemanagement/accountldap.md)
- [AccountMail](devicemanagement/accountmail.md)
- [AccountSubscribedCalendar](devicemanagement/accountsubscribedcalendar.md)
- [AppManaged](devicemanagement/appmanaged.md)
- [AppSettings](devicemanagement/appsettings.md)
- [AudioAccessorySettings](devicemanagement/audioaccessorysettings.md)
- [ContentCaching](devicemanagement/contentcaching.md)
- [DiskManagementSettings](devicemanagement/diskmanagementsettings.md)
- [ExtensibleSSO](devicemanagement/extensiblesso.md)
- [ExternalIntelligenceSettings](devicemanagement/externalintelligencesettings.md)
- [IntelligenceSettings](devicemanagement/intelligencesettings.md)
- [KeyboardSettings](devicemanagement/keyboardsettings.md)