Get recording details

This method returns details of a specific recorded 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/recordings/{recordingId}/

The following mandatory value is required in the URL:

Parameter

recordingId

Type

String

Description

The unique ID of the recorded 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

 
{
  "Recordings": [
    {
      "SessionID": "<id>",
      "SessionGuid": "<Session guid>",
      "SafeName": "<Safe name>",
      "FolderName": "<folder>",
      "IsLive": <true/false>,
      "FileName": "<file>",
      "Start": <timestamp>,
      "End": <timestamp>,
      "Duration": <duration>,
      "User": "<user>",
      "RemoteMachine": "<IP address>",
      "ProtectionDate": <date>,
      "ProtectedBy": "<details>",
      "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": "<list>",
        "PolicyID": "<id>",
        "ProviderID": "<id>",
        "PSMClientApp": "<client app>",
        "PSMPasswordID": "<id>",
        "PSMProtocol": "<protocol>",
        "PSMRecordingEntity": "<recording entity>",
        "PSMRemoteMachine": "<IP address>",
        "PSMSafeID": "<id>",
        "PSMSourceAddress": "<IP address>",
        "PSMStartTime": "<timestamp>",
        "PSMStatus": "<status>",
        "PSMVaultUserName": "<name>",
        "UserName": "<name>",
        "PSMEndTime": "<timestamp>",
        "ActualRecordings": "<recordings>",
        "Safe": "<Safe>",
        "Folder": "<folder>",
        "Name": "<name>"
      },
      "RecordingFiles": [
        {
          "FileName": "<file>",
          "RecordingType": <type>,
          "LastReviewBy": "<details>",
          "LastReviewDate": <date>,
          "FileSize": <size>,
          "CompressedFileSize": <size>,
          "Format": "<format>"
        },
.
.
.
      ],
      "RecordedActivities": [<activities>],
      "VideoSize": <size>,
      "TextSize": <size>,
      "DetailsUrl": "<details URL>"
    }
  ],
  "Total": <total>
}

Return codes

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