Documentation

POST user/login

Used for

Logging in as a user for client pages and API.

Authentication

Valid username.

Parameters

Parameter Description Required Example
username Yes test
password Yes welcome
admin
  • True and authenticated: grants admin rights
  • False en authenticated: grants user rights
No true

Response codes

  • 200 OK
  • 412 Precondition failed

Example

Login as user test.

POST api/rest/user/login 
Request: 
{
  "username": "test",
  "password": "welcome"
  "admin": true
}
Response: 
{
  "status": true,
  "message": "Login successfull"
}