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. Available in iOS 14 and later. | string | optional | — | ✓Yes | iOS (14.0+) |
