Invoke-VPASAccountPasswordAction


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

ACCOUNT PASSWORD ACTION


Description:

USE THIS FUNCTION TO TRIGGER A VERIFY/RECONCILE/CHANGE/CHANGE SPECIFY NEXT PASSWORD/CHANGE ONLY IN VAULT/GENERATE PASSWORD ACTIONS ON AN ACCOUNT IN CYBERARK


Syntax:

Invoke-VPASAccountPasswordAction -action <String> [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] [-newPass <String>] [-token <Hashtable>] [<CommonParameters>]

Invoke-VPASAccountPasswordAction -action <String> [-newPass <String>] -AcctID <String> [-token <Hashtable>] [<CommonParameters>]

Invoke-VPASAccountPasswordAction -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-action <String>
Specify what action will be run on the account
Possible values: Verify, Reconcile, Change, ChangeOnlyInVault, ChangeSetNew, GeneratePassword

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-safe <String>
Safe name that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-platform <String>
PlatformID that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-username <String>
Username that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-address <String>
Address that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-newPass <String>
Provide a new password if the action is ChangeOnlyInVault or ChangeSetNew

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AcctID <String>
Unique ID that maps to a single account, passing this variable will skip any query functions

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$AccountPasswordActionJSON = Invoke-VPASAccountPasswordAction -action {ACTION VALUE} -safe {SAFE VALUE} -address {ADDRESS VALUE} -username {USERNAME VALUE}

$InputParameters = @{
        action = "Verify"|"Reconcile"|"Change"|"GeneratePassword"|"ChangeOnlyInVault"|"ChangeSetNew"
        safe = "TargetSafeName"
        platform = "TargetPlatformID"
         username = "TargetUsername"
         address = "TargetAddress"
         newPass = "NewSecretPassword"
}
$AccountPasswordActionJSON = Invoke-VPASAccountPasswordAction -InputParameters $InputParameters

$InputParameters = @{
        action = "Verify"|"Reconcile"|"Change"|"GeneratePassword"|"ChangeOnlyInVault"|"ChangeSetNew"
         newPass = "NewSecretPassword"
        AcctID = "12_31"
}
$AccountPasswordActionJSON = Invoke-VPASAccountPasswordAction -InputParameters $InputParameters


Outputs:

$true if action was marked successfully
GeneratedPassword if action is GENERATE PASSWORD

$false if failed