Get-VPASIncomingRequestDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET INCOMING REQUEST DETAILS


Description:

USE THIS FUNCTION TO GET THE DETAILS OF AN EXISTING INCOMING REQUEST


Syntax:

Get-VPASIncomingRequestDetails [[-RequestedSafe] <String>] [[-RequestedPlatform] <String>] [[-RequestedUsername] <String>] [[-RequestedAddress] <String>] [[-RequestedAcctID] <String>] [[-RequestedReason] <String>] [[-requestID] <String>] [[-token] <Hashtable>] [<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 incoming request, passing this variable will skip any query functions

Required: false
Position: 7
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: 8
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:

$IncomingRequestDetailsJSON = Get-VPASIncomingRequestDetails -RequestedUsername {USERNAME VALUE} -RequestedReason {REASON VALUE}

$IncomingRequestDetailsJSON = Get-VPASIncomingRequestDetails -requestID {REQUESTID VALUE}


Outputs:

If successful:
{
         "VPASRequestSafe_20": {
                 "RequestorFullName": "vadim",
                 "RequestID": "VPASRequestSafe_20",
                 "SafeName": "VPASRequestSafe",
                 "RequestorUserName": "vadim@vman.com",
                 "RequestorReason": "(ConnectionClient=PSM-RDP) Testing Account Request",
                 "UserReason": "Testing Account Request",
                 "CreationDate": 1724125545,
                 "Operation": "Connect to VPASDualControl-DomainAdmin011-vman.com",
                 "ExpirationDate": 1726717545,
                 "OperationType": 4,
                 "AccessType": "ManyTimes",
                 "ConfirmationsLeft": 1,
                 "AccessFrom": 1724158800,
                 "AccessTo": 1724173200,
                 "Status": 1,
                 "StatusTitle": "Waiting: 1 more user(s) must confirm the request",
                 "InvalidRequestReason": 0,
                 "CurrentConfirmationLevel": 1,
                 "RequiredConfirmersCountLevel2": 1,
                 "TicketingSystemProperties": {
                         "Name": null,
                         "Number": null,
                         "Status": null
                 },
                 "AdditionalInfo": {
                        
                 },
                 "AccountDetails": {
                         "AccountID": "120_3",
                 "Properties": "@{Address=vman.com; Safe=VPASRequestSafe; Folder=Root; Name=Operating System-VPASDualControl-vman.com-DomainAdmin01; PolicyID=VPASDualControl; PlatformName=VPASDualControl; DeviceType=Operating System; LastModifiedDate=1715222718000; LastModifiedBy=vadim@vman.com; LastUsedDate=1715222731000; LastUsedBy=vadim@vman.com; UserName=DomainAdmin011; LockedBy=; CPMDisabled=; CPMStatus=NoAction; ManagedByCPM=True; DeletedBy=; DeletionDate=0; ImmediateCPMTask=NoTask; LastCPMTask=NoTask; CreationDate=1715222718; IsSSHKey=False; IsIrregularPlatform=False; CreationMethod=PVWA}"
                 },
                 "Confirmers": [
                 "@{Type=1; ID=41; Name=vadim@vman.com; Action=2; Reason=; ActionDate=0; AdditionalDetails=; Members=}"
                 ]
         }
}

$false if failed