Record - ldap : LdapConnectionConfig

Represents the configurations that are required for an LDAP auth store.

Fields

  • domainName string
  • Unique name to identify the user store

  • connectionURL string
  • Connection URL of the LDAP server

  • connectionName string
  • The username used to connect to the LDAP server

  • connectionPassword string
  • The password used to connect to the LDAP server

  • userSearchBase string
  • DN of the context or object under which the user entries are stored in the LDAP server

  • userEntryObjectClass string
  • Object class used to construct user entries

  • userNameAttribute string
  • The attribute used for uniquely identifying a user entry

  • userNameSearchFilter string
  • Filtering criteria used to search for a particular user entry

  • userNameListFilter string
  • Filtering criteria for searching user entries in the LDAP server

  • groupSearchBase string[]
  • DN of the context or object under which the group entries are stored in the LDAP server

  • groupEntryObjectClass string
  • Object class used to construct group entries

  • groupNameAttribute string
  • The attribute used for uniquely identifying a group entry

  • groupNameSearchFilter string
  • Filtering criteria used to search for a particular group entry

  • groupNameListFilter string
  • Filtering criteria for searching group entries in the LDAP server

  • membershipAttribute string
  • Define the attribute, which contains the distinguished names (DN) of user objects that are there in a group

  • userRolesCacheEnabled boolean (default false)
  • To indicate whether to cache the role list of a user

  • connectionPoolingEnabled boolean (default true)
  • Define whether LDAP connection pooling is enabled

  • connectionTimeoutInMillis int (default 5000)
  • Timeout (in milliseconds) in making the initial LDAP connection

  • readTimeoutInMillis int (default 60000)
  • Reading timeout in milliseconds for LDAP operations

  • retryAttempts int (default 0)
  • Retry the authentication request if a timeout happened

  • secureSocket SecureSocket
  • The SSL configurations for the LDAP client socket. This needs to be configured in order to communicate through LDAPs