POST Auth/Logon
Logon with username and password
Request Information
URI Parameters
None.
Body Parameters
A model containing logon info
LoginModelName | Description | Type | Additional information |
---|---|---|---|
UserName | string |
None. |
|
Password | string |
None. |
|
Secure | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserName": "JohnDoe", "Password": "JohnDoespassword", "Secure": true }
application/xml, text/xml
Sample:
<LoginModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <UserName>JohnDoe</UserName> <Password>JohnDoespassword</Password> <Secure>true</Secure> </LoginModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns a model containing a key, a token and a user ID. The key is stored within your app and used to encrypt the content you send to our server, when you send the encrypted content to our server, also send the token to us, so we can decrypt your content
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Token": "sample string 1", "AccessKey": "sample string 2", "UserId": 3, "NewAuthKey": "sample string 4" }
application/xml, text/xml
Sample:
<AuthTicketModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Token>sample string 1</Token> <AccessKey>sample string 2</AccessKey> <UserId>3</UserId> <NewAuthKey>sample string 4</NewAuthKey> </AuthTicketModel>