Login

NOTE: As of Rev v7.12, this API is available.

POST
/api/v1/user/login

Request Parameters

Name Type Description Required
username string Username for this user logging in to Rev Yes
password string Password for this user. Yes

Example Request

{
    "username" : "john.smith",
    "password": "Password123"
}

Example Response

{
  "token": "T9-GJqSH7dQSBqcUUVP0la6IHEyc9cR00Mj2ysD_fPwdKv0JMOcsJ9Sf2jR8nSvwgRgaZasExlH1xd5-XeqmUg2",
  "issuer": "VBrick",
  "expiration": "2017-08-31T15:00:10.599Z",
  "email": "john.smith@abc.com",
  "id": "5b8f0285-7627-4ee7-b67b-e2e9e8944279",
  "username": "john.smith",
  "firstName": "John",
  "lastName": "Smith",
  "language": "English"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Example – curl

REQUEST: Login and get an authentication token. change “myusername” and “mypassword” to the credentials for a Rev user.

curl -XPOST https://MY_REV_URL/api/v1/user/login -H "Content-Type:application/json" -d '{"username":"myusername","password":"mypassword"}'

Logoff

NOTE: As of Rev v7.18, this API is available.

POST
/api/v1/user/logoff

Request Parameters

Name Type Description Required
userId string GUID for the user. Yes

Example Request

{ 
"userId": "ec2507d0-d669-4f1c-81d7-1110b62fa7b3" 
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Extend Session Timeout

NOTE: As of Rev v7.18, this API is available.

POST
/api/v1/user/extend-session-timeout

Request Parameters

Name Type Description Required
userId string GUID for the user. Yes

Example Request

 
{ 
"userId": "ec2507d0-d669-4f1c-81d7-1110b62fa7b3" 
}

Example Response

{
  "expiration": "2017-09-05T14:31:24.093Z"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error