This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Configuring Secondary User Stores

Owned by Former user (Deleted)
Jan 05, 2016
1 min read

By default, WSO2 products have a single, embedded user store. If required, you can configure WSO2 products to connect to multiple secondary user stores as well. After configuration, users from different stores can log in and perform operations depending on their roles/permissions. You can als o configure your own customized user stores and connect them with the products as secondary stores.

The topics below explain how to configure secondary user stores manually or using the management console: 

Tip: If you set up a database other than the default H2 that comes with the product to store user information, select the script relevant to your database type from the <PRODUCT_HOME>/dbscripts folder and run it on your database. It creates the necessary tables.

Configuring using the management console

  1. In the management console, click Configure, and then click User Store Management.

    The User Store Management page appears. Initially, there are no secondary user stores.

    Note: You cannot update the PRIMARY user store at run time, so it is not visible on this page.

  2. Click Add Secondary User Store.

  3. In the User Store Manager Class list, select the type of user store you are creating: 

    User store managerDescription
    org.wso2.carbon.user.core.ldap.ReadOnlyLDAPUserStoreManager

    Use ReadOnlyLDAPUserStoreManager to do read-only operations for LDAP user stores.

    org.wso2.carbon.user.core.ldap.ReadWriteLDAPUserStoreManager

    Use ReadWriteLDAPUserStoreManager for LDAP user stores to do both read and write operations.

    org.wso2.carbon.user.core.ldap.ActiveDirectoryUserStoreManager

    Use ActiveDirectoryUserStoreManager to configure an Active Directory Domain Service (AD DS) or Active Directory Lightweight Directory Service (AD LDS). This can be used only for read/write operations. If you need to use AD as read-only, you must use org.wso2.carbon.user.core.ldap.ReadOnlyLDAPUserStoreManager.

    org.wso2.carbon.user.core.jdbc.JDBCUserStoreManager

    Use JDBCUserStoreManager for JDBC user stores. The JDBC user store can be configured for read-only mode or read/write mode using the following property: <Property name="ReadOnly">false/true</Property>. 

    You can also populate this list with custom user store manager implementations by adding them to the server. A sample custom user store manager can be found in the repository.

  4. Enter a unique domain name with no underscore (_) characters, and optionally enter a description for this user store.

  5. Enter values for the properties, using the descriptions in the Descriptions column for guidance. The properties that appear vary based on the user store manager class you selected, and there may be additional properties in an Optional or Advanced section at the bottom of the screen.

     

  6. Ensure that all the mandatory fields are filled in and click  Add. 

  7. A message appears indicating that the server is updating the user stores. At this point, the server is attempting to add the new user store to the end of the available chain of stores.

  8. Refresh the page after a few seconds to verify that the user store was added successfully and now appears in the list of secondary user stores.

You can now edit the properties of the new secondary user store and enable/disable it as needed.

Configuring manually

By default, the configuration of the primary user store is saved in the <PRODUCT_HOME>/repository/conf/user-mgt.xml file. When you create a secondary user store using the management console as explained above, its configuration is saved to an XML file with the same name as the domain name you specify. Alternatively, you can create this XML file manually and save it using the following guidelines:

  • Each file must contain the definition for only one user store domain.
  • When you configure multiple user stores, you must give a unique domain name to each user store in the <DomainName> element. If you configure a user store without specifying a domain name, the server throws an exception at start up.
  • If it is the configuration of a super tenant, save the secondary user store definitions in the <PRODUCT_HOME>/repository/deployment/server/userstores directory.
  • If it is a general tenant, save the configuration in the <PRODUCT_HOME>/repository/tenants/<tenantid>/userstores directory.
  • The secondary user store configuration file must have the same name as the domain with an underscore (_) in place of the period. For example, if the domain is wso2.com,  name the file as follows: wso2_com.xml