Jump to: navigation, search

Login

Method

GET

Syntax

 
/grs/v1/login

Request Body

N/A

Response Body

{
"apiToken": "749cf21d112cc88cdeb72c441724ec0b
71e53a6a7666e847209cac9593f96f5e",
"lastLogin": 0
}

HTTP Status Codes

  • 200 OK—Response Body Provided
  • 401 Unauthorized—Userid/Password not valid
  • 422 Unprocessable Entity
{
  "message": "Validation Failed",
  "errors": [
    {
       "code" : 1000,
       "message" : "Password Change Required"    
    }
  ]
}
  • 503—Service Unavailable

Additional Errors:

  • 1001—No User Connection
  • 1002—Client port bind failed
  • 1003—Max Connections Exceeded

Notes

Userid and Password are provided in the basic authorization header.

  • apiToken—A unique session apiToken is returned on a successful login. Userid and apiToken must be included on subsequent requests via the basic authorization header.
  • lastLogin—(If available from Configuration Server) is returned as a long representing time in ms since epoch.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 16 May 2017, at 01:20.