LDAP Connection Properties

The following properties are available for LDAP Connection objects, grouped by the categories shown in the connection editors.

Information

Property Type Default Description

ID

string

The string value that uniquely identifies the metadata.

Name

string

The name of the metadata object.

Misc

Property Type Default Description

LDAPAdminOrganizationalUnit
displayed as AdminOrganizationalUnit

string

The LDAP or Active Directory organizational unit used when authenticating for operations that require administrator privileges.

The administrator organizational unit is only required when using "LDAP / OpenLDAP" for the LDAPImplementationType.

Refer to the LDAPAdminUsername setting for additional information.

LDAPAdminPassword
displayed as AdminPassword

string

The LDAP or Active Directory password used for operations that require administrator privileges.

Refer to the LDAPAdminUsername setting for additional information.

LDAPAdminUsername
displayed as AdminUsername

string

The LDAP or Active Directory username used for operations that require administrator privileges.

The administrator credentials are required and used for the following:

  • For both LDAP / OpenLDAP and Active Directory, administrator privileges are required when using the LDAPUserRolesFromGroupNames Authentication Service to search for valid groups and users on the server.

  • For LDAP / OpenLDAP, administrator privileges are required to perform a lookup of a user’s Distinguished Name when using the LDAPUserRolesFromSQLPassthroughDataSet Authentication Service.

  • For Active Directory, no administrator privileges are required when using the LDAPUserRolesFromSQLPassthroughDataSet Authentication Service.

LDAPBaseDomainName
displayed as BaseDomainName

string

The Base Domain Name LDAP or Active Directory users will be authenticating against.

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.

LDAPCredentialDomainPolicy
displayed as CredentialDomainPolicy

LDAPCredentialDomainPolicy

LDAPCredentialDomainPolicy.WindowsDomain

Controls whether the current Windows domain will be used when constructing network credentials for binding to LDAP.

"Domainless" specifies that no domain information will be attached to the network credentials. "WindowsDomain" specifies that the current domain will be attached to the netowork 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.

LDAPImplementationType
displayed as ImplementationType

LDAPImplementationType

LDAPImplementationType.ActiveDirectory

The Implementation Type of the LDAP connection.

"Active Directory" specifies a Microsoft Active Directory connection.

"LDAP / OpenLDAP" specifies an OpenLDAP or generic LDAP connection.

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.

LDAPPageSize
displayed as PageSize

int

1000

The Page Size to be used when returning results from the LDAP Server.

LDAPProtocolType
displayed as Protocol

LDAPProtocolType

LDAPProtocolType.TCP_IP

The protocol that will be used to connect to LDAP or Active Directory.

LDAPServerName
displayed as ServerName

string

The name of the LDAP or Active Directory server.

LDAPServerPort
displayed as ServerPort

int

389

The port of the LDAP or Active Directory server.

LDAPServerResolutionPolicy
displayed as ServerResolutionPolicy

LDAPServerResolutionPolicy

LDAPServerResolutionPolicy.HostName

The server resolution policy that will be used to resolve the LDAPServerName.

LDAPUseSSL
displayed as __

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.

Test

Property Type Default Description

TestTokens

TokenTable