Get all connection components

This method allows the Vault admin to get the list of all connection components of an entire environment.

URL

 
https://<IIS_Server_Ip>/PasswordVault/API/PSM/Connectors/
  • 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/PSM/Connectors
 
 
Response:
{
  "PSMConnectors":[
    {
        "Id": "PSM-SSH",
        "DisplayName": "SSH"
    },
    {
        "Id": "PSM-WINSCP".
        "DisplayName": "Winscp"
    }
  ],
"Total": 2
}

Parameter

Description

PSMConnectors

Type: array

Id

The connection component ID, for example, "PSM-SSH"

Type: string

DisplayName

The display name of the connection component.

Type: string

Return codes

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