POST login
Authenticates a username and password against a server account. The sessionId returned as part of the response is the token that needs to be passed to other calls that requiere authentication.| Account |
The account identifies the customer in a multitenant environment. It acts as a domain or realm for all usernames in that account. That means that for different accounts it's valid that people have the same username Example Values: cervelo, rpdemo1, apihealthcare |
| Username |
Unique identifier for a user in an account. It's common for application level usernames to use the same name as the account name. Example Values: brichie, rpdemo1, testuser |
| Password |
Password. Example Values: 1jI5e4W3qt |
The following error codes are returned:
- 204 Missing request body: If the body with the parameters values is not present.
- 400 Wrong password: If the password doesn't match the current one in records.
- 400 There's no user with the that username
- 400 Empty username: If no username is specified.
- 400 Empty password: If no password is specified.
- 400 Empty account: If no account is specified.
- 400 Customer account not found NAME_OF_NON_EXISTING_ACCOUNT
- 400 Incorrect Media Type, only application/json is supported: If the request was made with another Content-Type header.
Example Request
POST http://shiftex.vortexconnect.com/api/login HTTP/1.1
Accept: application/json; version=2.0
Content-Type: application/json
Content-Length: 66
{"account" : "cervelo", username : "vortex", password: "1jI5e4W3qt"}
{"sessionId": "wORaLP4wa8MbhK3psvNrEif3Cc8a1wtQvYgwTv52qnQ="}