Authentication with Usernames
This method allows developers to authenticate with Rev using a specific Rev username and password. This method is typically used for integrations where no user interface or user interaction is required. Once a session is established using this login API, subsequent API calls using will be limited according to the privileges of the authenticated user.
/user/login API is used to authenticate with Rev by specifying a username and password. The
token value in the response is used to build the authorization header value for subsequence API calls.
Authorization = VBrick <token>
expiration value in the response indicates the date/time when the session will expire. Please note that the expiration value is determined by the Session Inactivity Timeout value as specified in the Rev admin console under System Settings->Security.
userId value in response is the unique identifier of the logged in user.
/user/extend-session-timeout API is used keep the current session alive, i.e. to prevent the session from timing out. Successful completion of this API call will return a new
expiration date/time when the session will expire. The
userId value (provided in the login response) is passed into the API to identify the user whose session will be extended. If this API call is not made prior to the expiration date/time, subsequent API requests will fail as the session will no longer be valid.
/user/logout API is used to end the login session. The
userId value (provided in the login response) is passed into the API to identify the user who is logging out.