Every WSO2 product comes with an embedded, internal user store, which is configured in <PRODUCT_HOME>/repository/conf/user-mgt.xml. In WSO2 Identity Server, the embedded user store is LDAP, and in other products it is JDBC. This user store is called a "primary user store" because the domain name (unique identifier) of this default user store is set to PRIMARY by default.
This is the main user store in the system and shared among all the tenants in the system. Only one user store should be configured as the primary user store. This documentation explains the process of setting up a primary user store. If you need more information on WSO2 Carbon user stores see Configuring User Stores.
...
Instead of using the embedded user store that comes with the product, you can set your own user store as the primary user store.
Setting up the primary user store
Primary user store is configured in the <PRODUCT_HOME>/repository/conf/user-mgt.xml file within the <UserStoreManager> section.
The following steps guides you on how to set up a primary user store.
...
Select the User store manager that suites your User store.
| Note |
|---|
See User store manager section in Configuring User Stores for more information. You can also configure your own custom user store manager. |
...
Configure user store manager properties.
In the following documents you can find the information of the properties that you need to configure in user store manager types. It provides the additional steps and recommendations specific to each user store manager.
| Child pages (Children Display) | ||
|---|---|---|
|
| Note |
|---|
In the |
Restart the server.
...
Note that this is only applicable to the WSO2 Identity server. Once you configure a primary user store, make sure you disable the default embedded user store from the system. To do this, open <IS_HOME>/repository/conf/identity/embedded-ldap.xml file and make the following change to the enable property to 'false'.
...
| language | xml |
|---|
...
| Tip |
|---|
Tip: You must disable the embedded user store that comes with the product. This ensures that it does not start up with the product. |
Since the user store you want to connect to might have different schemas from the ones available in the embedded user store, it needs to go through an adaptation process. WSO2 products provide the following adapters to enable you to authenticate users from different types of user stores and plug into LDAP, Active Directory, and JDBC user stores to perform authentication.
| User store manager class | Description |
|---|---|
org.wso2.carbon.user.core.ldap.ReadOnlyLDAPUserStoreManager | Use |
org.wso2.carbon.user.core.ldap.ReadWriteLDAPUserStoreManager | Use |
org.wso2.carbon.user.core.ldap.ActiveDirectoryUserStoreManager | Use |
org.wso2.carbon.user.core.jdbc.JDBCUserStoreManager | Use |
The user-mgt.xml file already has sample configurations for all of the above user stores. To enable these configurations, you must uncomment them in the code and comment out the ones that you do not need.
The following topics provide details on the various primary user stores you can configure.
| Child pages (Children Display) | ||
|---|---|---|
|
| Info |
|---|
If you are using LDAPS (secure) to connect to the Active Directory, you need to import its public certificate to the client-truststore.jks of the WSO2 product you are configuring. |
Related Links
See Working with Properties of User Stores for a comprehensive understanding on the configuration details.