Back to browser

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)

Key	Type	Title	Description	Default	Range
`LDAPAccountDescription`	string	Account Description	The description of the account.	—	—
`LDAPAccountUserName`	string	Account Username	The user's user name.	—	—
`LDAPAccountPassword`	string	Account Password	The user's password. Only use this in encrypted profiles.	—	—
`LDAPAccountHostName`required	string	Account Hostname	The server's address.	—	—
`LDAPAccountUseSSL`	boolean	Use SSL	If 'true', the system enables SSL.	true	—
`LDAPSearchSettings`	array	Search Settings	An array of search settings dictionaries.	—	—
`VPNUUID`	string	VPNUUID	The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later.	—	—
`LDAPSearchSettingsItem`	dict	An LDAP Search Setting	An item within the Search Settings array	{"LDAPSearchSettingDescription":"My Search","LDAPSearchSettingScope":"LDAPSearchSettingScopeSubtree","LDAPSearchSettingSearchBase":"o=My Company ou=MyDepartment"}	—
`LDAPSearchSettingDescription`	string	Description	The description of this search setting.	"My Search"	—
`LDAPSearchSettingScope`	string	Search Setting Scope	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.	"LDAPSearchSettingScopeSubtree"
`LDAPSearchSettingSearchBase`required	string	Search Setting Search Base	The path to the node where a search should start.	"o=My Company,ou=My Department"	—