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

Get Started - Node.js

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

Note: You must have Node.js installed, and the minimum supported version is 10.0.0.

New to Node.Js? Check out this reference.

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 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 Node.js

This implementation uses the express framework to create Node.js API.

  • Create a node project by running the following command in the command line:

    npm init

    Note: Upon completion, it will add a package.json file in the project folder.

  • Create a server file in the project and name it server.js.

  • Add the following code snippet to the server.js file.

    var express = require('express');
    var bodyParser = require('body-parser');
    var path = require('path');
    var app = express();
    var PORT = 3000;
      extended: true
    // your LR API implementation goes here
    app.listen(PORT, () => console.log('App can be accessed at localhost:' + PORT ));

    Note: Make sure you add further code (given in steps below) in place of // your LR API implementation goes here text mentioned in the above file.

Install SDK

Add project dependency and LoginRadius SDK using npm by running the following command in the command line:

npm install express body-parser loginradius-sdk

Upon installation, you will find LoginRadius Node.js SDK under the node module. The following displays the project structure:


Configure Project

Add the following config object in the server.js file:

 var config = {
      apiDomain: '',
      apiKey: '{{ Your API Key }}',
      apiSecret: '{{ Your API Secret }}',
      siteName: '{{ Your App Name }}',
   	  apiRequestSigning: false,
var lrv2 = require('loginradius-sdk')(config);

Replace the placeholders in the above config object with the following values:

Note: Pass the proxy configurations if you want to set HTTP Server Proxy Configuration through your Node.js SDK. In this case, host and port are required, while username and password are optional.

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

Note: 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 Node.js 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 node API (eg: http://localhost:3000) from the application. Or you can use the path of the back end API as the return_url.

Add the following API snippet to server.jsto get the user profile using the access token:

app.get('/', function(req, res) {
    var fields = null; //Optional

    lrv2.authenticationApi.getProfileByAccessToken(req.query.token, fields).then((response) => {
       }).catch((error) => {

Run and See Result

  • Run the API Server by executing the following command in the command line: [node server.js]

  • 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 Node.js 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 Node.js Demo

  • Download Demo of the above-explained tutorial to support your implementation.

  • Refer to GitHub Demo to know how to implement various LoginRadius features using SDK Functions.

Node-js SDK Reference

Node-js SDK

API Reference


Go Back to Home Page

Was this article helpful?

Have more questions? Submit a request