Get target platforms

This method allows users to retrieve basic information of all existing target platforms.

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

Resource information

HTTP method

Content type

GET

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

 

Make sure there are no spaces in the URL.

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

 
https://<IIS_Server_Ip>/passwordvault/api/platforms/targets

URL parameters

Parameter

Description

Filters

Filter according to REST standard. You can use the following filters:

  • active
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=active eq True

  • systemType
    Type: String
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=systemType eq Databases

  • periodicVerify
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=periodicVerify eq True

  • manualVerify
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=manualVerify eq True

  • periodicChange
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=periodicChange eq True

  • manualChange
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=manualChange eq True

  • automaticReconcile
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=automaticReconcile eq True

  • manualReconcile
    Valid Values: True, False
    Example: https://{server}/passwordvault/api/Platforms/Targets/Filters=manualReconcile eq True

Note: To use more than one filter, you can use the AND operator. For example: https://{server}/passwordvault/api/Platforms/Targets/Filters=active eq True AND systemType eq Databases

search

Search for a string in the following field:

  • Platform Name

Type: string

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

Body parameters

None.

Result

 
{
    "Platforms": [
    {
        "ID": 10,
        "PlatformID": "WinDesktopLocal",
        "Name": "Windows Desktop Local Accounts",
        "Active": true,
        "SystemType": "Windows",
        "AllowedSafes": ".*",
        "PrivilegedAccessWorkflows": {
        "RequireDualControlPasswordAccessApproval": {
            "IsActive": false,
            "IsAnException": false
        },
        "EnforceCheckinCheckoutExclusiveAccess": {
            "IsActive": false,
            "IsAnException": false
        },
        "EnforceOnetimePasswordAccess": {
            "IsActive": false,
            "IsAnException": false
        },
        "RequireUsersToSpecifyReasonForAccess": {
            "IsActive": true,
            "IsAnException": false
        }
        },
        "CredentialsManagementPolicy": {
            "Verification": {
                "PerformAutomatic": false,
                "RequirePasswordEveryXDays": 7,
                "AutoOnAdd": false,
                "IsRequirePasswordEveryXDaysAnException": false,
                "AllowManual": true
            },
            "Change": {
                "PerformAutomatic": false,
                "RequirePasswordEveryXDays": 90,
                "AutoOnAdd": false,
                "IsRequirePasswordEveryXDaysAnException": false,
                "AllowManual": true
            },
            "Reconcile": {
                "AutomaticReconcileWhenUnsynced": false,
                "AllowManual": true
            },
            "SecretUpdateConfiguration": {
                "ChangePasswordInResetMode": false
            }
        },
        "PrivilegedSessionManagement": {
            "PSMServerId": ""
        }
    }
    ],
"Total": 1
}

Parameter

Description

general

id

Unique numeric ID of the platform.

Type: number

platformID

Unique string ID of the platform.

Type: string

name

The display name of the platform.

Type: string

active

Indicates whether a platform is active or inactive.

Type: boolean

systemType

The type of system associated with the target.

Type: string

allowedSafes

Regex of safes in which accounts from this platform can be managed.

Type: string

credentialsManagement

tasksRoles

verification
allowManual

Indicates whether an immediate verify process can be initiated manually.

Type: boolean

performPeriodic

Indicates whether accounts related to this platform will be verified periodically.

Type: boolean

requirePasswordEveryXDays

The number of days between each periodic verification.

Type: number

autoOnAdd

Indicates whether accounts related to this platform will be changed after being added.

Type: boolean

isRequirePasswordEveryXDaysAnException

Indicates whether the number of days between each periodic change is an exception to the master policy.

Type: boolean

change

allowManual

Indicates whether an immediate change process can be initiated manually.

Type: boolean

performPeriodic

Indicates whether accounts related to this platform will be changed periodically.

Type: boolean

requirePasswordEveryXDays

The number of days between each periodic change.

Type: number

autoOnAdd

Indicates whether accounts related to this platform will be changed after being added.

Type: boolean

isRequirePasswordEveryXDaysAnException

Indicates whether the number of days between each periodic change is an exception to the master policy.

Type: boolean

reconcile

allowManual

Indicates whether an immediate reconcile process can be initiated manually.

Type: boolean

automaticReconcileWhenUnsynched

Indicates 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.

Type: boolean

secretUpdateConfiguration
changePasswordInResetMode

Defines whether or not password changes will be performed via reset mode using the reconciliation account. This is useful in cases where the password policy prevents the user from changing his own password or when a password minimal age restriction is applied.

Type: boolean

privilegedAccessWorkflows
requireDualControlPasswordAccessApproval
isActive

Indicates whether accounts associated with this platform require dual control.

Type: boolean

isAnException

Indicates whether RequireDualControlPasswordAccessApproval is an exception to the master policy.

Type: boolean

enforceCheckinCheckoutExclusiveAccess
isActive

Indicates whether the Enforce check-in/check-out exclusive access rule is active or inactive for this platform.

Type: boolean

isAnException

Indicates whether EnforceCheckinCheckoutExclusiveAccess is an exception to the master policy.

Type: boolean

enforceOnetimePasswordAccess
isActive

Indicates whether the Enforce one-time password access rule is active for this platform.

Type: boolean

isAnException

Indicates whether EnforceOnetimePasswordAccess is an exception to the master policy.

Type: boolean

requireUsersToSpecifyReasonForAccess
isActive

Allow users to specify free text reason for access

Type: boolean

isAnException

Indicates whether RequireUsersToSpecifyReasonForAccess is an exception to the master policy.

Type: boolean

privilegedSessionManagement

PSMServerId

Name of the PSM Server linked to the platform

Type: string

Return codes

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