Terminate an active session

This method enables the system to terminate an active PSM session immediately to prevent high-risk activities. For more information on configuration, see Active session monitoring settings.

URL

 

Make sure there are no spaces in the URL.

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

 

 

https://<Server>:<port>/PasswordVault/API/LiveSessions/<LiveSessionId>/Terminate

The following mandatory values are required in the URL:

Parameter

LiveSessionsId

Type

String

Description

The unique ID of the PSM Active Session.

Valid values

-

Parameter

Action

Type

String

Description

The action that will be triggered by this method.

Valid values

Terminate

Resource information

HTTP method

POST

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

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

Valid values

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

Body parameters

None

Configuration

  1. Log on to the PVWA as a user with the Administrator permission.

  2. Navigate to Administration > Options, and select Privileged Session Management > General Settings > Server Settings > Live Sessions Monitoring Settings.

  3. Check that the AllowPSMNotifications setting is set to Yes.

  4. Click Apply.

  5. Expand Live Sessions Monitoring Settings > Terminating Live Sessions Users and Groups and make sure that the user who will run the API or the group to which the user belongs is listed here.

  6. Click Apply and then click OK.

 

This parameter is not supported on PSM for SSH and OPM sessions.

Return codes

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