Session Entity

Use the session entity to query and manipulate sessions within Connect. Any user of Connect, whether using ODBC or REST, must first establish a session to perform any further operations within Connect. The entity supports the following actions:

  • GET /connect/v1/sessions – returns a list of active sessions
  • DELETE /connect/v1/sessions/{id} – lets a user with FULL Connect API privileges delete any active session.
The following are the attributes in the body of a session service.
Attribute Type Updatable Comments
 id UUID no
 username string no The username who logged in to obtain this session.
 isCurrentSession boolean no true is the current session was used to call GET /sessions. false if this is a different session from the current session.
 timeToLive int no The number of seconds the session is going to be active (starting from modifiedInstant).
 createdInstant datetime no The instant the session was created.
 createdBy string no username for the user who created the session.
 modifiedInstant datetime no The instant the session was last used.
 modifiedBy string no username for the user who created the session.

List of APIs

Note: We have tried to keep this list up to date. However, for the most up to date list, see the interactive docs: https://connect-i1.xactlycorp.com/connect/docs/swagger-ui.html

GET /connect/v1/sessions
Retrieves a list of all active sessions.
DELETE /connect/v1/sessions/{id}
Removes an existing session object effectively invalidating the session (i.e. logs the session out).