Login

Authenticate into the AppViewX application. If success will return a session id which can be used as an authentication token to access the other APIs.

URL: /login

Type: POST

Parameters

Param Type Name Description Field Type
Header username** Login username String
Header Password** Password for the username String
Header Content-Type** Specifies the nature of the data in the payload (The value of the param should be "application/json") String
Query Gwkey Tenant Key. Needed only in case of multitenant installations String
Query gwsource** Source from which the request is triggered (for example, web, external) String

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
400 Bad request Username or password cannot be null or empty
200 OK Login successful
401 Unauthorized Login failed. Invalid Credentials