Get active session

This method returns the details of an active session.

URL

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %
If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

https://<IIS_Server_Ip>/PasswordVault/API/livesessions/{liveSessionId}/

The following mandatory value is required in the URL:

Parameter	liveSessionId
Type	String
Description	The unique ID of the active PSM session.

Resource Information

HTTP method	GET
Content type	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None

Body parameters

None

Result

{
  "LiveSessions": [
    {
      "CanTerminate": <true/false>,
      "CanMonitor": <true/false>,
      "CanSuspend": <true/false>,
      "SessionID": "<session id>",
      "SessionGuid": "<session guid>",
      "SafeName": "<Safe name>",
      "FolderName": "<folder>",
      "IsLive": <true/false>,
      "FileName": "<file name>",
      "Start": <timestamp>,
      "End": <timestamp>,
      "Duration": <seconds>,
      "User": "<user>",
      "RemoteMachine": "<IP address>",
      "ProtectionDate": <timestamp>,
      "ProtectedBy": "User who protected the recording",
      "ProtectionEnabled": <true/false>,
      "AccountUsername": "<user>",
      "AccountPlatformID": "<platform ID>",
      "AccountAddress": "<timestamp>",
      "PIMSuCommand": "<command>",
      "PIMSuCWD": "<Current Working Directory>",
      "ConnectionComponentID": "<ID>",
      "PSMRecordingEntity": "<Recording entity>",
      "TicketID": "<ID>",
      "FromIP": "<timestamp>",
      "Protocol": "<protocol>",
      "Client": "<client>",
      "RiskScore": <score>,
      "Severity": "<severity>",
      "IncidentDetails": <details>,
      "RawProperties": {
        "Address": "<IP address>",
        "ConnectionComponentID": "ID",
        "DeviceType": "device type",
        "EntityVersion": "<version>",
        "ExpectedRecordingsList": "<list>",
        "PolicyID": "<policy ID>",
        "ProviderID": "<ID>",
        "PSMClientApp": "<PSMClientApp>",
        "PSMPasswordID": "<ID>",
        "PSMProtocol": "<protocol>",
        "PSMRecordingEntity": "<PSMRecordingEntity>",
        "PSMRemoteMachine": "<timestamp>",
        "PSMSafeID": "<ID>",
        "PSMSourceAddress": "<timestamp>",
        "PSMStartTime": "<timestamp>",
        "PSMStatus": "Placeholder",
        "PSMVaultUserName": "<user>",
        "UserName": "<user>",
        "Safe": "<Safe>",
        "Folder": "<folder>",
        "Name": "<session name>"
      },
      "RecordingFiles": [<files>],
      "RecordedActivities": [<activities>],
      "VideoSize": <size>,
      "TextSize": <size>,
      "DetailsUrl": "<URL>"
    }
  ],
  "Total": <total>
}

Return codes

For a complete list of return codes, see Return Codes.