Apple Platform Deployment
- Welcome
- Intro to Apple Platform Deployment
- What’s new
-
-
- Declarative status reports
- Declarative app configuration
- Accessibility declarative configuration
- Apple Intelligence declarative configuration
- App settings configuration
- Audio accessory declarative configuration
- Authentication credentials and identity asset declaration
- Background task management declarative
- Calendar declarative configuration
- Certificates declarative configuration
- Contacts declarative configuration
- Content caching declarative configuration
- DNS settings declarative configuration
- DNS proxy declarative configuration
- Exchange declarative configuration
- Extensible SSO declarative configuration
- External intelligence declarative configuration
- Google Accounts declarative configuration
- Keyboard declarative configuration
- LDAP declarative configuration
- Legacy interactive profile declarative configuration
- Legacy profile declarative configuration
- Mail declarative configuration
- Math and Calculator app declarative configuration
- Managed Migration Assistant declarative configuration
- Network relay declarative configuration
- Packages declarative configuration
- Passcode declarative configuration
- Passkey Attestation declarative configuration
- Safari bookmarks declarative configuration
- Safari browsing management declarative configuration
- Safari extensions management declarative configuration
- Screen Sharing declarative configuration
- Service configuration files declarative configuration
- Siri declarative configuration
- Software Update declarative configuration
- Software Update settings declarative configuration
- Storage management declarative configuration
- Subscribed Calendars declarative configuration
- Web content filter plugin declarative configuration
-
-
- Accessibility payload settings
- Active Directory Certificate payload settings
- AirPlay payload settings
- AirPlay Security payload settings
- AirPrint payload settings
- App Lock payload settings
- Associated Domains payload settings
- Automated Certificate Management Environment (ACME) payload settings
- Autonomous Single App Mode payload settings
- Calendar payload settings
- Cellular payload settings
- Cellular Private Network payload settings
- Certificate Preference payload settings
- Certificate Revocation payload settings
- Certificate Transparency payload settings
- Certificates payload settings
- Conference Room Display payload settings
- Contacts payload settings
- Content Caching payload settings
- Directory Service payload settings
- DNS Proxy payload settings
- DNS Settings payload settings
- Dock payload settings
- Domains payload settings
- Energy Saver payload settings
- Exchange ActiveSync (EAS) payload settings
- Exchange Web Services (EWS) payload settings
- Extensible Single Sign-on payload settings
- Extensible Single Sign-on Kerberos payload settings
- Extensions payload settings
- FileVault payload settings
- Finder payload settings
- Firewall payload settings
- Fonts payload settings
- Global HTTP Proxy payload settings
- Google Accounts payload settings
- Home Screen Layout payload settings
- Identification payload settings
- Identity Preference payload settings
- Kernel Extension Policy payload settings
- LDAP payload settings
- Lights Out Management payload settings
- Lock Screen Message payload settings
- Login Window payload settings
- Managed Login Items payload settings
- Mail payload settings
- Network Usage Rules payload settings
- Notifications payload settings
- Parental Controls payload settings
- Passcode payload settings
- Printing payload settings
- Privacy Preferences Policy Control payload settings
- Relay payload settings
- SCEP payload settings
- Security payload settings
- Setup Assistant payload settings
- Single Sign-on payload settings
- Smart Card payload settings
- Subscribed Calendars payload settings
- System Extensions payload settings
- System Migration payload settings
- Time Machine payload settings
- TV Remote payload settings
- Web Clips payload settings
- Web Content Filter payload settings
- Xsan payload settings
-
- Glossary
- Document revision history
- Copyright and trademarks

Add Active Directory payload options for Apple devices
The Directory payload for Mac computers can use some Active Directory options that may not appear in the user interface of a device management service.
The following Active Directory configuration keys can be added to the Directory payload, of type com.apple.DirectoryService.managed. Note that some settings are set only if the associated flag key is set to “true.” For example, ADPacketEncryptFlag needs to be set to “true” to set the ADPacketEncrypt key to “enable.”
Key | Type | Description |
|---|---|---|
HostName | string | The Active Directory domain to join. |
User name (optional) | string | User name of the account used to join the domain. |
Password (optional) | string | Password of the account used to join the domain. |
PromptForCredentials | boolean | Prompt the user for credentials to authenticate. |
Description | string | Description of the payload. |
ADOrganizationalUnit | string | The organizational unit (OU) where the joining computer object is added. |
ADMountStyle | string | Network home protocol to use: “smb” or “afp”. |
ADCreateMobileAccount AtLoginFlag | boolean | Turn on or off the ADCreateMobileAccountAtLogin key. |
ADCreateMobileAccount AtLogin | boolean | Create mobile account at login. |
ADWarnUserBefore CreatingMAFlag | boolean | Turn on or off the ADWarnUserBeforeCreatingMA key. |
ADWarnUserBeforeCreatingMA | boolean | Turn on or off the ADCreateMobileAccountAtLogin key. |
ADForceHomeLocalFlag | boolean | Turn on or off the ADForceHomeLocal key. |
ADForceHomeLocal | boolean | Force local home directory. |
ADUseWindowsUNCPathFlag | boolean | Turn on or off the ADUseWindowsUNCPath key. |
ADUseWindowsUNCPath | boolean | Use UNC path from Active Directory to derive network home location. |
ADAllowMultiDomainAuthFlag | boolean | Turn on or off the ADAllowMultiDomainAuth key. |
ADAllowMultiDomainAuth | boolean | Allow authentication from any domain in the forest. |
ADDefaultUserShellFlag | boolean | Turn on or off the ADDefaultUserShell key. |
ADDefaultUserShell | string | Default user shell; e.g. /bin/bash. |
ADMapUIDAttributeFlag | boolean | Turn on or off the ADMapUIDAttribute key. |
ADMapUIDAttribute | string | Map UID to attribute. |
ADMapGIDAttributeFlag | boolean | Turn on or off the ADMapGIDAttribute key. |
ADMapGIDAttribute | string | Map user GID to attribute. |
ADMapGGIDAttributeFlag | boolean | Turn on or off the ADMapGGIDAttributeFlag key. |
ADMapGGIDAttribute | string | Map group GID to attribute. |
ADPreferredDCServerFlag | boolean | Turn on or off the ADPreferredDCServer key. |
ADPreferredDCServer | string | Prefer this domain server. |
ADDomainAdminGroupListFlag | boolean | Turn on or off the ADDomainAdminGroupList key. |
ADDomainAdminGroupList | array of strings | Allow administration by specified Active Directory groups. |
ADNamespaceFlag | boolean | Turn on or off the ADNamespace key. |
ADNamespace | string | Set primary user account naming convention: “forest” or “domain”; “domain” is default. |
ADPacketSignFlag | boolean | Turn on or off the ADPacketSign key. |
ADPacketSign | string | Packet signing: “allow,” “disable,” or “require”; “allow” is default. |
ADPacketEncryptFlag | boolean | Turn on or off the ADPacketEncrypt key. |
ADPacketEncrypt | string | Packet encryption: “allow,” “disable,” “require,” or “ssl”; “allow” is default. |
ADRestrictDDNSFlag | boolean | Turn on or off the ADRestrictDDNS key. |
ADRestrictDDNS | array of strings | Restrict Dynamic DNS updates to the specified interfaces (e.g. en0, en1, etc). |
ADTrustChange PassIntervalDaysFlag | boolean | Turn on or off the ADTrustChangePassIntervalDays key. |
ADTrustChangePassIntervalDays | number | How often to require change of the computer trust account password in days; “0” can’t be used. |