Get active session properties

This method returns property details of an active session.

URL

 

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

 

http://<IIS_Server_Ip>/PasswordVault/api/livesessions/{liveSessionId}/properties

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

Authorization

Type

String

Description

The token that identifies the session.

Valid values

A session token that was returned from the “Logon” method.

Body parameters

None

Result

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

Return codes

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