LDAP Authentication Connection Properties

The following properties are available on LDAPConnectionProperties objects, which appear as expandable sub-properties of the objects that use them.

Misc

Property	Type	Default	Description
LDAPConnectionMethod	LDAPConnectionMethod	LDAPConnectionMethod.DirectoryEntry	Controls the mechanism utilized to authenticate the user against the LDAP server. DirectoryEntry - Authenticates the user by resolving a directory entry with the provided credentials. LDAPConnection - Authenticates the user by performing a bind against the server with the provided credentials.
LDAPCredentialPolicy	LDAPCredentialPolicy	LDAPCredentialPolicy.UserCredentials	Whether to prompt the user for credentials or use the authenticated username from an upstream authentication provider. The AuthenticatedUsername option can only be used with an AuthenticationProviderLoginService.
LDAPGroupAttribute	string		Optionally specifies the name of an attribute to be captured from each group and retained as an authenticated role. By default, the roles obtained are the distinguished names of the groups (with the BaseDomainName removed) or the common names of the groups.
LDAPLoginAttribute	LDAPLoginAttribute	LDAPLoginAttribute.CN	Controls whether users will provide a Common Name (cn) or Unique ID (uid) when authenticating against the LDAP server. CN - The user will provide a Common Name under the BaseDomainName. UID - The user will provide a Unique ID under the BaseDomainName.
LDAPUseSSL	bool	false	Use SSL to connect to the server.
LDAPUsernameAttribute	LDAPUsernameAttribute	LDAPUsernameAttribute.DN	Controls whether the Common Name (CN), Distinguished Name (DN), or Unique ID (UID) of the authenticated user will be captured as the authenticated username. CN - The Common Name of the user will be captured. DN - The Distinguished Name of the user will be captured. UID - The Unique ID of the user will be captured.

Property

Type

Default

Description

LDAPConnectionMethod

LDAPConnectionMethod.DirectoryEntry

Controls the mechanism utilized to authenticate the user against the LDAP server.

DirectoryEntry - Authenticates the user by resolving a directory entry with the provided credentials.

LDAPConnection - Authenticates the user by performing a bind against the server with the provided credentials.

LDAPCredentialPolicy

LDAPCredentialPolicy.UserCredentials

Whether to prompt the user for credentials or use the authenticated username from an upstream authentication provider. The AuthenticatedUsername option can only be used with an AuthenticationProviderLoginService.

LDAPGroupAttribute

string

Optionally specifies the name of an attribute to be captured from each group and retained as an authenticated role. By default, the roles obtained are the distinguished names of the groups (with the BaseDomainName removed) or the common names of the groups.

LDAPLoginAttribute

LDAPLoginAttribute.CN

Controls whether users will provide a Common Name (cn) or Unique ID (uid) when authenticating against the LDAP server.

CN - The user will provide a Common Name under the BaseDomainName.
UID - The user will provide a Unique ID under the BaseDomainName.

LDAPUseSSL

bool

false

Use SSL to connect to the server.

LDAPUsernameAttribute

LDAPUsernameAttribute.DN

Controls whether the Common Name (CN), Distinguished Name (DN), or Unique ID (UID) of the authenticated user will be captured as the authenticated username.

CN - The Common Name of the user will be captured.
DN - The Distinguished Name of the user will be captured.
UID - The Unique ID of the user will be captured.