AccountLDAP
The declaration to configure a Lightweight Directory Access Protocol (LDAP) account.
Declaration
object AccountLDAPProperties
| Name | Type | Description |
|---|---|---|
AuthenticationCredentialsAssetReference | string | The identifier of an asset declaration that contains the credentials for this account. Set the corresponding asset type to |
HostName Required | string | The hostname or IP address of the LDAP server. |
Port | integer | The port number or IP address of the LDAP server. |
SearchSettings | [AccountLDAPSearchSettingsItemObject] | 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. |
VisibleName | string | The name that apps show to the user for this LDAP account. If not present, the system generates a suitable default. |
Discussion
Specify com.apple.configuration.account.ldap as the declaration type.
Configuration availability
Allowed in supervised enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in device enrollment | iOS, Shared iPad, visionOS |
Allowed in user enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in local enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in system scope | iOS, visionOS |
Allowed in user scope | macOS, Shared iPad |
Configuration example
{
"Type": "com.apple.configuration.account.ldap",
"Identifier": "EB13EE2B-5D63-4EBA-810F-5B81D07F5017",
"ServerToken": "E180CA9A-F089-4FA3-BBDF-94CC159C4AE8",
"Payload": {
"VisibleName": "Work Directory",
"HostName": "ldap.example.com",
"SearchSettings": [
{
"VisibleName": "Search Work",
"SearchBase": "dc=example,dc=com",
"Scope": "Subtree"
}
]
}
}