Get dependent platforms

This method allows the Vault Admin to retrieve basic information about all existing dependent platforms.

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/

 
https://<IIS_Server_Ip>/PasswordVault/API/platforms/dependents/

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

URL parameter

Parameter

Description

search

Search for a string in the following field:

  • Platform Name

Type: string

Example: https://{server}/passwordvault/api/Platforms/Dependents?search=SSH

Body parameters

None.

Result

 
{
 "Platforms": [
    {
        "NumberOfLinkedTargetPlatforms": 11,
        "CredentialsManagementPolicy": {
            "Change": {
                "AllowManual": true
                }
            },
        "ID": 1,
        "PlatformID": "ComPlus",
        "Name": "COM+ Application"
    },
  ],
 "Total": 1
}

Parameter

Description

general

id

Unique numeric ID of the platform.

Type: number

platformID

Unique display ID of the platform.

Type: string

name

Display name of the platform.

Type: string

numberOfLinkedTargetPlatforms

Number of target platforms that are linked to this platform.

Type: number

credentialsManagement

tasksRoles

change

allowManualChange

Indicates whether an immediate change process can be initiated manually.

Type: boolean

Return codes

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