LDAP User Registry (ldapRegistry)
Configuration properties for the LDAP user registry.
- activedFilters
- attributeConfiguration
- contextPool
- customFilters
- domino50Filters
- edirectoryFilters
- failoverServers
- idsFilters
- iplanetFilters
- ldapCache
- ldapEntityType
- netscapeFilters
- securewayFilters
Attribute name | Data type | Default value | Description |
---|---|---|---|
activedFiltersRef | A reference to top level activedLdapFilterProperties element (string). | Specifies the list of default Microsoft Active Directory LDAP filters. | |
baseDN | string | Base distinguished name (DN) of the directory service, which indicates the starting point for LDAP searches in the directory service. | |
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. | |
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}. | |
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.
|
|
connectTimeout | A period of time with millisecond precision | 1m | Maximum time for establishing a connection to the LDAP server. An error message will be logged 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. |
customFiltersRef | A reference to top level customLdapFilterProperties element (string). | Specifies the list of default Custom LDAP filters. | |
domino50FiltersRef | A reference to top level domino50LdapFilterProperties element (string). | Specifies the list of default IBM Lotus Domino LDAP filters. | |
edirectoryFiltersRef | A reference to top level edirectoryLdapFilterProperties element (string). | Specifies the list of Novell eDirectory LDAP filters. | |
host | string | Address of the LDAP server in the form of an IP address or a domain name service (DNS) name. | |
id | string | A unique configuration ID. | |
idsFiltersRef | A reference to top level idsLdapFilterProperties element (string). | Specifies the list of default IBM Tivoli Directory Server LDAP filters. | |
ignoreCase | boolean | true | Perform a case-insensitive authentication check. |
iplanetFiltersRef | A reference to top level iplanetLdapFilterProperties element (string). | Specifies the list of default Sun Java System Directory Server LDAP filters. | |
ldapType |
|
Type of LDAP server to which a connection will be established.
|
|
netscapeFiltersRef | A reference to top level netscapeLdapFilterProperties element (string). | Specifies the list of default Netscape Directory Server LDAP filters. | |
port | int | Port number of the LDAP server. | |
realm | string | LdapRegistry | The realm name that represents the user registry. |
recursiveSearch | boolean | false | Performs a nested group search. Select this option only if the LDAP server does not support recursive server-side searches. |
returnToPrimaryServer | boolean | true | A boolean value that indicates if the search should be done against the Primary Server. |
reuseConnection | boolean | true | Requests the application server to reuse the LDAP server connection. |
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. |
securewayFiltersRef | A reference to top level securewayLdapFilterProperties element (string). | Specifies the list of default IBM SecureWay Directory Server LDAP filters. | |
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. |
- activedFilters
Description: Specifies the list of default Microsoft Active Directory LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(objectcategory=group)) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(sAMAccountName=%v)(objectcategory=user)) An LDAP filter clause for searching the user registry for users. userIdMap string user:sAMAccountName An LDAP filter that maps the name of a user to an LDAP entry.
- attributeConfiguration
Description: The configuration that maps the LDAP attributes with the user registry schema (for example; Person, PersonAccount or Group) field names.Required: falseData type: - attributeConfiguration > attribute
Description: Define the user registry schema field names to be mapped to the LDAP attribute.Required: falseData type: Attribute name Data type Default value Description defaultValue string The default value of the attribute. entityType string The entity type of the attribute. 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. syntax string The attribute syntax.
- attributeConfiguration > externalIdAttribute
Description: Define the name of the LDAP attribute and its properties that needs to be mapped to the user registry externalId attribute.Required: falseData type: Attribute name Data type Default value Description 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. entityType string The entity type of the attribute. 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.
- contextPool
Description: Properties of the context pool.Required: falseData type: Attribute name Data type Default value 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. preferredSize int 3 The preferred size of the context pool. Set this based on the 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 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.
- customFilters
Description: Specifies the list of default Custom LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=groupOfURLs))) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(uid=%v)(objectclass=ePerson)) An LDAP filter clause for searching the user registry for users. userIdMap string *:uid An LDAP filter that maps the name of a user to an LDAP entry.
- domino50Filters
Description: Specifies the list of default IBM Lotus Domino LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(objectclass=dominoGroup)) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(uid=%v)(objectclass=Person)) An LDAP filter clause for searching the user registry for users. userIdMap string person:uid An LDAP filter that maps the name of a user to an LDAP entry.
- edirectoryFilters
Description: Specifies the list of Novell eDirectory LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(objectclass=groupOfNames)) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(cn=%v)(objectclass=Person)) An LDAP filter clause for searching the user registry for users. userIdMap string person:cn An LDAP filter that maps the name of a user to an LDAP entry.
- failoverServers
Description: List of LDAP failover servers.Required: falseData type: Attribute name Data type Default value 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>. - failoverServers > server
Description: Configuration properties for LDAP failover server.Required: falseData type: Attribute name Data type Default value Description host string LDAP server host name, which can be either an IP address or a domain name service (DNS) name. id string A unique configuration ID. port int LDAP failover server port.
- idsFilters
Description: Specifies the list of default IBM Tivoli Directory Server LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=groupOfURLs))) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(uid=%v)(objectclass=ePerson)) An LDAP filter clause for searching the user registry for users. userIdMap string *:uid An LDAP filter that maps the name of a user to an LDAP entry.
- iplanetFilters
Description: Specifies the list of default Sun Java System Directory Server LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(objectclass=ldapsubentry)) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(uid=%v)(objectclass=inetOrgPerson)) An LDAP filter clause for searching the user registry for users. userIdMap string inetOrgPerson:uid An LDAP filter that maps the name of a user to an LDAP entry.
- ldapCache
Description: Configure the attributes of the cache.Required: falseData type: - ldapCache > attributesCache
Description: The attribute cache properties configuration.Required: falseData type: Attribute name Data type Default value Description enabled boolean true A Boolean value to indicate that the property is enabled. 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. 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. sizeLimit int 2000 The size limit for the cache. timeout A period of time with millisecond precision 1200ms 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.
- ldapCache > searchResultsCache
Description: The configuration for the search results cache.Required: falseData type: Attribute name Data type Default value Description enabled boolean true A Boolean value to indicate that the property is enabled. resultsSizeLimit int 2000 The maximum number of results that can be returned in the search. 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 1200ms 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.
- ldapEntityType
Description: 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.Required: falseData type: Attribute name Data type Default value 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))". - ldapEntityType > objectClass
Description: 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.Required: falseData type: string
- ldapEntityType > searchBase
Description: 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.Required: falseData type: string
- netscapeFilters
Description: Specifies the list of default Netscape Directory Server LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames))) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(uid=%v)(objectclass=inetOrgPerson)) An LDAP filter clause for searching the user registry for users. userIdMap string inetOrgPerson:uid An LDAP filter that maps the name of a user to an LDAP entry.
- securewayFilters
Description: Specifies the list of default IBM SecureWay Directory Server LDAP filters.Required: falseData type: Attribute name Data type Default value Description groupFilter string (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames))) An LDAP filter clause for searching the user registry for groups. 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. userFilter string (&(uid=%v)(objectclass=ePerson)) An LDAP filter clause for searching the user registry for users. userIdMap string *:uid An LDAP filter that maps the name of a user to an LDAP entry.