User

API to get Auth Token.

post

https://localhost:3000/apihttp://localhost:3000/api

/user/login

Return Auth token - use this token to Authorize on using the secured API.

Body

application/json

usernamestringOptionalExample: **username**

passwordstringOptionalExample: ####pwd####

extendedExpirybooleanOptionalExample: true

Responses

200

Login Successful!

application/json

usernamestringOptionalExample: **username**

passwordstringOptionalExample: ####pwd####

extendedExpirybooleanOptionalExample: true

401

Invalid Login Credentials

post

/user/login

HTTPcURLJavaScriptPython

POST /api/user/login HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "username": "**username**",
  "password": "####pwd####",
  "extendedExpiry": true
}

{
  "username": "**username**",
  "password": "####pwd####",
  "extendedExpiry": true
}

get

https://localhost:3000/apihttp://localhost:3000/api

/user

Get all users with their roles and details

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/user

HTTPcURLJavaScriptPython

GET /api/user HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/user/role

Get all user roles with their permissions

Responses

200

OK

No content

500

Internal Server Error

get

/user/role

HTTPcURLJavaScriptPython

GET /api/user/role HTTP/1.1
Host: localhost:3000
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/user/alterPermission

Alter role permissions (action or navigation)

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/user/alterPermission

HTTPcURLJavaScriptPython

POST /api/user/alterPermission HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "type": "object",
  "properties": {
    "roleName": {
      "type": "string",
      "examples": null
    },
    "permissionName": {
      "type": "string",
      "examples": null
    },
    "newValue": {
      "type": "boolean",
      "examples": null
    },
    "permType": {
      "type": "string",
      "examples": null
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/user/suspend

Suspend one or more users by their IDs

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/user/suspend

HTTPcURLJavaScriptPython

POST /api/user/suspend HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/user/restore

Restore suspended users by their IDs

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/user/restore

HTTPcURLJavaScriptPython

POST /api/user/restore HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/user/alterPassword

Change password for a user (admin action)

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/user/alterPassword

HTTPcURLJavaScriptPython

POST /api/user/alterPassword HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "type": "object",
  "properties": {
    "userPayload": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "examples": null
        },
        "password": {
          "type": "string",
          "examples": null
        }
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/user/update-self-pwd

Update own password (self-service)

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/user/update-self-pwd

HTTPcURLJavaScriptPython

POST /api/user/update-self-pwd HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "type": "object",
  "properties": {
    "userData": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "examples": null
        },
        "password": {
          "type": "string",
          "examples": null
        },
        "firstResetDone": {
          "type": "boolean",
          "examples": null
        }
      }
    }
  }
}

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/user/preferences

Returns user-specific preferences and settings.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/user/preferences

HTTPcURLJavaScriptPython

GET /api/user/preferences HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content