PUT API/Users/Authenticate

Returns user by user login and password.

Request Information

URI Parameters

None.

Body Parameters

Name Description Type Additional Information
Email User login(email) string Required
Password User Password string Required

Request Formats

application/json, text/json

{
  "Email": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

<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>

Response Information

Resource Description

Name Description Type Additional Information
ID User Unique Identifier string None
Email 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

{
  "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": 3,
      "AccountID": "sample string 4",
      "AccountDisplayName": "sample string 5",
      "Destination": "sample string 6",
      "DestinationDisplayName": "sample string 7"
    },
    {
      "ID": "sample string 1",
      "CurrentVolume": 2,
      "PackageID": 3,
      "AccountID": "sample string 4",
      "AccountDisplayName": "sample string 5",
      "Destination": "sample string 6",
      "DestinationDisplayName": "sample string 7"
    }
  ],
  "SpaceUsed": 7
}

application/xml, text/xml

<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 5</AccountDisplayName>
      <AccountID>sample string 4</AccountID>
      <Destination>sample string 6</Destination>
      <DestinationDisplayName>sample string 7</DestinationDisplayName>
      <CurrentVolume>2</CurrentVolume>
      <ID>sample string 1</ID>
      <PackageID>3</PackageID>
    </UserDestinationsModel>
    <UserDestinationsModel>
      <AccountDisplayName>sample string 5</AccountDisplayName>
      <AccountID>sample string 4</AccountID>
      <Destination>sample string 6</Destination>
      <DestinationDisplayName>sample string 7</DestinationDisplayName>
      <CurrentVolume>2</CurrentVolume>
      <ID>sample string 1</ID>
      <PackageID>3</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>
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git