Monitor an active session

This method enables you to monitor an active PSM session using a connection method defined in the PVWA. For details on configuration, see Active session monitoring settings.

A response header defines which connection method is returned.

For details, see Privileged Session Management Interface.

URL

 

Make sure there are no spaces in the URL.

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

 

 

https://<IIS_Server_Ip>/PasswordVault/api/LiveSessions/{liveSessionId}/Monitor

The following mandatory value is required in the URL:

Parameter

liveSessionID

Type

String

Description

The unique ID of the PSM session to monitor.

Resource information

HTTP method

GET

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session, encoded in BASE 64.

Parameter

Accept

Type

String

Description

The table below describes the expected response format depending on the value of the Accept header in the request, per connection method configuration (RDP File or PSM Gateway).

 

PVWA configuration Optional values Connection method
RDP

application/json

application/octet-stream (default)

*/ *

RDPFile (JSON)

RDPFile (octet-stream raw)

PSMGW * / *

PSMGW (JSON)

Returns the HTML5 connection data.

PSMGW must be configured before using this REST API in order to receive a PSMGW response.

Body parameters

None

Result

Response header

Parameter

ConnectionMethod

Type

Boolean

Description

The method set in ConnectionType in the body parameters.

Values

PSMGW

RDPFile

Response body

There are two possible responses, depending on the connection method.

Return codes

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