Sun Java System Federation Manager 7.0 User's Guide

Active Directory

Active Directory authentication relies on the use of an LDAPv3–compliant server. This module type works similarly to the LDAP authentication module type, but uses the Microsoft Active Directory. Using this module type makes it possible for LDAP and Active Directory to coexist. The attributes are:

Primary Active Directory Server

Specifies the host name and port number of the primary Active Directory server specified during Federation Manager installation. This is the first server contacted for Active Directory authentication. The format is hostname:port. If there is no port number, assume 389. Multiple entries must be prefixed by the local server name.

If you have Federation Manager deployed with multiple domains, you can specify the communication link between specific instances of Federation Manager and Active Directory in the following format:

local-servername|server:port local-servername2|server2:port2 ...

For example, if you have two instances deployed in different locations (L1-machine1-IS and L2- machine2-IS) communicating with different instances of Active Directory (L1-machine1-DS and L2-machine2-DS), it would look like the following:||

Secondary Active Directory Server

Specifies the host name and port number of a secondary Active Directory server available to the Federation Manager platform. If the primary Active Directory server does not respond to a request for authentication, this server would then be contacted. If the primary server is up, Federation Manager will switch back to the primary server. The format is also hostname:port. Multiple entries must be prefixed by the local server name.

Caution – Caution –

When authenticating users from a data store that is remote, it is important that both the Primary and Secondary LDAP Server Ports have values. The value for one data store location can be used for both fields.

DN To Start User Search

Specifies the DN of the node where the search for a user would start. (For performance reasons, this DN should be as specific as possible.) The default value is the root of the directory tree. Any valid DN will be recognized. If OBJECT is selected in the Search Scope attribute, the DN should specify one level above the level in which the profile exists. Multiple entries must be prefixed by the local server name. The format is servername|search-dn. For multiple entries:

servername1|search-dn servername2|search-dn servername3|search-dn

If multiple users are found for the same search, authentication will fail.

DN for Root User Bind

Specifies the DN of the user that will be used to bind to the Directory Server specified in the Primary LDAP Server and Port field as administrator. The authentication service needs to bind as this DN in order to search for a matching user DN based on the user login ID. The default is amldapuser. Any valid DN will be recognized.

Make sure that password is correct before you logout. If it is incorrect, you will be locked out. If this should occur, you can login with the super user DN in the com.iplanet.authentication.super.user property in the AMConfig.Properties file. By default, this is the amAdmin account with which you would normally log in, although you will use the full DN. For example:


Password for Root User Bind

Carries the password for the administrator profile specified in the DN for Root User Bind field. There is no default value. Only the administrator's valid Active Directory password is recognized.

Password for Root User Bind (confirm)

Confirm the password.

Attribute Used to Retrieve User Profile

Specifies the attribute used for the naming convention of user entries. By default, Federation Manager assumes that user entries are identified by the uid attribute. If your data store uses a different attribute (such as givenname) specify the attribute name in this field.

Attributes Used to Search for a User to be Authenticated

Lists the attributes to be used to form the search filter for a user that is to be authenticated, and allows the user to authenticate with more than one attribute in the user's entry. For example, if this field is set to uid, employeenumber, and mail, the user could authenticate with any of these names.

User Search Filter

Specifies an attribute to be used to find the user under the DN to Start User Search field. It works with the User Naming Attribute. There is no default value. Any valid user entry attribute will be recognized.

Search Scope

Indicates the number of levels in the Directory Server tree that will be searched for a matching user profile. The search begins from the node specified in DN to Start User Search. The default value is SUBTREE. One of the following choices can be selected:


Searches only the specified node.


Searches at the level of the specified node and one level down.


Search all entries at and below the specified node.

Enable SSL Access To Active Directory Server

Enables SSL access to the Directory Server specified in the Primary and Secondary Server and Port field. By default, the box is not checked and the SSL protocol will not be used to access the Directory Server.

If the Active Directory server is running with SSL enabled (LDAPS), you must make sure that Federation Manager is configured with proper SSL trusted certificates so that it may connect using LDAPS protocol.

Return User DN to Authenticate

If enabled, this option allows the Active Directory authentication module instance to return the DN instead of the User ID, and no search is necessary. Normally, an authentication module instance returns only the User ID, and the authentication service searches for the user in the local instance. If an external Active Directory is used, this option is typically not enabled.

Active Directory Server Check Interval

This attribute is used for Active Directory Server failback. It defines the number of minutes in which a thread will sleep before verifying that the primary Active Directory server is running.

User Creation Attributes

This attribute is used by the Active Directory authentication module instance when the Active Directory server is configured as an external Active Directory server. It contains a mapping of attributes between a local and an external Directory Server. This attribute has the following format:



When this attribute is populated, the values of the external attributes are read from the external Directory Server and are set for the internal Directory Server attributes. The values of the external attributes are set in the internal attributes only when the User Profileattribute (in the Core Authentication module type) is set to Dynamically Created and the user does not exist in local Directory Server instance. The newly created user will contain the values for internal attributes, as specified in User Creation Attributes List, with the external attribute values to which they map.

Authentication Level

The authentication level is set separately for each method of authentication. The value indicates how much to trust an authentication mechanism. Once a user has authenticated, this value is stored in the SSO token for the session. When the SSO token is presented to an application the user wants to access, the application uses the stored value to determine whether the level is sufficient to grant the user access. If the authentication level stored in an SSO token does not meet the minimum value required, the application can prompt the user to authenticate again through a service with a higher authentication level. The default value is 0.

Note –

If no authentication level is specified, the SSO token stores the value specified in the Core Authentication attribute Default Authentication Level.