POST v1/User/AuthenticateUser
This method authenticates a user using their email and password and returns details of the user if the authentication succeeds This is useful for Tradevine users to authenticate staff in their own applications
Request Information
URI Parameters
None.
Body Parameters
The body of the post containing the email and password of the user
| Name | Description | Type |
|---|---|---|
| string | ||
| Password | string |
Request Formats
application/json
Sample:
{
"Email": "sample string 1",
"Password": "sample string 2"
}
Response Information
Resource Description
The user data from the Tradevine database
| Name | Description | Type |
|---|---|---|
| AppUserID | integer | |
| OrganisationID | integer | |
| string | ||
| Title | integer | |
| FirstName | string | |
| MiddleName | string | |
| LastName | string | |
| Status | integer | |
| Position | string | |
| PhoneNumber | string | |
| FaxNumber | string | |
| MobileNumber | string | |
| PreferredPhoneNumber | integer | |
| IsRibbonPinned | boolean | |
| IsActive | boolean | |
| IsPublic | boolean | |
| DefaultOrganisationID | integer | |
| SessionTimeoutMinutes | integer | |
| StartupPage | integer | |
| LastLoginDate | date | |
| CreatedDate | date | |
| CreatedBy | integer | |
| ModifiedDate | date | |
| ModifiedBy | integer | |
| HasWarehouseRole | boolean | |
| IsTradevineSupport | boolean | |
| UnsuccessfulConsecutiveLoginAttempts | integer | |
| IsAccountLockedOut | boolean | |
| WarehouseListJson | Collection of integer |
Response Formats
application/json
Sample:
Sample not available.