POST api/account/authenticate

Request Information

URI Parameters

None.

Body Parameters

AuthenticationRequest
NameDescriptionTypeAdditional information
Username

string

None.

Password

string

None.

IsDomainUser

boolean

None.

IsPublicAccount

boolean

None.

UserOTP

string

None.

SecuredOTPCode

string

None.

BrowserAgent

string

None.

IpAddress

string

None.

DeviceID

string

None.

Origin

OriginApplication

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "IsDomainUser": true,
  "IsPublicAccount": true,
  "UserOTP": "sample string 5",
  "SecuredOTPCode": "sample string 6",
  "BrowserAgent": "sample string 7",
  "IpAddress": "sample string 8",
  "DeviceID": "sample string 9",
  "Origin": 0
}

application/xml, text/xml

Sample:
<AuthenticationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.Services">
  <BrowserAgent xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">sample string 7</BrowserAgent>
  <DeviceID xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">sample string 9</DeviceID>
  <IpAddress xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">sample string 8</IpAddress>
  <Origin xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">Web</Origin>
  <IsDomainUser>true</IsDomainUser>
  <IsPublicAccount>true</IsPublicAccount>
  <Password>sample string 2</Password>
  <SecuredOTPCode>sample string 6</SecuredOTPCode>
  <UserOTP>sample string 5</UserOTP>
  <Username>sample string 1</Username>
</AuthenticationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AuthenticationRequest'.

Response Information

Resource Description

AuthResult
NameDescriptionTypeAdditional information
UserId

integer

None.

PublicAccountID

integer

None.

Username

string

None.

FullName

string

None.

IsPublic

boolean

None.

TenantID

integer

None.

EmailAddress

string

None.

Token

string

None.

Photo

Collection of byte

None.

MobileNo

string

None.

Error

boolean

None.

Remarks

string

None.

Response Formats

application/json, text/json

Sample:
{
  "UserId": 1,
  "PublicAccountID": 2,
  "Username": "sample string 3",
  "FullName": "sample string 4",
  "IsPublic": true,
  "TenantID": 6,
  "EmailAddress": "sample string 7",
  "Token": "sample string 8",
  "Photo": "QEA=",
  "MobileNo": "sample string 9",
  "Error": true,
  "Remarks": "sample string 11"
}

application/xml, text/xml

Sample:
<AuthResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">
  <EmailAddress>sample string 7</EmailAddress>
  <Error>true</Error>
  <FullName>sample string 4</FullName>
  <IsPublic>true</IsPublic>
  <MobileNo>sample string 9</MobileNo>
  <Photo>QEA=</Photo>
  <PublicAccountID>2</PublicAccountID>
  <Remarks>sample string 11</Remarks>
  <TenantID>6</TenantID>
  <Token>sample string 8</Token>
  <UserId>1</UserId>
  <Username>sample string 3</Username>
</AuthResult>