User Management API Documentation

Register User

Adds a new user. The API can only be used to add end users and not Admins

• URL

  /register

• Method:

  POST

• Data Params

  Required:

  name=[string] username=[string] password=[string]

• Success Response:

  • Code: 200
    Content: { id : 12, name : "Vaibhav Sinha", username : "vaibhav", password : "Encrypted Password", role : "USER", status : "ACTIVE" }

Get Current User Details

Gets the details of the currently logged in user

• URL

  /me

• Method:

  GET

• Data Params

  None

• Success Response:

  • Code: 200
    Content: { id : 12, name : "Vaibhav Sinha", username : "vaibhav", password : "Encrypted Password", role : "USER", status : "ACTIVE" }

Authenticate User

Checks if the provided username and password are correct

• URL

  /isValidUser

• Method:

  POST

• Data Params

  Required:

  username=[string] password=[string]

• Success Response:

  • Code: 200
    Content: true
    

  OR

  • Code: 200
    Content: false