Login method

This method authenticates the user with the system, connects to the application, and obtains the authentication token.

Request

Method URL
GET

/<IIS_Application>/<application>/api/v2.0/Login?username=<username>&password=<password>&InsideWorkspace=<insideWorkspace>
Parameter Type Value
Accept HEAD application/json

Where application is the application to connect to.

This is the unique name returned by the applications request.

<application> URL_PARAM String specifying the name of the application.
<username> URL_PARAM String specifying the user name.
<password> URL_PARAM String specifying the password.
<insideWorkspace> URL_PARAM Boolean specifying the workspace.
<clientinfo> URL_PARAM String specifying the <clientinfo> parameters. The parameters are:
  • agent is the user agent
  • culture is the client language
  • dpi is the dots per inch
  • dpr is the device pixel ratio
  • scrollbars is the scroll bar size in the outer frame
  • timeshift is the time zone
  • orientation

For example:

{ dpr = 1, timeshift = 2, agent = "iOS", scrollbars = { vertical = 0, horizontal = 0 }, culture = "en-US" }

Response

Status Type Parameters Response
200 BODY 
{
   "success": true
}
HEAD Set-Cookie

ASP.NET_SessionId = <session_key>
HEAD Set-Cookie

ASP.NET_SessionId_app = <session_app_key>; path=/<IIS_Application>/<application>; httponly
500 
{ 
"message": "Repository not found."
 }
500 
{
"message": "Application '<application_uniquename>' was not found or user does not have necessary permissions."
}
500 
{
"message": "The username or password is incorrect."
}