DocumentAPI ReferenceAdd-ons

Authentication

User Authentication

login

post

Create a user login

Body
usernamestringRequired
passwordstringRequired
Responses
200

success response

application/json
post
POST /auth/login HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"username='text'&password='text'"
{
  "createdBy": 1,
  "createdDate": "2025-08-30T04:07:46.095Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-08-30T04:07:46.095Z",
  "userId": 1,
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "usergroup": {
    "createdBy": 1,
    "createdDate": "2025-08-30T04:07:46.095Z",
    "modifiedBy": 1,
    "modifiedDate": "2025-08-30T04:07:46.095Z",
    "groupId": 1,
    "name": "text"
  }
}

user list

get

List of users

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
GET /auth/userlist?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get All user List"
}

create user

post

Add a new user.

Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
passwordstringRequired
firstNamestringRequired
lastNamestringRequired
emailstringRequired
userGroupIdinteger · int32Required
Responses
200

success response

application/json
post
POST /auth/create-user HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 105

"username='text'&password='text'&firstName='text'&lastName='text'&email='text'&userGroupId=1"
{
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "deleteFlag": 1,
  "userGroupId": "text",
  "isActive": 1,
  "createdDate": "2025-08-30T04:07:46.095Z",
  "userId": 1
}

Update User

put

Update a user.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
passwordstringOptional
firstNamestringRequired
lastNamestringRequired
emailstringRequired
userGroupIdinteger · int32Required
Responses
200

success response

application/json
put
PUT /auth/update-user/{id} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 105

"username='text'&password='text'&firstName='text'&lastName='text'&email='text'&userGroupId=1"
{
  "status": 1,
  "message": "User updated successfully."
}

Delete a User

delete

Delete a user

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
delete
DELETE /auth/delete-user/{id} HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "User Deleted successfully."
}

Forgot the user password

post

Forgrt password

Header parameters
AuthorizationstringRequired
Body
emailstringOptional
Responses
200

success response

application/json
post
POST /auth/forgot-password HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16

"email='text'"
{
  "status": 1,
  "message": "Your password has been sent to your email inbox."
}

Change the Password

put

Change Password

Header parameters
AuthorizationstringRequired
Body
oldPasswordstringOptional
newPasswordstringOptional
Responses
200

success response

application/json
put
PUT /auth/change-password HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"oldPassword='text'&newPassword='text'"
{
  "status": 1,
  "message": "Your password changed successfully."
}

Edit Profile

post

Edit a profile for a user.

Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
emailstringRequired
avatarstringOptional
phoneNumberstringOptional
addressstringOptional
Responses
200

success response

application/json
post
POST /auth/edit-profile HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 88

"username='text'&email='text'&avatar='text'&phoneNumber='text'&address='text'"
{
  "createdBy": 1,
  "createdDate": "2025-08-30T04:07:46.095Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-08-30T04:07:46.095Z",
  "userId": 1,
  "userGroupId": 1,
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "ip": "text",
  "phoneNumber": "text",
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "forgetPasswordKey": "text",
  "permission": 1,
  "usergroup": null
}

logout

post

User logout.

Header parameters
AuthorizationstringRequired
Responses
200

success response

application/json
post
POST /auth/logout HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully Logout."
}

forgot password link

post

This is for user forget password link.

Body
emailIdstringOptional
Responses
200

success response

application/json
post
POST /auth/forgot-password-link HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"emailId='text'"
200

success response

{
  "status": 1,
  "message": "If the user is registered a link to reset the password will be sent to the user’s email address. \" or \" If the user is registered a link to reset the password will be sent to the user’s email address."
}

forgot-password-key-check

get

This is for user password key validation.

Query parameters
encryptedKeystringOptional
Responses
200

success response

*/*
get
GET /auth/forgot-password-key-check HTTP/1.1
Host: 
Accept: */*
200

success response

{
  "status": 1,
  "message": "Invalid key. please try again \" or \" Your forgot password link got expired, try again. \" or \" This link has been used already. please try again"
}

reset password

put

Users reset their password

Body
newPasswordstringOptional
keystringOptional
Responses
200

success response

application/json
put
PUT /auth/reset-password HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"newPassword='text'&key='text'"
{
  "status": 1,
  "message": "Your password has been changed successfully"
}

Get Profile

get

This is to get the user profile

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
GET /auth/get-profile HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully Get the Profile."
}

Get Site Map

get

Get user site map

Responses
200

success response

*/*
get
GET /auth/get-sitemap HTTP/1.1
Host: 
Accept: */*
200

success response

{
  "status": 1,
  "message": ""
}

Permission Authentication

list

get

Get list of permission module.

Query parameters
limitintegerRequired
offsetintegerOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
GET /permission-module/list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got permission module group list count \" or \" Successfully got the complete list of pages."
}

add permission

post

Add permission module.

Header parameters
AuthorizationstringRequired
Body
refTypeinteger · int32Required
refIdinteger · int32Required
permissionstringRequired
Responses
200

success response

application/json
post
POST /permission-module/add-permission HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"refType=1&refId=1&permission='text'"
{
  "status": 1,
  "message": "Successfully updated the permission."
}

get permission

get

Get permission.

Query parameters
refTypeintegerRequired
refIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
GET /permission-module/get-permission?refType=1&refId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got permission list"
}

permission me

get

Get permission from me

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
GET /permission-module/permission-me HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got permission list for current user"
}

Create a new user

POST /users

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

name

string

Name of the user

age

number

Age of the user

Response

{
  "id": 1,
  "name": "John",
  "age": 30
}

Last updated