The payload that configures a Lightweight Directory Access Protocol (LDAP) account.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Account description LDAPAccountDescription The description of the account. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Account hostname LDAPAccountHostName The server's address. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Account username LDAPAccountUserName The user's user name. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Account password LDAPAccountPassword The user's password. Only use this in encrypted profiles. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Use SSL LDAPAccountUseSSL If `true`, the system enables SSL. | boolean | optional | true | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Search settings LDAPSearchSettings An array of search settings dictionaries. 1 subkey | array | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
└─ An LDAP search setting LDAPSearchSettingsItem 3 subkeys | dictionary | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) | |
└─ └─ Description LDAPSearchSettingDescription The description of this search setting. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
└─ └─ Search setting search base LDAPSearchSettingSearchBase The path to the node where a search should start. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
└─ └─ Search setting scope LDAPSearchSettingScope The type of recursion to use in the search:
- `LDAPSearchSettingScopeBase`: The search uses only the immediate node that the search base points to.
- `LDAPSearchSettingScopeOneLevel`: The search uses the node plus its immediate children.
- `LDAPSearchSettingScopeSubtree`: The search uses the node plus all children, regardless of depth. | string | optional | LDAPSearchSettingScopeSubtree | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
VPNUUID VPNUUID The VPNUUID of the per-app VPN the account uses for network communication. | string | optional | — | ✓Yes | iOS (14.0+) |
Explore the full catalogue of Apple Mobile Device Management (MDM) and Declarative Device Management (DDM) policies for macOS and iOS. Search, filter, and reference policy keys for use with Microsoft Intune, Jamf, or any standards-compliant MDM solution.
com.apple.wifi.managed – Wi-Fi network configurationcom.apple.vpn.managed – VPN configurationcom.apple.applicationaccess – App and feature restrictionscom.apple.security.pkcs1 – Certificate (PKCS#1) payloadcom.apple.security.pkcs12 – Identity certificate (PKCS#12) payloadcom.apple.security.scep – SCEP certificate enrolmentcom.apple.mail.managed – Mail account configurationcom.apple.eas.account – Exchange ActiveSync accountcom.apple.MCX – Managed Client (macOS) preferencescom.apple.MCX.FileVault2 – FileVault 2 disk encryptioncom.apple.dock – macOS Dock configurationcom.apple.screensaver – Screensaver configurationcom.apple.loginwindow – macOS login window configurationcom.apple.systempolicy.managed – Gatekeeper / system policycom.apple.systempreferences – System Preferences pane restrictionscom.apple.SoftwareUpdate – Software update behaviourcom.apple.TCC.configuration-profile-policy – Privacy Preferences Policy Control (PPPC)com.apple.notificationsettings – Per-app notification settingscom.apple.webcontent-filter – Web content filtercom.apple.dnsSettings.managed – DNS settings (DoH / DoT)com.apple.relay.managed – Network relay configurationcom.apple.extensiblesso – Extensible Single Sign-Oncom.apple.configuration.passcode.settings – DDM: passcode policycom.apple.configuration.softwareupdate.enforcement.specific – DDM: enforced software updatecom.apple.configuration.services.configuration-files – DDM: service configuration filescom.apple.configuration.management.status-subscriptions – DDM: status subscriptionscom.apple.activation.simple – DDM: simple activation predicatecom.apple.management.organization-info – DDM: organization information