POST api/login

Performs a login to the API. Upon successful authentication, an AccessToken is returned which has to be sent in the Autorization-header to access the API actions. Example: Return values from the call to the login action:{"UserName":"IBISUSER","AccessToken":"ThisIsTheAccessToken"} Contents of the header to be sent along with requests to the API:Authorization: Bearer ThisIsTheAccessTokenPlease note the prefix "Bearer " which has to be appended to the token.

Request Information

URI Parameters

None.

Body Parameters

UserName and password for the user to login as

LoginInfo
NameDescriptionTypeAdditional information
UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<LoginInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IbisApi.Models">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</LoginInfo>

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

Response Information

Resource Description

An authentication token which has to be sent along with each subsequent request to the API

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.