Post Login
This API creates a login session. It returns the authentication token (sessionid) that must be used as a header parameter for all other Usage Meter operations.
Request
URI
POST
https://{api_host}/login
COPY
Request Body
Login credentials
PostLoginRequest of type(s) application/json
Required
{
"user": "string",
"password": "string"
}string
user
Required
user
string As password As password
password
Required
password
Responses
202
Login successful
Returns PostLoginResponse of type(s) application/json
{
"data_usage_acceptance": true,
"http_proxy": true,
"alert_email": false,
"sessionid": "UmSIDX.....UXnw0Rrbtwk"
}boolean
data_usage_acceptance
Optional
Specifies whether the user licenese agreement has been accepted
boolean
http_proxy
Optional
Specifies whether HTTP proxy is setup
boolean
alert_email
Optional
Specifies whether alert email is provided
string
sessionid
Optional
The token that identifies this session of the user's login. This must be used as a header paramater for all other operations.
400
Returns 400InvalidRequest of type(s) application/json
{
"errCode": "GW_REQ_KEY",
"errMessage": "Not found expected value for key 'sampleKey'"
}string
errCode
Optional
errCode
string
errMessage
Optional
errMessage
401
Unauthorized - Invalid login credentials
{
"errCode": "string"
}string
errCode
Optional
errCode