Authentication

User Authentication

login

post

Create a user login

Body

application/x-www-form-urlencoded

usernamestringRequired

passwordstringRequired

Responses

200

success response

application/json

createdByinteger · int32Optional

createdDatestring · date-timeOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

userIdinteger · int32Optional

avatarstringOptional

avatarPathstringOptional

isActiveinteger · int32Optional

codeinteger · int32Optional

addressstringOptional

deleteFlaginteger · int32Optional

linkExpiresinteger · int32Optional

400

error response

application/json

post

/auth/login

HTTPcURLJavaScriptPython

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

"username='text'&password='text'"

{
  "createdBy": 1,
  "createdDate": "2026-03-21T23:02:49.634Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-03-21T23:02:49.634Z",
  "userId": 1,
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "usergroup": {
    "createdBy": 1,
    "createdDate": "2026-03-21T23:02:49.634Z",
    "modifiedBy": 1,
    "modifiedDate": "2026-03-21T23:02:49.634Z",
    "groupId": 1,
    "name": "text"
  }
}

user list

get

List of users

Query parameters

limitintegerRequired

offsetintegerOptional

keywordstringOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully get All user List

get

/auth/userlist

HTTPcURLJavaScriptPython

GET /auth/userlist?limit=1 HTTP/1.1
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

application/x-www-form-urlencoded

usernamestringRequired

passwordstringRequired

firstNamestringRequired

lastNamestringRequired

emailstringRequired

userGroupIdinteger · int32Required

Responses

200

success response

application/json

usernamestringOptional

passwordstringOptional

firstNamestringOptional

lastNamestringOptional

emailstringOptional

deleteFlaginteger · int32Optional

userGroupIdstringOptional

isActiveinteger · int32Optional

createdDatestring · date-timeOptional

userIdinteger · int32Optional

400

error response

application/json

post

/auth/create-user

HTTPcURLJavaScriptPython

POST /auth/create-user HTTP/1.1
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": "2026-03-21T23:02:49.634Z",
  "userId": 1
}

Update User

put

Update a user.

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

usernamestringRequired

passwordstringOptional

firstNamestringRequired

lastNamestringRequired

emailstringRequired

userGroupIdinteger · int32Required

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: User updated successfully.

400

error response

application/json

422

error response

application/json

put

/auth/update-user/{id}

HTTPcURLJavaScriptPython

PUT /auth/update-user/{id} HTTP/1.1
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

*/*

statusintegerOptional

messagestringOptionalDefault: User Deleted successfully.

400

error response

*/*

delete

/auth/delete-user/{id}

HTTPcURLJavaScriptPython

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

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

Forgot the user password

post

Forgrt password

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

emailstringOptional

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: Your password has been sent to your email inbox.

400

error response

application/json

post

/auth/forgot-password

HTTPcURLJavaScriptPython

POST /auth/forgot-password HTTP/1.1
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

application/x-www-form-urlencoded

oldPasswordstringOptional

newPasswordstringOptional

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: Your password changed successfully.

400

error response

application/json

422

error response

application/json

put

/auth/change-password

HTTPcURLJavaScriptPython

PUT /auth/change-password HTTP/1.1
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

application/x-www-form-urlencoded

usernamestringRequired

emailstringRequired

avatarstringOptional

phoneNumberstringOptional

addressstringOptional

Responses

200

success response

application/json

createdByinteger · int32Optional

createdDatestring · date-timeOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

userIdinteger · int32Optional

userGroupIdinteger · int32Optional

usernamestringOptional

passwordstringOptional

firstNamestringOptional

lastNamestringOptional

emailstringOptional

avatarstringOptional

avatarPathstringOptional

isActiveinteger · int32Optional

codeinteger · int32Optional

ipstringOptional

phoneNumberstringOptional

addressstringOptional

deleteFlaginteger · int32Optional

linkExpiresinteger · int32Optional

forgetPasswordKeystringOptional

permissioninteger · int32Optional

usergroupanyOptional

400

error response

application/json

post

/auth/edit-profile

HTTPcURLJavaScriptPython

POST /auth/edit-profile HTTP/1.1
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": "2026-03-21T23:02:49.634Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-03-21T23:02:49.634Z",
  "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

statusintegerOptional

messagestringOptionalDefault: Successfully Logout.

400

error response

application/json

post

/auth/logout

HTTPcURLJavaScriptPython

POST /auth/logout HTTP/1.1
Authorization: text
Accept: */*

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

forgot password link

post

This is for user forget password link.

Body

application/x-www-form-urlencoded

emailIdstringOptional

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: 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.

post

/auth/forgot-password-link

HTTPcURLJavaScriptPython

POST /auth/forgot-password-link HTTP/1.1
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

*/*

statusintegerOptional

messagestringOptionalDefault: Invalid key. please try again " or " Your forgot password link got expired, try again. " or " This link has been used already. please try again

get

/auth/forgot-password-key-check

HTTPcURLJavaScriptPython

GET /auth/forgot-password-key-check HTTP/1.1
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

application/x-www-form-urlencoded

newPasswordstringOptional

keystringOptional

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: Your password has been changed successfully

400

error response

application/json

422

error response

application/json

put

/auth/reset-password

HTTPcURLJavaScriptPython

PUT /auth/reset-password HTTP/1.1
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

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully Get the Profile.

get

/auth/get-profile

HTTPcURLJavaScriptPython

GET /auth/get-profile HTTP/1.1
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

*/*

statusintegerOptional

messagestringOptionalDefault: ""

get

/auth/get-sitemap

HTTPcURLJavaScriptPython

GET /auth/get-sitemap HTTP/1.1
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

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got permission module group list count " or " Successfully got the complete list of pages.

get

/permission-module/list

HTTPcURLJavaScriptPython

GET /permission-module/list?limit=1 HTTP/1.1
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

application/x-www-form-urlencoded

refTypeinteger · int32Required

refIdinteger · int32Required

permissionstringRequired

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully updated the permission.

400

error response

application/json

post

/permission-module/add-permission

HTTPcURLJavaScriptPython

POST /permission-module/add-permission HTTP/1.1
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

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got permission list

400

error response

*/*

get

/permission-module/get-permission

HTTPcURLJavaScriptPython

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

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

permission me

get

Get permission from me

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got permission list for current user

400

error response

*/*

get

/permission-module/permission-me

HTTPcURLJavaScriptPython

GET /permission-module/permission-me HTTP/1.1
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

200

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

400