Update session management policy of platform

This method allows Vault admins to update the PSM Policy Section of a target platform.

URL

 
https://<IIS_Server_Ip>/passwordvault/api/Platforms/Targets/{PlatformId}/PrivilegedSessionManagement
 

Make sure there are no spaces in the URL.

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

Resource information

HTTP method

Content type

PUT

application/json

Header parameter

Parameter

Description

Authorization

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

Type: string

Mandatory: yes

Default value: none

URL parameter

Parameter

Description

platformId

A unique numeric ID of the platform.

Type: number

Mandatory: yes

Default value: none

Body parameters

 
{
    "PSMServerId":"PSMServer_e7b11b1",
    "PSMServerName":"PSMServer2",
    "PSMConnectors": [
        {
            "PSMConnectorID": "PSM-AWSConsoleWithSTS",
            "Enabled": false
        },
        {
            "PSMConnectorID": "SSH",
            "Enabled": true
        }
    ]
}

 

Parameter

Description

PSMServerId

The name of the PSM server linked to the platform.

Type: string

PSMConnectors

Type: array

PSMConnectorID

The PSM connector ID, for example, "PSM-WINSCP"

Type: string

Enabled

Whether or not the PSM connector ID is enabled.

Type: bool

Default value: true

Result

Parameter

Description

PSMServerId

The name of the PSM server linked to the platform.

Type: string

PSMConnectors

Type: array

PSMConnectorID

The PSM connector ID, for example, "PSM-WINSCP"

Type: string

Enabled

Whether or not the PSM connector ID is enabled.

Type: bool

Default value: true

Return codes

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