Functions/Accounts/Get-PASAccount.ps1
|
# .ExternalHelp psPAS-help.xml function Get-PASAccount { [CmdletBinding(DefaultParameterSetName = 'Gen2Query')] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2ID' )] [Alias('AccountID')] [string]$id, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [string]$search, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [ValidateSet('startswith', 'contains')] [string]$searchType, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [string]$safeName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [ValidateSet('Regular', 'Recently', 'New', 'Link', 'Deleted', 'PolicyFailures', 'AccessedByUsers', 'ModifiedByUsers', 'ModifiedByCPM', 'DisabledPasswordByUser', 'DisabledPasswordByCPM', 'ScheduledForChange', 'ScheduledForVerify', 'ScheduledForReconcile', 'SuccessfullyReconciled', 'FailedChange', 'FailedVerify', 'FailedReconcile', 'LockedOrNew', 'Locked', 'Favorites')] [string]$savedFilter, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [datetime]$modificationTime, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [string[]]$sort, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2Query' )] [ValidateRange(1, 1000)] [int]$limit, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [ValidateLength(0, 500)] [string]$Keywords, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [ValidateLength(0, 28)] [string]$Safe, [parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false )] [int]$TimeoutSec, [parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false, ParameterSetName = 'Gen2Query' )] [ValidateSet('AND', 'OR')] [string]$LogicalOperator = 'AND' ) DynamicParam { # Create dynamic parameters based on available search properties from the API # Only available for Gen2Query parameter set and version 14.4+ if ($PSCmdlet.ParameterSetName -eq 'Gen2Query' -and $script:psPASSession.ExternalVersion -ge [version]'14.4') { # Get available search properties from the API $SearchProperties = Get-PASAccountSearchProperty $paramDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary # List of existing static parameters to avoid duplicates $existingParams = @('id', 'search', 'searchType', 'safeName', 'savedFilter', 'modificationTime', 'sort', 'limit', 'Keywords', 'Safe', 'TimeoutSec', 'LogicalOperator') # Create dynamic parameter for each search property not already defined foreach ($property in $SearchProperties) { if ($existingParams -notcontains $property.PropertyName) { $paramAttribute = New-Object System.Management.Automation.ParameterAttribute $paramAttribute.Mandatory = $false $paramAttribute.ParameterSetName = 'Gen2Query' $paramAttribute.ValueFromPipelineByPropertyName = $false $attributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $attributeCollection.Add($paramAttribute) # Create runtime parameter for the search property $runtimeParam = New-Object System.Management.Automation.RuntimeDefinedParameter($property.PropertyName, [string], $attributeCollection) $paramDictionary.Add($property.PropertyName, $runtimeParam) } } return $paramDictionary } } BEGIN { #Parameter to include as filter value in url $Parameters = [Collections.Generic.List[String]]@('modificationTime', 'SafeName') # Add dynamic search properties to the filter parameters list for Gen2 14.4+ if ($PSCmdlet.ParameterSetName -match 'Gen2' -and $psPASSession.ExternalVersion -ge [version]'14.4') { $SearchProperties = Get-PASAccountSearchProperty # Build lookup for validation of supported operators $SearchPropertyLookup = @{} foreach ($property in $SearchProperties) { $SearchPropertyLookup[$property.PropertyName] = $property # Add property to filter parameters if ($property.PropertyName -notin @('modificationTime', 'SafeName')) { $Parameters.Add($property.PropertyName) } } } }#begin PROCESS { #Get Parameters to include in request $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove $Parameters $filterParameters = $PSBoundParameters | Get-PASParameter -ParametersToKeep $Parameters # Only use LogicalOperator for API 14.6+ if ($PSCmdlet.ParameterSetName -eq 'Gen2Query' -and $psPASSession.ExternalVersion -ge [version]'14.6') { $FilterString = $filterParameters | ConvertTo-FilterString -LogicalOperator $LogicalOperator } else { $FilterString = $filterParameters | ConvertTo-FilterString } switch ($PSCmdlet.ParameterSetName) { ( { $PSItem -match 'Gen2' } ) { switch ($PSBoundParameters) { ( { $PSItem.ContainsKey('savedFilter') }) { #check required version Assert-VersionRequirement -RequiredVersion 12.6 } ( { $PSItem.ContainsKey('modificationTime') }) { #check required version Assert-VersionRequirement -RequiredVersion 11.4 } ( { $PSItem.ContainsKey('searchType') }) { #check required version Assert-VersionRequirement -RequiredVersion 11.2 } default { #check minimum version Assert-VersionRequirement -RequiredVersion 10.4 } } #assign new type name $typeName = 'psPAS.CyberArk.Vault.Account.V10' #define base URL $URI = "$($psPASSession.BaseURI)/api/Accounts" } 'Gen1' { #assign type name $typeName = 'psPAS.CyberArk.Vault.Account' #Create request URL $URI = "$($psPASSession.BaseURI)/WebServices/PIMServices.svc/Accounts" } 'Gen2ID' { #define "by ID" URL $URI = "$URI/$id" break } ( { $PSItem -ne 'Gen2ID' } ) { If ($null -ne $FilterString) { $boundParameters = $boundParameters + $FilterString } #Create Query String, escaped for inclusion in request URL $queryString = $boundParameters | ConvertTo-QueryString If ($null -ne $queryString) { #Build URL from base URL $URI = "$URI`?$queryString" } break } } #Send request to web service $result = Invoke-PASRestMethod -Uri $URI -Method GET -TimeoutSec $TimeoutSec If ($null -ne $result) { switch ($PSCmdlet.ParameterSetName) { 'Gen2ID' { #return expected single result $return = $result break } 'Gen1' { $count = $($result.count) switch ($count) { { $count -gt 1 } { #Alert that web service only displays information on first result Write-Warning "$count matching accounts found. Only the first result will be returned" } { $count -gt 0 } { #Get account details from search result $account = ($result | Select-Object accounts).accounts #Get account properties from found account $properties = ($account | Select-Object -ExpandProperty properties) If ($null -ne $account.InternalProperties) { #Get internal properties from found account $InternalProperties = ($account | Select-Object -ExpandProperty InternalProperties) $InternalProps = New-Object -TypeName PSObject #For every account property For ($int = 0; $int -lt $InternalProperties.length; $int++) { $InternalProps | #Add each property name and value as object property of $InternalProps Add-ObjectDetail -PropertyToAdd @{$InternalProperties[$int].key = $InternalProperties[$int].value } -Passthru $false } } #Create output object $return = New-Object -TypeName PSObject -Property @{ #Internal Unique ID of Account 'AccountID' = $($account | Select-Object -ExpandProperty AccountID) #InternalProperties object 'InternalProperties' = $InternalProps } #For every account property For ($int = 0; $int -lt $properties.length; $int++) { #Add each property name and value to results $return | Add-ObjectDetail -PropertyToAdd @{$properties[$int].key = $properties[$int].value } -Passthru $false } } default { break } } break } default { #Get default parameters to pass to Get-NextLink $DefaultParams = $PSBoundParameters | Get-PASParameter -ParametersToKeep SavedFilter, TimeoutSec #return list $return = $Result | Get-NextLink @DefaultParams break } } if ($return) { #Return Results $return | Add-ObjectDetail -typename $typeName } } }#process END { }#end } |