The following documentation is applicable to Free, Developer, and Developer Pro plans. For documentation related to the enterprise plan, please click here.

Get Started - JAVA

The tutorial lets you implement LoginRadius user registration, login, profile, and log out in your JAVA application.

For developing a JAVA project a JDK is required. For this guide, the supported version is JDK 8.0 or JDK 11.0. The guide to install JDK can be found here.

Create an account to get started if you don't have one yet!

When you signed up for the LoginRadius account, it created an app for you. This app is linked to a ready to use web page - Auth Page (IDX).

Auth Page (IDX) reflects the configuration changes that you make in LoginRadius Dashboard. You can utilize this webpage for authentication requirements on your JAVA application.

Choose Theme

LoginRadius provides the functionality where you can select a design theme for your login page or further customize the content displayed.

In your LoginRadius Dashboard, select your app, then navigate to the Auth Page (IDX) section located in the left navigation bar and click the Theme Customization section. There you can select a design theme for your login page or further customize the content displayed:


To preview your login page's theme, click the Go to your Login Page link highlighted on the above screen.

Features like Email and Password login, User registration, Forgot password, and Remember me are already configured on your Auth Page(IDX).

Get Credentials

Before using any of the APIs or Methods that LoginRadius provides, you need to get your App Name, API Key, and API Secret.

In your LoginRadius Dashboard, navigate to Configuration > API Credentials and click the API Key And Secret subsection to retrieve your API Credentials.


Setup a JAVA project

Next, we can either install Eclipse or VSCode (available from their respective websites) as an IDE to run our JAVA project. For this project, we are choosing Visual Studio Code. For Eclipse, refer here.

Once you have both JDK and VSCode installed, we can follow this guide to setup a JAVA environment in Visual Studio Code.

Setting up Spring Boot for server in the JAVA project

Usually, web applications require a server for setting up, for this we will be needing SpringBoot. To set up spring-boot:

Install the Spring boot Extensions Pack for getting Spring boot Development Environment to Visual Studio Code from VSCode Extensions marketplace.


Implementing Loginradius SDK in JAVA

Loginradius offers an already-done-for-you Loginradius JAVA-SDK kit that can be used to implement basic features such as user authorization and registration for your app easily.

For this, you'll be needing Git for VSCode, which if not already setup can be done so by following this guide.

After setting up git, run this command in your VSCode terminal:

git clone

Configure Project

Locate to the this folder:


This is the file structure you will get in the Java demo, let's see what each file does

  • demo folder - Contains all the HTML, CSS, and JS files to create UI for the test application.

  • static folder - Contains all the CSS and JS files to create UI for the test application.

  • java folder - Contains server-side code and routing API to be used in the demo

  • templates folder - contains the HTML template for Login and profile page

| -- main
| -- |--- |java/
| -- |--- |resources/
| -- |--- |--
| -- |--- |-- static
| -- |--- |-- templates
| -- |--- |-- --- index.html
| -- |--- |-- --- profile.html

You need to add your LoginRadius credentials in the demo app to communicate with LoginRadius SDK

-Server side: demo/src/main/resources/

server.port= 8080
app.apikey=xxxxxxxxxx //Add api key
app.apisecret=xxxxxxxxx //Add api secret

-Client-side: demo/src/main/resources/static/js/options.js

commonOptions.apiKey = "<LoginRadius API Key>"; //Add api key
commonOptions.appName = "<App Name>"; //Add app name

Visit http://localhost:8080 (8080 is the default port for hosting the web page, you can check out the port number from within the terminal after execution is finished and the web page is set up) in your browser.

Configure Registration and Login URLs

This tutorial uses Auth Page(IDX) for authentication, where Registration and Login functionality is already implemented.

Navigate your Register or Login links or buttons to the following URLs:

Registration Page URL:

https://<LoginRadius APP Name><Return URL>

Login Page URL:

https://<LoginRadius APP Name><Return URL>


  • LoginRadius App Name is the name of your app as mentioned in the Get Credentials step.
  • return_url is where you want to redirect users upon successful registration or login. Whitelist your domain if you are not using Local Domain for this tutorial.

return_url can be your website, frontend app, or backend server url where you are handling the access token.

Retrieve User Data using Access Token

Once the authentication is done using Auth Page (IDX), the default script of LoginRadius sends an access token in the query string as a token parameter with the return_url. The return_url will access the JAVA backend API with query parameter (access token).

The following is an example of the access token in the query string with the Return URL:

<Return URL>?token=745******-3e8e-****-b3**2-9c0******1e.

If return_url is of frontend, pass the token to backend JAVA API (eg: http://localhost:8080) from the application. Or you can use the path of the back end API as the return_url.

Navigate to this directory java-sdk/demo/src/main/java/com/demo

There, locate following file and add the following API snippet to get the user profile using the access token:

public String getUserProfile(HttpServletRequest request) {
		AuthenticationApi auth = new AuthenticationApi();
		auth.getProfileByAccessToken(request.getParameter("token"), null, new AsyncHandler<Identity>() {
			public void onSuccess(Identity arg0) {
				// TODO Auto-generated method stub
				resp = gson.toJson(arg0);

			public void onFailure(ErrorResponse error) {
				// TODO Auto-generated method stub
				resp = error.getDescription();

		return resp;

and in the same directory, locate and add following snippet for route configuration :

 @RequestMapping(value="/user", method=RequestMethod.GET)
    public String getUserProfile(HttpServletRequest request){
            String result = service.getUserProfile(request);
            System.out.println("UserController.getUserProfile::" + result);
            return result;


Run and See Result

  • First navigate to java-sdk/demo folder. Run the API Server by executing the following command in the command line: [mvn spring-boot:run]

    NOTE: If you don't have Maven already installed, you can install it from here

  • Open your Auth Page(IDX) registration URL https://<LoginRadius APP Name><Return URL>. It will display the following screen:


  • Register a user here and then log in. Upon successful login, it will redirect you to the return url with the access token. In response, you will get a user profile in JSON format. The following displays a sample JSON response:


Similarly, you can implement more features using JAVA SDK.

In addition to Registration and Login actions, the Auth Page (IDX) supports more actions. Refer to this document for more information.

Whitelist Domain

For security reasons, LoginRadius processes the API calls that are received from the whitelisted domains. Local domains (http://localhost and are whitelisted by default.

To whitelist your domain, in your LoginRadius Dashboard, navigate to Configuration > Whitelist Your Domain and add your domain name:


Explore JAVA Demo

Java SDK Reference


API Reference


Go Back to Home Page

Was this article helpful?

Have more questions? Submit a request