LDAP
The payload that configures a Lightweight Directory Access Protocol (LDAP) account.
Declaration
object LDAPProperties
| Name | Type | Description |
|---|---|---|
LDAPAccountDescription | string | The description of the account. |
LDAPAccountHostName Required | string | The server’s address. |
LDAPAccountPassword | string | The user’s password. Only use this in encrypted profiles. |
LDAPAccountUserName | string | The user’s user name. |
LDAPAccountUseSSL | boolean | If |
LDAPSearchSettings | [LDAP.LDAPSearchSettingsItem] | An array of search settings dictionaries. |
VPNUUID | string | The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later. |
Discussion
Specify com.apple.ldap.account as the payload type.
Profile availability
Device channel | iOS, visionOS |
User channel | macOS, Shared iPad |
Allow manual install | iOS, macOS, visionOS |
Requires supervision | NA |
Requires user-approved MDM | NA |
Allowed in user enrollment | iOS, macOS, visionOS |
Allow multiple payloads | iOS, macOS, Shared iPad, visionOS |
Profile example
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>PayloadContent</key>
<array>
<dict>
<key>LDAPAccountDescription</key>
<string>Company LDAP Account</string>
<key>LDAPAccountHostName</key>
<string>com.apple.ldap.account</string>
<key>LDAPAccountUseSSL</key>
<true/>
<key>LDAPAccountUserName</key>
<string>JuanChavez4</string>
<key>LDAPSearchSettings</key>
<array>
<dict>
<key>LDAPSearchSettingDescription</key>
<string>My Search</string>
<key>LDAPSearchSettingScope</key>
<string>LDAPSearchSettingScopeSubtree</string>
<key>LDAPSearchSettingSearchBase</key>
<string>o=My Company,ou=My Department</string>
</dict>
</array>
<key>PayloadIdentifier</key>
<string>com.example.myldappayload</string>
<key>PayloadType</key>
<string>com.apple.ldap.account</string>
<key>PayloadUUID</key>
<string>7f846724-1bf7-4501-b8cd-ce7026e95280</string>
<key>PayloadVersion</key>
<integer>1</integer>
</dict>
</array>
<key>PayloadDisplayName</key>
<string>LDAP</string>
<key>PayloadIdentifier</key>
<string>com.example.myprofile</string>
<key>PayloadType</key>
<string>Configuration</string>
<key>PayloadUUID</key>
<string>c5208028-7e96-4669-8d83-4fbbeb48845a</string>
<key>PayloadVersion</key>
<integer>1</integer>
</dict>
</plist>