POST api/login

The first stage to authenticate with the web api and generate a secure token used to access the other protected web api methods

Request Information

URI Parameters

None.

Body Parameters

The username and password of the user you wish to log in as. Credentials have to be passed over SSL.

Credentials
NameDescriptionTypeAdditional information
Username

string

None.
Password

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Username": "tim",
  "Password": "YRu3xSJQhFfU"
}

application/xml, text/xml

Sample: 
<Credentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SumerianSecurity">
  <Password>YRu3xSJQhFfU</Password>
  <Username>tim</Username>
</Credentials>

Response Information

Resource Description

A string containing a 64 character hexadecimal secure token.

string

Response Formats

application/json, text/json

Sample: 
"CC62C5D11BDE2D11D50627837BCF7FA1E5795B7FA07CA8B583381EABCD490D70"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">CC62C5D11BDE2D11D50627837BCF7FA1E5795B7FA07CA8B583381EABCD490D70</string>