PUT api/Users/Authenticate
Get User by user login and password
Request Information
URI Parameters
None.
Body Parameters
UserAuthDataName | Description | Type | Additional information |
---|---|---|---|
User login(email) |
string |
Required |
|
Password |
User password |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "Email": "sample string 1", "Password": "sample string 2" }
application/xml, text/xml
Sample:
<UserAuthData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models"> <Email>sample string 1</Email> <Password>sample string 2</Password> </UserAuthData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UsersModelsName | Description | Type | Additional information |
---|---|---|---|
ID |
User unique identifier |
string |
None. |
User login (email) |
string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
NotificationEmails | Collection of string |
None. |
|
Company | string |
None. |
|
Enabled | boolean |
None. |
|
LicenseManagmentMode |
Mode of user license management |
UserModeType |
None. |
DestinationList | Collection of UserDestinationsModel |
None. |
|
SpaceUsed |
Space Used (KB) |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "ID": "sample string 1", "Email": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "NotificationEmails": [ "sample string 1", "sample string 2" ], "Company": "sample string 5", "Enabled": true, "LicenseManagmentMode": 0, "DestinationList": [ { "ID": "sample string 1", "CurrentVolume": 2, "PackageID": 1, "AccountID": "sample string 3", "AccountDisplayName": "sample string 4", "Destination": "sample string 5", "DestinationDisplayName": "sample string 6" }, { "ID": "sample string 1", "CurrentVolume": 2, "PackageID": 1, "AccountID": "sample string 3", "AccountDisplayName": "sample string 4", "Destination": "sample string 5", "DestinationDisplayName": "sample string 6" } ], "SpaceUsed": 7 }
application/xml, text/xml
Sample:
<UsersModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models"> <Company>sample string 5</Company> <DestinationList> <UserDestinationsModel> <AccountDisplayName>sample string 4</AccountDisplayName> <AccountID>sample string 3</AccountID> <Destination>sample string 5</Destination> <DestinationDisplayName>sample string 6</DestinationDisplayName> <CurrentVolume>2</CurrentVolume> <ID>sample string 1</ID> <PackageID>1</PackageID> </UserDestinationsModel> <UserDestinationsModel> <AccountDisplayName>sample string 4</AccountDisplayName> <AccountID>sample string 3</AccountID> <Destination>sample string 5</Destination> <DestinationDisplayName>sample string 6</DestinationDisplayName> <CurrentVolume>2</CurrentVolume> <ID>sample string 1</ID> <PackageID>1</PackageID> </UserDestinationsModel> </DestinationList> <Email>sample string 2</Email> <Enabled>true</Enabled> <FirstName>sample string 3</FirstName> <ID>sample string 1</ID> <LastName>sample string 4</LastName> <LicenseManagmentMode>Manual</LicenseManagmentMode> <NotificationEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </NotificationEmails> <SpaceUsed>7</SpaceUsed> </UsersModels>