POST authenticate

authenticates a user

Request Information

URI Parameters

None.

Body Parameters

the authentication request. The user name can be either the AD user name or the email address

LoginRequest
NameDescriptionTypeAdditional information
UserName

string

None.

Password

string

None.

ClientIp

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "ClientIp": "sample string 3"
}

application/xml, text/xml

Sample:
<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SALT2.Objects.SecurityObjects">
  <ClientIp>sample string 3</ClientIp>
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</LoginRequest>

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 'LoginRequest'.

Response Information

Resource Description

JWT authentication token to be used in all API requests

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.