Get platforms

This method returns all existing account platforms from the Vault.

You can use filters to retrieve a subset of the platforms or search for a specific platform. For details, see URL parameters.

The Get platform details API, used to retrieve details for a specific platform, returns a different set of parameters.

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/

URL parameters

You can use the following search or filter parameters:

Parameter	Description
Active	Filter according to whether the platform is active or not. Valid values: true or false Example: `https://<IIS_Server_Ip>/PasswordVault/API/platforms?Active=True`
PlatformType	Filter according to the platform type. Valid values: Group or Regular Example: `https://<IIS_Server_Ip>/PasswordVault/API/platforms?PlatformType=Regular`
PlatformName	Searching according to the platform name. Type: string Example:`https://<IIS_Server_Ip>/PasswordVault/API/platforms?Search=Win`

Parameter

Description

Active

Filter according to whether the platform is active or not.

Valid values: true or false

Example: https://<IIS_Server_Ip>/PasswordVault/API/platforms?Active=True

PlatformType

Filter according to the platform type.

Valid values: Group or Regular

Example: https://<IIS_Server_Ip>/PasswordVault/API/platforms?PlatformType=Regular

PlatformName

Searching according to the platform name.

Type: string

Example:https://<IIS_Server_Ip>/PasswordVault/API/platforms?Search=Win

Resource information

HTTP method	GET
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.

Result

{

  "Platforms": [

    {

      "general": {

        "id": "WinDomain",

        "name": "Windows Domain Account",

        "systemType": "Windows",

        "active": true,

        "description": "",

        "platformBaseID": "WinDomain",

        "platformType": "regular"

      },

      "properties": {

        "required": [

          {

            "name": "Address",

            "displayName": "Address"

          },

          {

            "name": "Username",

            "displayName": "Username"

          }

        ],

        "optional": [

          {

            "name": "LogonDomain",

            "displayName": "Logon To"

          },

          {

            "name": "UserDN",

            "displayName": "User DN"

          },

          {

            "name": "Port",

            "displayName": "Port"

          }

        ]

      },

      "linkedAccounts": [

        {

          "name": "LogonAccount",

          "displayName": "Logon Account"

        },

        {

          "name": "ReconcileAccount",

          "displayName": "Reconcile Account"

        }

      ],

      "credentialsManagement": {

        "allowedSafes": ".*",

        "allowManualChange": true,

        "performPeriodicChange": false,

        "requirePasswordChangeEveryXDays": 90,

        "allowManualVerification": true,

        "performPeriodicVerification": false,

        "requirePasswordVerificationEveryXDays": 7,

        "allowManualReconciliation": true,

        "automaticReconcileWhenUnsynched": false

      },

      "sessionManagement": {

        "requirePrivilegedSessionMonitoringAndIsolation": false,

        "recordAndSaveSessionActivity": true,

        "PSMServerID": "PSMServer_239d800"

      },

      "privilegedAccessWorkflows": {

        "requireDualControlPasswordAccessApproval": false,

        "enforceCheckinCheckoutExclusiveAccess": false,

        "enforceOnetimePasswordAccess": false

      }

    }

  ],

  "Total": 1

}

Parameter	Description
General
id	The platform's unique ID. Type: string
name	The name of the platform. Type: string
active	Indicates whether a platform is active or inactive. Valid values: true\false Type: boolean
description	A description of the platform. Type: string
platformBaseID	The ID of the default platform that this platform is based on (duplicated from). Type: string
platfromType	Indicates if the platform is a group platform. Valid values: Group\Regular Type: boolean
systemType	The type of system to which the platform is applied. Type: string
Properties
required	A list of all required properties defined for the platform. Each property includes a name and a display name.
name	Type: string
displayName	Type: string
optional	A list of all optional properties defined for the platform. Each property includes a name and a display name.
name	Type: string
displayName	Type: string
linkedAccounts	A list of all linked accounts types that are relevant for the platform, each linked account has a name and a display name.
name	Type: string
displayName	Type: string
privilegedAccessWorkflows
requireDualControlPasswordAccessApproval	Indicates whether accounts associated with this platform require dual control. Valid values: true\false Type: boolean
enforceCheckinCheckoutExclusiveAccess	Indicates whether the Enforce check-in/check-out exclusive access rule is active or inactive for this platform. Valid values: true\false Type: boolean
enforceOnetimePasswordAccess	Indicates whether the Enforce one-time password access rule is active for this platform. Valid values: true\false Type: boolean
sessionManagement
requirePrivilegedSessionMonitoringAndIsolation	Indicates whether the Require privileged session monitoring and isolation rule is active for this platform. Valid values: true\false Type: boolean
recordAndSaveSessionActivity	Indicates whether the Record and save session activity rule is active for this platform. Valid values: true\false Type: boolean
PSMServerID	The unique ID of a PSM Server. Type: string
credentialsManagement
allowedSafes	A list of safes (regular expression) to which this platform can be applied. Type: string
allowManualChange	Indicates whether a 'Change now' process can be initiated manually. Valid values: true\false Type: boolean
performPeriodicChange	Indicates whether accounts related to this platform will be changed periodically. Valid values: true\false Type: boolean
requirePasswordChangeEveryXDays	The number of days between each periodic change. Type: number
allowManualVerification	Indicates whether a 'Verify now' process can be initiated manually. Valid values: true\false Type: boolean
performPeriodicVerification	Indicates whether accounts related to this platform will be verified periodically. Valid values: true\false Type: boolean
requirePasswordVerificationEveryXDays	The number of days between each periodic verification. Type: number
allowManualReconciliation	Indicates whether a 'Reconcile now' process can be initiated manually. Valid values: true\false Type: boolean
automaticReconcileWhenUnsynched	Whether or not passwords will be reconciled automatically after the CPM detects a password on a remote machine that is not synchronized with its corresponding password in the Server. Valid values: true\false Type: boolean

Return codes

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