RememberUser

From Gvp-public
Jump to navigation Jump to search

Description

RememberUser return a new login object with a new expiration time.

Used to create a token by a new valid period. This new time duration is defined by the property expirationMinute that the value is expressed in minutes. The both parameter is required and the token need be valid (logged) to this request.

Use case: A new object login information has a token that can be maintain the user connected instead of the user close the browser by write the information on a cookie.

Parameters

  • token (String, required)
A valid token for identifying the API session context and logged user
  • expirationMinute (int, required)
Sets the time duration for the token. This value is expressed in minutes. It's used when the device client wants to re-generate a new token with another time duration.


Returns

Returns a JSON object containing an Login object with the new expiration for token.

Example:

{

Login object,

}


Exceptions

Caching

This method is not cached.


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral


See also