POST Login/Authenticate
Request Information
URI Parameters
None.
Body Parameters
LoginName | Description | Type | Additional 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:
<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/licuas_providers.Models"> <password>sample string 2</password> <username>sample string 1</username> </Login>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AuthName | Description | Type | Additional information |
---|---|---|---|
IsLoginSuccessful | boolean |
None. |
|
access_token | string |
None. |
|
expires_in | integer |
None. |
|
refresh_token | string |
None. |
|
scope | string |
None. |
|
userId | string |
None. |
|
userName | string |
None. |
|
error | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsLoginSuccessful": true, "access_token": "sample string 2", "expires_in": 3, "refresh_token": "sample string 4", "scope": "sample string 5", "userId": "sample string 6", "userName": "sample string 7", "error": "sample string 8" }
application/xml, text/xml
Sample:
<Auth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/licuas_providers.Models"> <IsLoginSuccessful>true</IsLoginSuccessful> <access_token>sample string 2</access_token> <error>sample string 8</error> <expires_in>3</expires_in> <refresh_token>sample string 4</refresh_token> <scope>sample string 5</scope> <userId>sample string 6</userId> <userName>sample string 7</userName> </Auth>