This documentation is for WSO2 Identity Server 5.1.0 . View documentation for the latest release.

Versions Compared


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


  1. Create a folder in your local machine and navigate to it using your command line.
  2. Download the Java sample from GitHub from the link below. More details on how to download a sample can be found here.  

    Code Block

    The location of this folder will be referred to as <remote-user-mgt_HOME> from this point onwards.

  3. Open the <remote-user-mgt_HOME>/build.xml file and update the ${wso2is.home} value with your IS home. Do this by modifying the wso2is.home property in a manner similar to the following.

    Code Block
    <property name="wso2is.home" value="/Users/Sam/Documents/IS/SampleTest/wso2is-5.1.0/"/>
  4. Update the file with the directory that your WSO2 Identity Server instance is located. For example, the code will look similar to the following.

    Code Block
    public static final String IS_HOME ="/Users/Sam/Documents/IS/SampleTest/wso2is-5.1.0/";
  5. Start the Identity Server using the start up script found in the <IS_HOME>/bin directory.
    • Use for Linux.
    • Use wso2server.bat for Windows.

    Note: Ensure that the port offset in the <IS_Home>/repository/conf/carbon.xml file is set at 0

  6. Download and install Apache Ant if you have not already done so.
  7. Modify the <remote-user-mgt_HOME>/ file if the default configuration to run the sample is different. For example, if you have changed the password for your user, you need to update it here.
  8. Open a command line interface and navigate to the <remote-user-mgt_HOME> directory.
  9. Run the ant command at this directory level in the command line and observe the different user management operations performed remotely.
  10. Log in to the Identity Server and go to Users and Roles in the Configure menu in the management console
  11. Click Users and you can now view the users created in the list using the sample.