Configuration properties for the LDAP user registry.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
host | string | Address of the LDAP server in the form of an IP address or a domain name service (DNS) name. | |
port | int | Port number of the LDAP server. | |
baseDN | string | Base distinguished name (DN) of the directory service, which indicates the starting point for LDAP searches in the directory service. | |
ldapType |
| Type of LDAP server to which a connection is established. IBM SecureWay Directory Server Configure the LDAP registry to use IBM SecureWay Directory Server. Microsoft Active Directory Configure the LDAP registry to use Microsoft Active Directory. Novell eDirectory Configure the LDAP registry to use Novell eDirectory. IBM Lotus Domino Configure the LDAP registry to use IBM Lotus Domino. Netscape Directory Server Configure the LDAP registry to use Netscape Directory Server. Custom Configure the LDAP registry to use a custom LDAP server. Sun Java System Directory Server Configure the LDAP registry to use Sun Java System Directory Server. IBM Tivoli Directory Server %ldapType.ibm_dir_server | |
realm | string | LdapRegistry | The realm name that represents the user registry. |
bindDN | string | Distinguished name (DN) for the application server, which is used to bind to the directory service. | |
bindPassword | Reversably encoded password (string) | Password for the bind DN. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option. | |
ignoreCase | boolean | true | Perform a case-insensitive authentication check. |
recursiveSearch | boolean | false | Performs a nested group search. Select this option only if the LDAP server does not support recursive server-side searches. |
reuseConnection | boolean | true | Requests the application server to reuse the LDAP server connection. |
sslEnabled | boolean | false | Indicates whether an SSL connection should be made to the LDAP server. |
sslRef | A reference to top level ssl element (string). | ID of the SSL configuration to be used to connect to the SSL-enabled LDAP server. | |
searchTimeout | A period of time with millisecond precision | 1m | Maximum time for an LDAP server to respond before a request is canceled. This is equivalent to a read timeout once the connection is established. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
connectTimeout | A period of time with millisecond precision | 1m | Maximum time for establishing a connection to the LDAP server. The program logs an error message if the specified time expires. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
certificateMapMode |
| Specifies whether to map x.509 certificates into an LDAP directory by EXACT_DN or CERTIFICATE_FILTER. Specify CERTIFICATE_FILTER to use the specified certificate filter for the mapping. EXACT_DN The program attempts the login by mapping the PrincipalName value in the X.509 certificate to the exact distinguished name (DN) in the repository. If a matching entity is found, the login is successful. If a matching entity is not found, the login fails, and the program returns an error that states that the entity is not found. CERTIFICATE_FILTER The program attempts the login by using the certificate filter mapping property for the LDAP filter. If a single matching entity is found, the login is successful. If no matching entity is found, the login fails, and the program returns an error. If more than one matching entity is found, the login fails because the result is an ambiguous match, and the program returns an error. | |
certificateFilter | string | Specifies the filter certificate mapping property for the LDAP filter. The filter is used to map attributes in the client certificate to entries in the LDAP registry. For example, the filter can be specified as: uid=${SubjectCN}. | |
activedFiltersRef | A reference to top level activedLdapFilterProperties element (string). | Specifies the list of Microsoft Active Directory LDAP filters. | |
customFiltersRef | A reference to top level customLdapFilterProperties element (string). | Specifies the list of Custom LDAP filters. | |
domino50FiltersRef | A reference to top level domino50LdapFilterProperties element (string). | Specifies the list of IBM Lotus Domino LDAP filters. | |
edirectoryFiltersRef | A reference to top level edirectoryLdapFilterProperties element (string). | Specifies the list of Novell eDirectory LDAP filters. | |
idsFiltersRef | A reference to top level idsLdapFilterProperties element (string). | Specifies the list of IBM Tivoli Directory Server LDAP filters. | |
iplanetFiltersRef | A reference to top level iplanetLdapFilterProperties element (string). | Specifies the list of Sun Java System Directory Server LDAP filters. | |
netscapeFiltersRef | A reference to top level netscapeLdapFilterProperties element (string). | Specifies the list of Netscape Directory Server LDAP filters. | |
securewayFiltersRef | A reference to top level securewayLdapFilterProperties element (string). | Specifies the list of IBM SecureWay Directory Server LDAP filters. | |
referral |
| ignore | Specify the behavior for LDAP referrals. The default behavior is to ignore referrals. ignore Ignore LDAP referrals. follow Follow LDAP referrals. |
returnToPrimaryServer | boolean | true | A boolean value that indicates if the search should be done against the Primary Server. |
List of LDAP failover servers.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | Configuration properties for LDAP failover servers. Specify it as a backup server for the primary LDAP servers. For example, <failoverServers name="failoverLdapServers"><server host="myfullyqualifiedhostname1" port="389"/><server host="myfullyqualifiedhostname2" port="389"/></failoverServers>. |
Configuration properties for LDAP failover server.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
host | string | LDAP server host name, which can be either an IP address or a domain name service (DNS) name. | |
port | int | LDAP failover server port. |
Specifies the list of Microsoft Active Directory LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(sAMAccountName=%v)(objectcategory=user)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(objectcategory=group)) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | user:sAMAccountName | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | memberOf:member | An LDAP filter that identifies user to group memberships. |
Specifies the list of Custom LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(uid=%v)(objectclass=ePerson)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=groupOfURLs))) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | *:uid | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | ibm-allGroups:member;ibm-allGroups:uniqueMember;groupOfNames:member;groupOfUniqueNames:uniqueMember | An LDAP filter that identifies user to group memberships. |
Specifies the list of IBM Lotus Domino LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(uid=%v)(objectclass=Person)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(objectclass=dominoGroup)) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | person:uid | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | dominoGroup:member | An LDAP filter that identifies user to group memberships. |
Specifies the list of Novell eDirectory LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(cn=%v)(objectclass=Person)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(objectclass=groupOfNames)) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | person:cn | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | groupOfNames:member | An LDAP filter that identifies user to group memberships. |
Specifies the list of IBM Tivoli Directory Server LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(uid=%v)(objectclass=ePerson)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=groupOfURLs))) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | *:uid | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | ibm-allGroups:member;ibm-allGroups:uniqueMember;groupOfNames:member;groupOfUniqueNames:uniqueMember | An LDAP filter that identifies user to group memberships. |
Specifies the list of Sun Java System Directory Server LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(uid=%v)(objectclass=inetOrgPerson)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(objectclass=ldapsubentry)) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | inetOrgPerson:uid | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | nsRole:nsRole | An LDAP filter that identifies user to group memberships. |
Specifies the list of Netscape Directory Server LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(uid=%v)(objectclass=inetOrgPerson)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames))) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | inetOrgPerson:uid | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | groupOfNames:member;groupOfUniqueNames:uniqueMember | An LDAP filter that identifies user to group memberships. |
Specifies the list of IBM SecureWay Directory Server LDAP filters.
Name | Type | Default | Description |
---|---|---|---|
userFilter | string | (&(uid=%v)(objectclass=ePerson)) | An LDAP filter clause for searching the user registry for users. |
groupFilter | string | (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames))) | An LDAP filter clause for searching the user registry for groups. |
userIdMap | string | *:uid | An LDAP filter that maps the name of a user to an LDAP entry. |
groupIdMap | string | *:cn | An LDAP filter that maps the name of a group to an LDAP entry. |
groupMemberIdMap | string | groupOfNames:member;groupOfUniqueNames:uniqueMember | An LDAP filter that identifies user to group memberships. |
Configure the LDAP object class, search filters, search bases and LDAP relative distinguished name (RDN) for Person, Group and Organizational Unit. For example, the Group entity type can have a search filter such as (&(ObjectCategory=Groupofnames)(ObjectClass=Groupofnames)) and the object class as Groupofnames with search base ou=iGroups,o=ibm,c=us.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | The name of the LDAP entity type. | |
searchFilter | string | A custom LDAP search expression used while searching for entity types. For example, searchFilter="(|(ObjectCategory=User)(ObjectClass=User))". |
The object class defined for the given LDAP entity type in the LDAP server. For example, the object class for the group LDAP entity type can be Groupofnames.
Specify the sub tree of the LDAP server for the search call for the given entity type which will override the base DN in search operations. For example, if the base DN is o=ibm,c=us and the search base for the PersonAccount entity type is defined to be ou=iUsers,o=ibm,c=us, then all search calls for PersonAccout will be made under subtree ou=iUsers,o=ibm,c=us. Multiple search bases can be configured for the same entity type.
The configuration for group membership properties (for example; memberAttribute or membershipAttribute).
groupProperties > memberAttribute
The LDAP member attribute.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | The name of the member. | |
objectClass | string | The object class of the member attribute. | |
scope | string | The scope of the member attribute. | |
dummyMember | string | The name of the dummy member. |
groupProperties > membershipAttribute
The configuration for the membership attribute.
Name | Type | Default | Description |
---|---|---|---|
name | string | The name of the membership attribute. | |
scope | string | The scope of the membership attribute. |
groupProperties > dynamicMemberAttribute
The configuration for the dynamic member attribute.
Name | Type | Default | Description |
---|---|---|---|
name | string | The name of the member. | |
objectClass | string | The name of the object class. |
The configuration that maps the LDAP attributes with the user registry schema (for example; Person, PersonAccount or Group) field names.
attributeConfiguration > attribute
Define the user registry schema field names to be mapped to the LDAP attribute.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | The name of the LDAP attribute. | |
propertyName | string | The user registry schema field name that needs to be mapped with the LDAP attribute. | |
defaultValue | string | The default value of the attribute. | |
syntax | string | The attribute syntax. | |
entityType | string | The entity type of the attribute. |
attributeConfiguration > externalIdAttribute
Define the name of the LDAP attribute and its properties that needs to be mapped to the user registry externalId attribute.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | The name of the LDAP attribute to be used for the user registry externalId attribute. | |
syntax | string | The attribute syntax. | |
entityType | string | The entity type of the attribute. | |
autoGenerate | boolean | false | When enabled, the externalId attribute value is generated automatically by the user registry instead of using the value that is stored in LDAP. By default it is disabled. |
Properties of the context pool.
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | A boolean value that determines if the context pool is enabled. Disabling it can cause performance degradation. |
initialSize | int | 1 | An integer value that determines the initial size of the context pool. Set this based on the load on the repository. |
maxSize | int | 0 | An integer value that defines the maximum context pool size. Set this based on the maximum load on the repository. |
timeout | A period of time with millisecond precision | 0s | The duration after which the context pool times out. An integer that represents the time that an idle context instance can remain in the pool without being closed and removed from the pool. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s) or milliseconds (ms). For example, specify 1 second as 1s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 1.5 minutes. The minimum timeout allowed is 1 second. Millisecond entries are rounded to the nearest second. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
waitTime | A period of time with millisecond precision | 3s | The duration after which the context pool times out. The time interval that the request waits until the context pool checks again if an idle context instance is available in the pool when the number of context instances reaches the maximum pool size. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
preferredSize | int | 3 | The preferred size of the context pool. Set this based on the load on the repository. |
Configure the attributes of the cache.
The attribute cache properties configuration.
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | A Boolean value to indicate that the property is enabled. |
size | int | 2000 | Defines the number of entities that can be stored in the cache. You can increase the size of the cache based on the number of entities that are required to be stored in the cache. |
timeout | A period of time with millisecond precision | 1200s | Defines the maximum time that the contents of the LDAP attribute cache are available. When the specified time has elapsed, the LDAP attribute cache is cleared. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
sizeLimit | int | 2000 | The maximum number of attributes per LDAP entity that will be cached. |
serverTTLAttribute | string | The time after which a cache entry expires. The subsequent call for this entry will be fetched directly from the server and then placed again in the cache. |
ldapCache > searchResultsCache
The configuration for the search results cache.
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | A Boolean value to indicate that the property is enabled. |
size | int | 2000 | The size of the cache. The number of search results that are stored in the cache. This needs to be configured based on the number of search queries executed on the system and the hardware system resources available. |
timeout | A period of time with millisecond precision | 1200s | Defines the maximum time that the contents of the search results cache are available. When the specified time has elapsed, the search results cache is cleared. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
resultsSizeLimit | int | 2000 | The maximum number of results that can be cached for a single LDAP search. |