PayloadKit

LDAP

com.apple.ldap.account

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

iOS 4.0+macOS 10.7+visionOS 1.1+
Apple schemacombined

macOS: user channel only

Configuration Keys (7)

KeyTypeDescriptionDefaultRange

Account description

stringThe description of the account.Default: —Range: —

Account username

stringThe user's user name.Default: —Range: —

Account password

stringThe user's password. Only use this in encrypted profiles.Default: —Range: —

Account hostname

required
stringThe server's address.Default: —Range: —

Use SSL

booleanIf 'true', the system enables SSL.Default: trueRange: —

Search settings

arrayAn array of search settings dictionaries.Default: —Range: —

An LDAP search setting

dictAn item within the Search Settings arrayDefault: {"LDAPSearchSettingDescription":"My Search","LDAPSearchSettingScope":"LDAPSearchSettingScopeSubtree","LDAPSearchSettingSearchBase":"o=My Company ou=MyDepartment"}Range: —
stringThe description of this search setting.Default: "My Search"Range: —

Search setting scope

stringThe 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)

Search setting search base

required
stringThe path to the node where a search should start.Default: "o=My Company,ou=My Department"Range: —
VPNUUIDstring

VPNUUID

iOS 14.0+ · not on macOS

stringThe VPNUUID of the per-app VPN the account uses for network communication.Default: —Range: —