Authentication

User Authentication

login

Create a user login

POST/auth/login

Body

application/x-www-form-urlencoded

username*string

password*string

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

userIdinteger (int32)

avatarstring

avatarPathstring

isActiveinteger (int32)

codeinteger (int32)

addressstring

deleteFlaginteger (int32)

linkExpiresinteger (int32)

usergroupuserGroup (object)

Request

JavaScriptCurl

const response = await fetch('/auth/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-29T01:35:17.920Z",
  "modifiedDate": "2024-04-29T01:35:17.920Z",
  "avatar": "text",
  "avatarPath": "text",
  "address": "text",
  "usergroup": {
    "createdDate": "2024-04-29T01:35:17.920Z",
    "modifiedDate": "2024-04-29T01:35:17.920Z",
    "name": "text"
  }
}

user list

List of users

GET/auth/userlist

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/userlist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get All user List"
}

create user

Add a new user.

POST/auth/create-user

Header parameters

Body

application/x-www-form-urlencoded

username*string

password*string

firstName*string

lastName*string

email*string

userGroupId*integer (int32)

Response

200400

success response

Body

application/json

usernamestring

passwordstring

firstNamestring

lastNamestring

emailstring

deleteFlaginteger (int32)

userGroupIdstring

isActiveinteger (int32)

createdDatestring (date-time)

userIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/auth/create-user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "userGroupId": "text",
  "createdDate": "2024-04-29T01:35:17.920Z"
}

Update User

Update a user.

PUT/auth/update-user/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

username*string

passwordstring

firstName*string

lastName*string

email*string

userGroupId*integer (int32)

Response

200400422

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/update-user/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "User updated successfully."
}

Delete a User

Delete a user

DELETE/auth/delete-user/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/delete-user/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "User Deleted successfully."
}

Forgot the user password

Forgrt password

POST/auth/forgot-password

Header parameters

Body

application/x-www-form-urlencoded

emailstring

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/forgot-password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Your password has been sent to your email inbox."
}

Change the Password

Change Password

PUT/auth/change-password

Header parameters

Body

application/x-www-form-urlencoded

oldPasswordstring

newPasswordstring

Response

200400422

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/change-password', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Your password changed successfully."
}

Edit Profile

Edit a profile for a user.

POST/auth/edit-profile

Header parameters

Body

application/x-www-form-urlencoded

username*string

email*string

avatarstring

phoneNumberstring

addressstring

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

userIdinteger (int32)

userGroupIdinteger (int32)

usernamestring

passwordstring

firstNamestring

lastNamestring

emailstring

avatarstring

avatarPathstring

isActiveinteger (int32)

codeinteger (int32)

ipstring

phoneNumberstring

addressstring

deleteFlaginteger (int32)

linkExpiresinteger (int32)

forgetPasswordKeystring

permissioninteger (int32)

usergroupprofileUserGroup (any)

Request

JavaScriptCurl

const response = await fetch('/auth/edit-profile', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "email": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-29T01:35:17.920Z",
  "modifiedDate": "2024-04-29T01:35:17.920Z",
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "avatar": "text",
  "avatarPath": "text",
  "ip": "text",
  "phoneNumber": "text",
  "address": "text",
  "forgetPasswordKey": "text"
}

logout

User logout.

POST/auth/logout

Header parameters

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/logout', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully Logout."
}

forgot password link

This is for user forget password link.

POST/auth/forgot-password-link

Body

application/x-www-form-urlencoded

emailIdstring

Response

200

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/forgot-password-link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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

This is for user password key validation.

GET/auth/forgot-password-key-check

Query parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/forgot-password-key-check', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

Users reset their password

PUT/auth/reset-password

Body

application/x-www-form-urlencoded

newPasswordstring

keystring

Response

200400422

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/reset-password', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Your password has been changed successfully"
}

Get Profile

This is to get the user profile

GET/auth/get-profile

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/get-profile', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully Get the Profile."
}

Get Site Map

Get user site map

GET/auth/get-sitemap

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/get-sitemap', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

Permission Authentication

list

Get list of permission module.

GET/permission-module/list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/permission-module/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

add permission

Add permission module.

POST/permission-module/add-permission

Header parameters

Body

application/x-www-form-urlencoded

refType*integer (int32)

refId*integer (int32)

permission*string

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/permission-module/add-permission', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "permission": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated the permission."
}

get permission

Get permission.

GET/permission-module/get-permission

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/permission-module/get-permission', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got permission list"
}

permission me

Get permission from me

GET/permission-module/permission-me

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/permission-module/permission-me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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