POST api/Security/AuthenticateExternal

Request Information

URI Parameters

None.

Body Parameters

ExternalAuthenticationInput
NameDescriptionTypeAdditional information
SourceSystem

ExternalSources

Required
Username

string

Required
Password

string

Required
AllowRefresh

boolean

None.
RefreshKey

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<ExternalAuthenticationInput 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>
  <SourceSystem>Local</SourceSystem>
</ExternalAuthenticationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticatedUserModel
NameDescriptionTypeAdditional information
IsAuthenticated

boolean

None.
UserInfo

SysUserData

None.
AuthenticationToken

string

None.
RefreshToken

string

None.
SessionId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsAuthenticated": true,
  "UserInfo": null,
  "AuthenticationToken": "sample string 2",
  "RefreshToken": "sample string 3",
  "SessionId": "sample string 4"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.