Retrieve session ID using login API

URL: http://<Hostname>:31443/avxapi/login?gwsource=external

Method: POST

Response Format: JSON

Requires authentication: Yes

Request timeout period: 15 minutes

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 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 Login failed. Invalid credentials.
200 OK Login successful
401 Unauthorized Authentication failed. Invalid Credentials.

Sample Request/Response

Use Case

Log in to the application with a username and password.

Sample Request

URL: http://<Hostname>:31443/avxapi/login?gwsource=external

Headers

username: admin

password: AppViewX@123

Content-Type: application/json

grant_type=client_credentials

Request Payload

{}

Sample Response

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