[OPENAM-7391] Documentation for changes to Session Resource due to OPENAM-7235 Created: 10/Nov/15  Updated: 21/Dec/15  Resolved: 21/Dec/15

Status: Resolved
Project: OpenAM
Component/s: documentation
Affects Version/s: 13.0.0
Fix Version/s: 13.0.0

Type: Bug Priority: Major
Reporter: David Luna Assignee: David Goldsmith
Resolution: Fixed Votes: 0
Labels: AME, SHAKESPEARE
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to OPENAM-7235 Fetch additional SSOToken attributes ... Resolved
Sprint: Sprint 100 - Team Shakespeare

 Description   

Please document the changes to the interface as defined by OPENAM-7235.

Specifically, the changes in full are:

  • Use of 'getMaxTime' against the Session Resource is now deprecated in favour of the new 'getTimeLeft'
  • 'getTimeLeft' has been added to the Session Resource, indicating the time left on your session
  • 'getMaxSessionTime' has been added to the Session Resource, indicating the total time that was available in your session
  • 'getMaxIdle' has been added to the SessionResource, indicating the total time that is available for this session to be idle
  • 'getIdle' remains unchanged, indicating the time remaining that a session may be idle.


 Comments   
Comment by David Goldsmith [ 21/Dec/15 ]

https://stash.forgerock.org/projects/OPENAM/repos/openam-docs/pull-requests/100/overview

You can find the change after the nightly build at http://openam.forgerock.org/doc/bootstrap/dev-guide/index.html#rest-api-session-information

Generated at Tue Nov 24 20:46:02 UTC 2020 using Jira 7.13.12#713012-sha1:6e07c38070d5191bbf7353952ed38f111754533a.