---
title: MigrationAssistantSettings
framework: Device Management
role: symbol
role_heading: Object
platforms: [macOS 26.4+]
path: devicemanagement/migrationassistantsettings
---

# MigrationAssistantSettings

The declaration to configure Migration Assistant settings.

## Declaration

```data
object MigrationAssistantSettings
```

## Properties

ExcludedAccounts: An array of strings that represent the user account short names the system excludes from migration. ExcludedPaths: An array of strings that represent files and directories relative to the user’s home directory that the system excludes from migration. Directory paths need to include a trailing “/”. For example, to exclude the “Excluded” directory in the “Documents” folder of a user’s home directory, use “Documents/Excluded/”. RequiredPaths: An array of strings that represent files and directories relative to the user’s home directory that the system needs to migrate. Directory paths need to include a trailing “/”. For example, to require the “Required” directory in the “Documents” folder of a user’s home directory, use “Documents/Required/”. ShouldDoManagedMigration: If true, the device manages Migration Assistant. ShouldMigrateSecurityPrivacySettings: If true, the system migrates Security & Privacy settings.

## Discussion

Discussion Specify com.apple.configuration.migration-assistant.settings as the declaration type. This declaration allows the device management service to configure Migration Assistant when it runs during Setup Assistant on a Mac. This makes it easy for users to do Mac-to-Mac migrations of enterprise devices when they setup a new Mac. Configure the device to use the AwaitingConfiguration state after it enrolls with the server. The server needs to send the configuration and verify the configuration as both active and valid using the Declarative Device Management status, before it sends the DeviceConfiguredCommand command to exit that state. The device reports Migration Assistant progress using the StatusMigrationAssistantState status item, and provides a report when migration completes using the StatusMigrationAssistantReport status item. Configuration availability  |   |   |   |   |   |   |   |  Configuration example This configuration provides settings for a Mac to Mac migration. {     "Type": "com.apple.configuration.migration-assistant.settings",     "Identifier": "F3CD2AD7-85AA-4FF3-9264-A737259FB55E",     "ServerToken": "5AB2B98C-FCE9-4A33-88B3-ADB05F081F77",     "Payload": {         "ShouldDoManagedMigration": true,         "ExcludedAccounts": [             "admin"         ],         "ExcludedPaths": [             "Documents/Personal Items/"         ],         "RequiredPaths": [             "Documents/Work Items/"         ],         "ShouldMigrateSecurityPrivacySettings": false     } }

## See Also

### Configurations

- [AccessibilitySettings](devicemanagement/accessibilitysettings.md)
- [AccountCalDAV](devicemanagement/accountcaldav.md)
- [AccountCardDAV](devicemanagement/accountcarddav.md)
- [AccountExchange](devicemanagement/accountexchange.md)
- [AccountGoogle](devicemanagement/accountgoogle.md)
- [AccountLDAP](devicemanagement/accountldap.md)
- [AccountMail](devicemanagement/accountmail.md)
- [AccountSettings](devicemanagement/accountsettings.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)