POST api/Login/Authenticate

Api method to Authenticate a user by login name and password

Request Information

URI Parameters

None.

Body Parameters

AuthenticationInput
NameDescriptionTypeAdditional information
Username

string

Required
Password

string

Required
AllowRefresh

boolean

None.
RefreshKey

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AllowRefresh": true,
  "RefreshKey": "sample string 4"
}

application/xml, text/xml

Sample: 
<AuthenticationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models">
  <AllowRefresh>true</AllowRefresh>
  <Password>sample string 2</Password>
  <RefreshKey>sample string 4</RefreshKey>
  <Username>sample string 1</Username>
</AuthenticationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationResponseModel
NameDescriptionTypeAdditional information
EntityId

integer

None.
Gender

string

None.
IsDependent

boolean

None.
AnyPrimaryIndividualPolicy

boolean

None.
PendingPaymentCount

integer

None.
ProfitRegion

string

None.
IsEAPEnabled

boolean

None.
ProductCategory

string

None.
HasUserAcknowledged

boolean

None.
IsAuthenticated

boolean

None.
UserInfo

SysUserData

None.
AuthenticationToken

string

None.
RefreshToken

string

None.
SessionId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "EntityId": 1,
  "Gender": "sample string 2",
  "IsDependent": true,
  "AnyPrimaryIndividualPolicy": true,
  "PendingPaymentCount": 5,
  "ProfitRegion": "sample string 6",
  "IsEAPEnabled": true,
  "ProductCategory": "sample string 8",
  "HasUserAcknowledged": true,
  "IsAuthenticated": true,
  "UserInfo": null,
  "AuthenticationToken": "sample string 11",
  "RefreshToken": "sample string 12",
  "SessionId": "sample string 13"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.