Terminate an active session
This method enables the system to terminate an active PSM or PSM for SSH session immediately to prevent high-risk activities.
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/
|
|
The following mandatory values are required in the URL:
Parameter |
LiveSessionsId |
Type |
String |
Description |
The unique ID of the PSM or PSM for SSH 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 |
Description |
---|---|
Authorization |
The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None |
Body parameters
None
Configuration
-
Log on to the PVWA as a user with the Administrator permission.
-
Navigate to Administration > Options, and select Privileged Session Management > General Settings > Server Settings > Live Sessions Monitoring Settings.
-
Check that the AllowPSMNotifications setting is set to Yes.
-
Click Apply.
-
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.
-
Click Apply and then click OK.
|
This parameter is not supported on OPM sessions. |
Return codes
For a complete list of return codes, see Return Codes.