POST api/user/auth
Request Information
URI Parameters
None.
Body Parameters
UserCredentialName | Description | Type | Additional information |
---|---|---|---|
UserName | string |
Required |
|
Password | string |
Required |
|
IpAddress | string |
None. |
|
UserEnvironment | string |
None. |
|
BrowserName | string |
None. |
|
Version | string |
None. |
|
Platform | string |
None. |
|
UserAgent | string |
None. |
|
GeoLocation | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserName": "sample string 1", "Password": "sample string 2", "IpAddress": "sample string 3", "UserEnvironment": "sample string 4", "BrowserName": "sample string 5", "Version": "sample string 6", "Platform": "sample string 7", "UserAgent": "sample string 8", "GeoLocation": "sample string 9" }
application/xml, text/xml
Sample:
<UserCredential xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/"> <BrowserName>sample string 5</BrowserName> <GeoLocation>sample string 9</GeoLocation> <IpAddress>sample string 3</IpAddress> <Password>sample string 2</Password> <Platform>sample string 7</Platform> <UserAgent>sample string 8</UserAgent> <UserEnvironment>sample string 4</UserEnvironment> <UserName>sample string 1</UserName> <Version>sample string 6</Version> </UserCredential>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AuthResponseName | Description | Type | Additional information |
---|---|---|---|
Id | string |
None. |
|
Token | string |
None. |
|
RefreshToken | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "sample string 1", "Token": "sample string 2", "RefreshToken": "sample string 3" }
application/xml, text/xml
Sample:
<AuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/"> <Id>sample string 1</Id> <RefreshToken>sample string 3</RefreshToken> <Token>sample string 2</Token> </AuthResponse>