LDAP Account

An LDAP payload provides information about an LDAP server to use, including account information if required, and a set of LDAP search policies to use when querying that LDAP server.

Contents

• LDAP Account
  • Summary
  • Keys
    • LDAPAccountDescription
    • LDAPAccountUserName
    • LDAPAccountPassword
    • LDAPAccountHostName
    • LDAPAccountUseSSL
    • LDAPSearchSettings
    • LDAPSearchSettings Keys

Summary

PayloadType:com.apple.ldap.account Supervised Only:  N/A macOS:N/A macOS Deprecated:  N/A iOS:N/A iOS Deprecated:N/A Highlander:False

Name	Type	Title	Description	Required
LDAPAccountDescription	string	Account Description	The display name of the account (e.g. ‘Company LDAP Account’)	n/a
LDAPAccountUserName	string	Account Username	The username for this LDAP account	n/a
LDAPAccountPassword	string	Account Password	The password for this LDAP account	n/a
LDAPAccountHostName	string	Account Hostname	The LDAP Hostname or IP address	always
LDAPAccountUseSSL	boolean	Use SSL	Enable Secure Socket Layer for this connection	n/a
LDAPSearchSettings	array	Search Settings	Scope and search base for this LDAP server.	n/a

Keys

LDAPAccountDescription

Account Description

The display name of the account (e.g. ‘Company LDAP Account’)

Type	Default	Required	Regex	iOS	macOS	Supervised
string	N/A	N/A	N/A	N/A	N/A	N/A

LDAPAccountUserName

Account Username

The username for this LDAP account

Type	Default	Required	Regex	iOS	macOS	Supervised
string	N/A	N/A	N/A	N/A	N/A	N/A

LDAPAccountPassword

Account Password

The password for this LDAP account

Type	Default	Required	Regex	iOS	macOS	Supervised
string	N/A	N/A	N/A	N/A	N/A	N/A

LDAPAccountHostName

Account Hostname

The LDAP Hostname or IP address

Type	Default	Required	Regex	iOS	macOS	Supervised
string	N/A	always	N/A	N/A	N/A	N/A

LDAPAccountUseSSL

Use SSL

Enable Secure Socket Layer for this connection

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	True	N/A	N/A	N/A	N/A	N/A

LDAPSearchSettings

Search Settings

Scope and search base for this LDAP server.

Type	Default	Required	Regex	iOS	macOS	Supervised
array	N/A	N/A	N/A	N/A	N/A	N/A

LDAPSearchSettings Keys

Each LDAP Search Setting contains the following keys: