Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

The default configuration of WSO2 products has a single user store. If required,

...

you can configure WSO2 products to connect to

...

several secondary user stores as well. After configuration,

...

users

...

from different stores can log in and perform operations depending on their roles/permissions.

...

To configure multiple user stores:

...

The default view is as follows, when there are no multiple user stores defined. 

...

You can also configure your own customized user stores and connect them with the products as secondary stores.

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

Table of Contents
maxLevel4
minLevel4

Configuring using the management console

  1. Log in to the management console and click User Store Management sub menu under Configure menu.
  2. The User Store Management page opens. Initially, there are no secondary user stores.

    Info

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

    Image Removed

     

  3. When you click the '
  4. Click Add Secondary User Store

  5. ' link, a form is provided to define the user stores.
    Image RemovedFirst
  6. .

  7. The User Store Manager page opens. Enter a unique domain name and fill in the rest of the data.

    Info

    Do not include underscore character (_) in domain names.

    For details on each property, see the respective property description that is provided. Also, select the required implementation of user store manager from

  8. the drop-down menu
  9. the User Store Manager Class drop-down list. The displayed property list varies depending on the selected user store manager implementation. By default, all

  10. the Carbon
  11. WSO2 products come with four user store manager implementations

  12. .
  13. as follows:

    • ReadWriteLDAPUserStoreManager
    • ReadOnlyLDAPUserStoreManager
    • ActiveDirectoryUserStoreManager
    • JDBCUserStoreManager
  14. Additionally, if you want other
  15. You can also populate this drop-down list with custom user store manager implementations

  16. to be available, it is also possible
  17. by adding them to the server. A sample custom user store manager can be found

  18. in
  19. in the repository.

  20. Once it is added to the server it also appears in this drop-down menu.
  21. Once you select the preferred user store manager implementation, look through and fill the list of properties that can be specified. As shown in the following image, it also provides a description of what each property stands for.
    Image Removed
  22. Provide a unique domain name and fill all the mandatory fields with the values corresponding to the user store. 

    Info

    Domain name should not include the '_' (underscore) character.

  23. Click Add. If all the mandatory parameters
  24. Image Added

     

  25. Ensure that all the mandatory fields are filled and a valid domain name is

  26. provided, the following notification displays. At this moment, WSO2 Identity Server is attempting to add the new user store to the available chain of user stores.
    Image Removed

    This is added to the very end of the chain of user stores. 

    InfoAlso note that this
  27. given and click Add

  28. A message appears saying that the user stores are being added. 
    Image Added

    Info

    Note: The above message does not imply that the user store is added successfully. This can be checked in the following stepIt simply means that the server is attempting to add the new user store to the end of the available chain of stores.

  29. Refresh the page

    to see

    after a few seconds to check the status. 

  30. If the new user store

    in the table, if it

    is successfully added

    .
    Image Removed

...

  1. , it will appear in the User Store Management page.

  2. After adding to the server, you can edit the properties of the

...

  1. new secondary user

...

  1. store and enable/disable

...

  1. it in a dynamic manner.

...

Configuring manually

By default, the configuration of the primary user store is saved in the user-mgt.xml manually and just drop it to the relevant configuration folder. file. When you create a secondary user store, its configuration is saved to an XML file with the same name as the domain you specified. If required, you can create this XML file manually and save it as follows:

    • If it is configuration of a super tenant, save the secondary user store definitions
  • should go to 'CARBON_HOME
    • in <PRODUCT_HOME>/repository/deployment/server/
  • userstores'
    • userstores directory. For example, if you want to name your secondary userstore as "WSO2", save the user store definition as WSO2.xml.
    • If it is a general tenant, save the configuration
  • should go to 'CARBON_HOME
    • in <PRODUCT_HOME>/repository/tenants/<tenantid>/
  • userstores'
    • userstores directory.
  • Also the file name needs to be in accordance with the domain name to avoid conflicts (e.g.: if domain name is
    • 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
  • name of the configuration file should be
    • as  wso2_com.xml
  • )
    • .
    • One file only contains the definition for one user store domain.

...