Accepts user credentials for validation, create a session and returns a session token

Validate credentials and establish session

Securityapi_key

Request

Request Body schema: application/json

Perform user authentication against the API

Password	string <= 128 characters /^.*$/
Username	string <= 64 characters /^.*$/

Responses

200

A login response

401

API key is missing or invalid

403

Request is completely forbidden. API not provided or method and or endpoint not supported

404

404 Not found

429

429 too many requests response

500

Service Error

default

unexpected error response

post/login

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"Password": "password",
"Username": "user"
}

Response samples

application/json

{"code": "Success",
"message": "string",
"SessionToken": "pa$$word",
"UserInfo": {"avatarUrl": "string",
"companyId": "string",
"createdAt": "2020-07-21 17:32:28Z",
"email": "string",
"fileId": "string",
"first": "string",
"firstPasswordReset": true,
"freshchatRestoreId": "string",
"id": "string",
"isLocked": true,
"isVerified": true,
"last": "string",
"lastLogin": "2020-07-21 17:32:28Z",
"locationIds": ["string"
],
"lockedAt": "2020-07-21 17:32:28Z",
"phone": "string",
"roles": [""
],
"tfaEnabled": true,
"updatedAt": "2020-07-21 17:32:28Z",
"username": "string"
}
}