Get user details

getUserDetails

URL

/api/v1/getUserDetails

Description

Used by IonReporterUploader plugin to get user details based on username and password. Returns the user details.

Method

POST

Request query parameters

  • userName

    String, Mandatory.

    Valid username.

  • password

    String, Mandatory.

    Valid password.

Example request 

https://user1.XYZ.com/api/v1/getUserDetails

Request headers

Content-Type: application/x-www-form-urlencoded

Returns 


{
  "tokendate": "2013-12-08 15:39:37.0",
  "firstname": "Ion",
  "eulaAccepted": "true",
  "userStatus": "ENABLED",
  "orgname": "IR Org",
  "exporttokendate": "2015-11-05 03:25:12.0",
  "exporttoken": "49bbe49a8307ba61ef28ee9a9122a98347576488c975c857b7e1c82978f3818c",
  "lastname": "User",
  "token": "wVcoTeYGfKxItiaWo2lngsV/r0jukG2pLKbZBkAFnlPbjKfPTXLbIhPb47YA9u78"
}

Response fields

Status code

Response message

200

Successful response

400

Bad request

404

Not found

401

User is not authenticated

500

Error occurred

Curl command

curl -X POST -k https://<server name>/api/v1/getUserDetails -H "Content-Type:application/x-www-form-urlencoded" -d "userName=ion.reporter@lifetech
.com&password=IonPass123"