Connecting to an Internal Directory with LDAP Authentication

Name

A descriptive name that will help you to identify the directory. Examples:

• Internal directory with LDAP Authentication
• Corporate LDAP for Authentication Only

Directory Type

Select the type of LDAP directory that you will connect to. If you are adding a new LDAP connection, the value you select here will determine the default values for some of the options on the rest of screen. Examples:

• Microsoft Active Directory
• OpenDS
• And more.

Hostname

The host name of your directory server. Examples:

• ad.example.com
• ldap.example.com
• opends.example.com

Port

The port on which your directory server is listening. Examples:

• 389
• 10389
• 636 (for example, for SSL)

Use SSL

Select this check box if the connection to the directory server is an SSL (Secure Sockets Layer) connection. Note that you will need to configure an SSL certificate in order to use this setting.

Username

The distinguished name of the user that the application will use when connecting to the directory server. Examples:

• cn=administrator,cn=users,dc=ad,dc=example,dc=com
• cn=user,dc=domain,dc=name
• user@domain.name

Password

The password of the user specified above.

Copy User on Login

This option affects what will happen when a user attempts to log in. If this check box is selected, the user will be created automatically in the internal directory that is using LDAP for authentication when the user first logs in and their details will be synchronised on each subsequent log in. If this check box is not selected, the user's login will fail.

If you select this check box the following additional fields will appear on the screen, which are described in more detail below:

• Default Group Memberships
• Synchronise Group Memberships
• User Schema Settings (described in a separate section below)

Default Group Memberships

This field appears if you select the Copy User on Login check box. If you would like users to be automatically added to a group or groups, enter the group name(s) here. To specify more than one group, separate the group names with commas. Each time a user logs in, their group memberships will be checked. If the user does not belong to the specified group(s), their username will be added to the group(s). If a group does not yet exist, it will be added to the internal directory that is using LDAP for authentication.

Please note that there is no validation of the group names. If you mis-type the group name, authorisation failures will result – users will not be able to access the applications or functionality based on the intended group name.

Examples:

• confluence-users
• bamboo-users,jira-users,jira-developers

Synchronise Group Memberships

This field appears if you select the Copy User on Login check box. If this check box is selected, group memberships specified on your LDAP server will be synchronised with the internal directory each time the user logs in.

If you select this check box the following additional fields will appear on the screen, both described in more detail below:

• Group Schema Settings (described in a separate section below)
• Membership Schema Settings (described in a separate section below)

Base DN

The root distinguished name (DN) to use when running queries against the directory server. Examples:

• o=example,c=com
• cn=users,dc=ad,dc=example,dc=com
• For Microsoft Active Directory, specify the base DN in the following format: dc=domain1,dc=local. You will need to replace the domain1 and local for your specific configuration. Microsoft Server provides a tool called ldp.exe which is useful for finding out and configuring the the LDAP structure of your server.

User Name Attribute

The attribute field to use when loading the username. Examples:

• cn
• sAMAccountName

Use Paged Results

Enable or disable the use of the LDAP control extension for simple paging of search results. If paging is enabled, the search will retrieve sets of data rather than all of the search results at once. Enter the desired page size – that is, the maximum number of search results to be returned per page when paged results are enabled. The default is 1000 results.

Follow Referrals

Choose whether to allow the directory server to redirect requests to other servers. This option uses the node referral (JNDI lookup java.naming.referral) configuration setting. It is generally needed for Active Directory servers configured without proper DNS, to prevent a 'javax.naming.PartialResultException: Unprocessed Continuation Reference(s)' error.

Additional User DN

This value is used in addition to the base DN when searching and loading users. If no value is supplied, the subtree search will start from the base DN. Example:

• ou=Users

User Object Class

This is the name of the class used for the LDAP user object. Example:

• user

User Object Filter

The filter to use when searching user objects. Example:

• (&(objectCategory=Person)(sAMAccountName=*))

User Name RDN Attribute

The RDN (relative distinguished name) to use when loading the username. The DN for each LDAP entry is composed of two parts: the RDN and the location within the LDAP directory where the record resides. The RDN is the portion of your DN that is not related to the directory tree structure. Example:

• cn

User First Name Attribute

The attribute field to use when loading the user's first name. Example:

• givenName

User Last Name Attribute

The attribute field to use when loading the user's last name. Example:

• sn

User Display Name Attribute

The attribute field to use when loading the user's full name. Example:

• displayName

User Email Attribute

The attribute field to use when loading the user's email address. Example:

• mail

Additional Group DN

This value is used in addition to the base DN when searching and loading groups. If no value is supplied, the subtree search will start from the base DN. Example:

• ou=Groups

Group Object Class

This is the name of the class used for the LDAP group object. Examples:

• groupOfUniqueNames
• group

Group Object Filter

The filter to use when searching group objects. Example:

• (objectCategory=Group)

Group Name Attribute

The attribute field to use when loading the group's name. Example:

• cn

Group Description Attribute

The attribute field to use when loading the group's description. Example:

• description

Group Members Attribute

The attribute field to use when loading the group's members. Example:

• member

User Membership Attribute

The attribute field to use when loading the user's groups. Example:

• memberOf

Use the User Membership Attribute, when finding the user's group membership

Select the check box if your directory server supports the group membership attribute on the user. (By default, this is the 'memberOf' attribute.)

• If this check box is selected, your application will use the group membership attribute on the user when retrieving the members of a given group. This will result in a more efficient retrieval.
• If this check box is not selected, your application will use the members attribute on the group ('member' by default) for the search.