Functions/Safes/Find-PASSafe.ps1
|
function Find-PASSafe { <# .SYNOPSIS Returns safe list from the vault. .DESCRIPTION Returns abbreviated details for all safes .PARAMETER search List of keywords, separated with a space. .PARAMETER TimeoutSec See Invoke-WebRequest Specify a timeout value in seconds .EXAMPLE Find-PASSafe Returns details of all safes which the user has access to. .EXAMPLE Find-PASSafe -search "xyz abc" Returns details of all matching safes which the user has access to. .INPUTS .OUTPUTS .NOTES This API is largely undocumented, but appears to be available since V10 The documentation mentions no body parameters, but search/offset/limit/sort(NYI)/filter(NYI) seem to work It returns results faster than the v9 API (invoked with Get-PASSafe) but has a vastly different return object Recommended Use: Use this to search for safes many quickly, then use Get-PASSafe to get full details about individual accounts .LINK https://pspas.pspete.dev/commands/Find-PASSafe .LINK https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/Safes%20Web%20Services%20-%20List%20Safes.htm #> [CmdletBinding()] param( [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $false )] [string]$search, [parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false )] [int]$TimeoutSec ) BEGIN { $MinimumVersion = [System.Version]"10.1" #Create base URL for request $URI = "$Script:BaseURI/api/Safes" $SearchQuery = $null $Limit = 25 #default if you call the API with no value }#begin PROCESS { Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion If ( -Not [string]::IsNullOrEmpty($search) ) { $SearchQuery = "&search=$($search | Get-EscapedString)" } $InitialResponse = Invoke-PASRestMethod -Uri "$URI`?limit=$Limit$SearchQuery" -Method GET -WebSession $Script:WebSession -TimeoutSec $TimeoutSec $Total = $InitialResponse.Total If ($Total -gt 0) { $Safes = [Collections.Generic.List[Object]]::New(($InitialResponse.Safes)) For ( $Offset = $Limit ; $Offset -lt $Total ; $Offset += $Limit ) { $Null = $Safes.AddRange((Invoke-PASRestMethod -Uri "$URI`?limit=$Limit&OffSet=$Offset$searchQuery" -Method GET -WebSession $Script:WebSession -TimeoutSec $TimeoutSec).Safes) } $Safes } }#process END { }#end } |