If the directory/file paths specified in this guide do not exist in your WSO2 product, see Directory Structure of WSO2 Products to locate the paths applicable to your product.

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Uncomment the following user store in the <PRODUCT_HOME>/repository/conf/user-mgt.xml file:
    <UserStoreManager class="org.wso2.carbon.user.core.ldap.ReadOnlyLDAPUserStoreManager">. Also, ensure that you comment out the configurations for any other user stores in the same file. 

  2. Given below is a sample for the LDAP/AD user store configuration in read-only mode. You can change the values to match your LDAP/AD. For descriptions on each of the properties used in the <PRODUCT_HOME>/repository/conf/user-mgt.xml file which are used for configuring the primary user store, see Properties of User Stores.

    Code Block
       <UserStoreManager class="org.wso2.carbon.user.core.ldap.ReadOnlyLDAPUserStoreManager"> 
                <Property name="TenantManager">org.wso2.carbon.user.core.tenant.CommonHybridLDAPTenantManager</Property>
                 <Property name="ReadOnly">true<ConnectionURL">ldap://localhost:10389</Property> 
                <Property name="Disabled">false<ConnectionName">uid=admin,ou=system</Property> 
                <Property name="MaxUserNameListLengthConnectionPassword">100<>admin</Property>
                 <Property name="ConnectionURLAnonymousBind">ldap://localhost:10389&lt</>false</Property>
                 <Property name="ConnectionName">uid=admin,ouUserSearchBase">ou=system</Property>
                 <Property name="ConnectionPasswordUserNameAttribute">admin<>uid</Property> 
                <Property name="PasswordHashMethod">PLAIN_TEXT</Property> UserNameSearchFilter">(&amp;(objectClass=person)(uid=?))</Property>
                <Property name="UserSearchBaseUserNameListFilter">ou=system<>(objectClass=person)</Property> 
                <Property name="UserNameListFilterDisplayNameAttribute">(objectClass=person)</Property>/>
                 <Property name="UserNameSearchFilter">(&amp;(objectClass=person)(uid=?))</Property> ReadGroups">true</Property>
                <Property name="UserNameAttributeGroupSearchBase">uid<>ou=system</Property>
                 <Property name="ReadGroupsGroupNameAttribute">true<>cn</Property>
                 <Property name="GroupSearchBase">ou=system</Property> GroupNameSearchFilter">(&amp;(objectClass=groupOfNames)(cn=?))</Property>
                <Property name="GroupNameListFilter">(objectClass=groupOfNames)</Property>
                 <Property name="GroupNameSearchFilter">(&amp;(objectClass=groupOfNames)(cn=?))<MembershipAttribute">member</Property>
                 <Property name="GroupNameAttributeBackLinksEnabled">cn<>false</Property>
                 <Property name="SharedGroupNameAttribute">cn<UsernameJavaRegEx">[a-zA-Z0-9._-|//]{3,30}$</Property>
                 <Property name="SharedGroupSearchBase">ou=SharedGroups,dc=wso2,dc=org<PasswordJavaRegEx">^[\S]{5,30}$</Property>
                <Property name="RolenameJavaRegEx">[a-zA-Z0-9._-|//]{3,30}$</Property>
                 <Property name="SharedGroupNameListFilter">(objectClass=groupOfNames)<SCIMEnabled">false</Property>
                 <Property name="SharedTenantNameListFilter">(objectClass=organizationalUnit)<PasswordHashMethod">PLAIN_TEXT</Property>
                 <Property name="SharedTenantNameAttributeMultiAttributeSeparator">ou<>,</Property>
                 <Property name="SharedTenantObjectClassMaxUserNameListLength">organizationalUnit<>100</Property>
                 <Property name="MembershipAttributeMaxRoleNameListLength">member<>100</Property> 
                <Property name="UserRolesCacheEnabled">true</Property>
                 <Property name="ReplaceEscapeCharactersAtUserLoginConnectionPoolingEnabled">true</Property>
                 <Property name="MaxRoleNameListLengthLDAPConnectionTimeout">100<>5000</Property>
                <Property name="ReadTimeout"/>
                <Property name="MaxUserNameListLengthRetryAttempts">100</Property> >
                <Property name="SCIMEnabledReplaceEscapeCharactersAtUserLogin">false<>true</Property> 
    1. Update the connection details to match your user store. For example:

      Code Block
      <Property name="ConnectionURL">ldap://localhost:10389</Property>

      For Active Directory, the connectionURL should have the following format:

      Code Block
      <Property name="ConnectionURL">ldap://<AD host-ip>:<AD_listen_port></Property>

      If you are using ldaps (secured) to connect to the Active Directory as shown below, you need to import the certificate of Active Directory to the client-truststore.jks of the WSO2 product. See the topic on configuring keystores for information on how to add certificates to the trust-store.

      Code Block
      <Property name="ConnectionURL">ldaps://</Property>
    2. Obtain a user who has permission to read all users/attributes and perform searches on the user store from your LDAP/Active Directory administrator. For example, if the privileged user is AdminLDAP and the password is 2010#Avrudu, update the following sections of the user store configuration as shown below. Note that this user does NOT have to be the system administrator that you define here.

      Code Block
      <Property name="ConnectionName">uid=AdminLDAP,ou=system</Property>
      <Property name="ConnectionPassword">2010#Avrudu</Property>
    3. Update <Property name="UserSearchBase"> with the directory name where the users are stored. When LDAP searches for users, it will start from this location of the directory.

      Code Block
      <Property name="UserSearchBase">ou=system</Property> 
    4. Set the attribute to use as the username, typically either cn or uid for LDAP. Ideally, <Property name="UserNameAttribute"> and <Property name="UserNameSearchFilter"> should refer to the same attribute. If you are not sure what attribute is available in your user store, check with your LDAP/Active Directory administrator. 

      For example:

      Code Block
      <Property name="UserNameAttribute">uid</Property>
    5. Set the ReadGroups property to 'true', if it should be allowed to read roles from this user store. When this property is 'true', you must also specify values for the GroupSearchBase, GroupSearchFilter and GroupNameAttribute properties. If the ReadGroups property is set to 'false', only Users can be read from the user store. You can set the configuration to read roles from the user store by reading the user/role mapping based on a membership (user list) or backlink attribute as shown below.

      To read the user/role mapping based on a membership (This is used by the ApacheDirectory server and OpenLDAP)

      • Enable the ReadGroups property.

        Code Block
        <Property name="ReadGroups">true</Property>
      • Set the GroupSearchBase property to the directory name where the Roles are stored. That is, the roles you create using the management console of your product will be stored in this directory location. Also, when LDAP searches for users, it will start from this location of the directory. For example:

        Code Block
        <Property name="GroupSearchBase">ou=system,CN=Users,DC=wso2,DC=test</Property>
      • Set the GroupSearchFilter and GroupNameAttributes. For example:

        Code Block
        <Property name="GroupSearchFilter">(objectClass=groupOfNames)</Property>
        <Property name="GroupNameAttribute">cn</Property>
      • Set the MembershipAttribute property as shown below:

        Code Block
        <Property name="MembershipAttribute">member</Property> 

      To read roles based on a backlink attribute, use the following code snipet instead of the above:

      Code Block
      <Property name="ReadGroups">false</Property>
      <Property name="GroupSearchBase">ou=system</Property>
      <Property name="GroupSearchFilter">(objectClass=groupOfNames)</Property>
      <Property name="GroupNameAttribute">cn</Property>
      <Property name="MembershipAttribute">member</Property>
      <Property name="BackLinksEnabled">true</Property>
      <Property name="MembershipOfAttribute">memberOf</Property> 
    6. For Active Directory, you can use <Property name="Referral">follow</Property> to enable referrals within the user store. The AD user store may be partitioned into multiple domains. However, according to the use store configurations in the user-mgt.xml file, we are only connecting to one of the domains. Therefore, when a request for an object is received to the user store, the <Property name="Referral">follow</Property> property ensures that all the domains in the directory will be searched to locate the requested object.