Log Into AppViewX

Request Structure

URL: /login

Type: POST

Parameters

Table 1. Parameter Details
Param Type	Name	Description	Field Type	Constraints
Header	`username`	AppViewX login username	`String`
Header	`password`	AppViewX login password	`String`
Header	`Content-Type`	Specifies the nature of the data in the payload.	`String`	Value of the param should be `application/json`
Query	`gwkey`	Tenant Key. Needed only in case of multi tenant installations
Query	`gwsource`	Source from which the request is triggered (Eg: web, external)	`String`

Response Structure

200 OK, returns a string of type application/JSON with the following body parameters:


Name	Description	Field Type
`response`	Contains the response for the session activation with the authentication/session ID.	Key Value Pair
`message`	Success message along with the objectIds or failure description in case of error.	String
`appStatusCode`	Application specific status code for the response. Will be non-null for failure response.	String
`tags`	More info in case of failure response.	Key value pair

Status Codes


HTTP Status Code	appStatusCode	Message	Possible Remediation
200 OK	-	Login successful	-
400 Bad request		Username or password cannot be null or empty	Check and ensure if a non-null/non-empty value is given in the header field for username or password
401 Unauthorized		Login failed. Invalid credentials.	Check and ensure if the username and password provided are valid and correct.

Sample Request/Response

Use Case

Login to the application with the user name, appviewxuser, and password, appviewxpassword. The session id received as response in the example below is ce7f1a14-2bf9-4e4a-89a8-bc780a255813.

Sample Request

{

}

Sample Response

{
"response":{
"status":"SUCCESS",
"appStatusCode":null,
"statusDescription":null,
"sessionId":"ce7f1a14-2bf9-4e4a-89a8-bc780a255813",
"availableLoginAttemptCount":null
},

"message":null,
"appStatusCode":null,
"tags":null,
"headers":null
}