This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.

All docs This doc

Versions Compared


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


  1. Download WSO2 API Manager 2.1.0 from here and unzip it. <API-M_HOME> refers to the root folder where WSO2 API-M was unzipped.

  2. Create a MySQL database (e.g., 410_um_db) and run the <API-M_HOME>/dbscripts/mysql.sql script on it to create the required tables. 


    There are two MySQL DB scripts available in the product distribution from WSO2 Carbon Kernel 4.4.6 onwards. Click here to identify as to which version of the MySQL script to use. If you are using a different database type, find the relevant script from the <API-M_HOME>/dbscripts directory.

  3. Open the <API-M_HOME>/repository/conf/datasources/master-datasources.xml file and add the datasource configuration for the database that you use for the shared user store and user management information. For example, you can share as single user store as follows. If you are sharing multiple datasources, you need to define a datasource for each of the user stores that you are working with, so that they can be shared.

    Code Block
         <description>The datasource used for registry and user manager</description>
         <definition type="RDBMS">
                      <validationQuery>SELECT 1</validationQuery>

    Change the database url to the url of the MySQL database you have created above. Modify the username and password parameters in above configuration with your mysql database credentials.


    Refer Configuring master-datasources.xml for descriptive information about each property of the datasource configuration.

  4. Download WSO2 Identity Server (WSO2 IS) 5.3.0 from here and unzip it. <IS_HOME> refers to the root folder where WSO2 IS was unzipped.


    To use WSO2 IS as the Key Manager , download the WSO2 Identity Server 5.3.0 as a Key Manager pack, with pre-packaged Key Manager features, from here.

  5. Add the same datasource configuration above to <IS_HOME>/repository/conf/datasources/master-datasources.xml file.

  6. Copy the database driver JAR file to the <IS_HOME>/repository/components/lib and <API-M_HOME>/repository/components/lib directories.

  7. Open the <API-M_HOME>/repository/conf/user-mgt.xml file. The dataSource property points to the default H2 database. Change it to the jndiConfig name given above (i.e., jdbc/WSO2UMDB). This changes the datasource reference that is pointing to the default H2 database.

    Code Block
                <Property name="dataSource">jdbc/WSO2UMDB</Property>
  8. Add the same configuration above to the <IS_HOME>/repository/conf/user-mgt.xml file.
  9. The Identity Server has an embedded LDAP user store by default. As this is enabled by default, follow the instructions in Internal JDBC User Store Configuration to disable the default LDAP and enable the JDBC user store instead.


    In WSO2 API Manager, the JDBC User Store is enabled by default. By changing the default user store of WSO2 Identity server to JDBC User Store, we are pointing both WSO2 API Manager and WSO2 Identity Server to the same user store so that, their user stores are shared.