PayloadKit

LDAP

com.apple.ldap.account

The payload that configures a Lightweight Directory Access Protocol (LDAP) account.

iOSmacOS
macOS 10.7+iOS 4.0+combined

Configuration Keys (7)

KeyTypeTitle
LDAPAccountDescription

The description of the account.

stringAccount Description
LDAPAccountUserName

The user's user name.

stringAccount Username
LDAPAccountPassword

The user's password. Only use this in encrypted profiles.

stringAccount Password
LDAPAccountHostNamerequired

The server's address.

stringAccount Hostname
LDAPAccountUseSSL

If 'true', the system enables SSL.

Default: true

booleanUse SSL
LDAPSearchSettings

An array of search settings dictionaries.

arraySearch Settings
VPNUUID

The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later.

stringVPNUUID
LDAPSearchSettingsItem

An item within the Search Settings array

Default: {"LDAPSearchSettingDescription":"My Search","LDAPSearchSettingScope":"LDAPSearchSettingScopeSubtree","LDAPSearchSettingSearchBase":"o=My Company ou=MyDepartment"}

dictAn LDAP Search Setting
LDAPSearchSettingDescription

The description of this search setting.

Default: "My Search"

stringDescription
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.

Default: "LDAPSearchSettingScopeSubtree"

Range: Base (LDAPSearchSettingScopeBase), One Level (LDAPSearchSettingScopeOneLevel), Subtree (LDAPSearchSettingScopeSubtree)

stringSearch Setting Scope
LDAPSearchSettingSearchBaserequired

The path to the node where a search should start.

Default: "o=My Company,ou=My Department"

stringSearch Setting Search Base