POST api/Security/AuthenticateExternal

Authenticate the given credentials against an external system

Request Information

URI Parameters

None.

Body Parameters

Details to be authenticated

ExternalAuthenticationInput
NameDescriptionTypeAdditional information
SourceSystem

System to be used as Authentication source

 ExternalSources

Required
Username

User Name for Login

 string

Required
Password

Password for Login

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "SourceSystem": 0,
  "Username": "sample string 1",
  "Password": "sample string 2"
}

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">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
  <SourceSystem>Local</SourceSystem>
</ExternalAuthenticationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Instance of AuthenticatedUserModel - With AuthenticationToken

AuthenticatedUserModel
NameDescriptionTypeAdditional information
IsAuthenticated

Indicates whether the User is Authenticated

 boolean

None.
UserInfo

Instance of the User Details. Null if the User is not Authenticated

 SysUserData

None.
AuthenticationToken

API authentication token for the User. Empty if the User is not Authenticated

 string

None.
SessionId

string

None.

Response Formats

application/json, text/json

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

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.