The declaration to configure a Lightweight Directory Access Protocol (LDAP) account.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Account Name VisibleName The name that apps show to the user for this LDAP account. If not present, the system generates a suitable default. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
Server Host Name HostName The hostname or IP address of the LDAP server. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
Server Port Port The port number or IP address of the LDAP server. | integer | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
Authentication Credentials Asset Reference AuthenticationCredentialsAssetReference The identifier of an asset declaration that contains the credentials for this account. Set the corresponding asset type to `CredentialUserNameAndPassword`. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
Search Settings SearchSettings The array of nodes to start LDAP searches from. There must be at least one node for this account to be useful. macOS only searches one node and ignores other items in the array. 1 subkey | array | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ An LDAP Search Setting SearchSettingsItem 3 subkeys | dictionary | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) | |
└─ └─ Visible Description VisibleDescription The description of this search setting in the Contacts and Settings apps. If not present, the apps display no name. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Search Base SearchBase The path to the node where a search starts. For example, `ou=people,o=example corp`. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Scope Scope The type of recursion to use in the search:
- `Base`: The search uses only the `SearchBase` node.
- `OneLevel`: The search uses the `SearchBase` node and its immediate children.
- `Subtree`: The search uses the `SearchBase` node and all its children, regardless of depth. | string | optional | Subtree | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
