Get session management policy of platform

This method allows the Vault admins to retrieve 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: + & %

  • 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/

Resource information

HTTP method

Content type

GET

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

 
Request: "http://<IIS_Server_Ip>/PasswordVault/API/Platforms/Targets/{PlatformId}/PrivilegedSessionManagement"
 
Response:
{
    "PSMServerId": "PSMServer_e7b11b1",
    "PSMConnectors": [
        {
            "PSMConnectorID": "PSM-AWSConsoleWithSTS",
            "Enabled": true
        },
        {
            "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

Return codes

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