Approve-VPASIncomingRequest


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

APPROVE AN INCOMING REQUEST IN CYBERARK


Description:

USE THIS FUNCTION TO APPROVE AN INCOMING REQUEST IN CYBERARK


Syntax:

Approve-VPASIncomingRequest [[-RequestedSafe] <String>] [[-RequestedPlatform] <String>] [[-RequestedUsername] <String>] [[-RequestedAddress] <String>] [[-RequestedAcctID] <String>] [[-RequestedReason] <String>] [[-requestID] <String>] [-approveReason] <String> [[-token] <Hashtable>] [[-WhatIf]] [[-HideWhatIfOutput]] [<CommonParameters>]


Parameters:

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

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

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

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

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

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

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

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

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

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

-RequestedReason <String>
Reason that will be used to query and find the target account request

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

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

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

-approveReason <String>
Reason for approving the incoming request, will be saved for audit purposes

Required: true
Position: 8
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: 9
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WhatIf [<SwitchParameter>]
Run code simulation to see what is affected by running the command as well as any possible implications
This is a code simulation flag, meaning the command will NOT actually run

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

-HideWhatIfOutput [<SwitchParameter>]
Suppress any code simulation output from the console

Required: false
Position: 11
Default value: False
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:

$WhatIfSimulation = Approve-VPASIncomingRequest -RequestedAcctID {ACCTID VALUE} -requestID {REQUESTID VALUE} -approveReason {REASON VALUE} -WhatIf

$ApproveIncomingRequestStatus = Approve-VPASIncomingRequest -RequestedAcctID {ACCTID VALUE} -requestID {REQUESTID VALUE} -approveReason {REASON VALUE}


Outputs:

$true if successful

$false if failed