Functions/Accounts/Get-PASAccount.ps1

function Get-PASAccount {
    <#
.SYNOPSIS
Returns details of matching accounts. (Version 10.4 onwards)
Returns information about a single account. (Version 9.3 - 10.3)

.DESCRIPTION
Version 10.4+:
This method returns a list of either a specific, or all the accounts in the Vault.
Requires the following permission in the Safe: List accounts.

Version 9.3 - 10.3:
Returns information about an account. If more than one account meets the search criteria,
only the first account will be returned (the Count output parameter will display the number
of accounts that were found).
Only the following users can access this account:
    - Users who are members of the Safe where the account is stored
    - Users who have access to this specific account.
    - The user who runs this web service requires the following permission in the Safe:
    - Retrieve account
This method does not display the actual password.
If ten or more accounts are found, the Count Output parameter will show 10.

.PARAMETER id
A specific account ID to return details for.

.PARAMETER search
The search term or keywords.

.PARAMETER searchType
Get accounts that either contain or start with the value specified in the Search parameter.

.PARAMETER safeName
The name of the safe to return accounts from.

.PARAMETER modificationTime
Specify to only return details of accounts modified after this date/time
Documented as an option since 11.4

.PARAMETER sort
Property or properties by which to sort returned accounts,
followed by asc (default) or desc to control sort direction.
Separate multiple properties with commas, up to a maximum of three properties.

.PARAMETER offset
An offset for the search results (to discard the first x results for instance).
*depreciated parameter in psPAS - nextLink functionality will fetch all results automatically

.PARAMETER limit
Maximum number of returned accounts. If not specified, the default value is 50.
The maximum number that can be specified is 1000. When used together with the Offset parameter,
this value determines the number of accounts to return, starting from the first account that is returned.
*depreciated parameter in psPAS - nextLink functionality will fetch all results automatically

.PARAMETER filter
A filter for the search.
Requires format: "SafeName eq 'YourSafe'"
*depreciated parameter in psPAS - safeName & modifiedTime will automatically be set as filter values

.PARAMETER Keywords
Keyword to search for.
If multiple keywords are specified, the search will include all the keywords.
Separate keywords with a space.
Relevant for CyberArk versions earlier than 10.4

.PARAMETER Safe
The name of a Safe to search that the authenticated user is authorized to access.
Relevant for CyberArk versions earlier than 10.4

.PARAMETER TimeoutSec
See Invoke-WebRequest
Specify a timeout value in seconds

.EXAMPLE
Get-PASAccount

Returns all accounts on safes where your user has "List accounts" rights.
This will only work from version 10.4 onwards.

.EXAMPLE
Get-PASAccount -search XUser -searchType startswith

Returns all accounts starting with "XUser".

.EXAMPLE
Get-PASAccount -safeName TargetSafe

Returns all accounts from TargetSafe

.EXAMPLE
Get-PASAccount -safeName TargetSafe -modificationTime (Get-Date 03/06/2020) -search some

Returns all accounts from TargetSafe modified after 03/06/2020

.EXAMPLE
Get-PASAccount -filter "SafeName eq TargetSafe"

Specify a filter value to return all accounts found in "TargetSafe"

.EXAMPLE
Get-PASAccount -filter "SafeName eq 'TargetSafe'" -sort "userName desc"

Returns all accounts found in TargetSafe, sort by username in descending order.

.EXAMPLE
Get-PASAccount -Keywords root -Safe UNIX

Finds account(s) matching keywords in UNIX safe:

AccountID : 19_6
Safe : UNIX
Folder : Root
Name : UNIXSSH-machine-root
UserName : root
PlatformID : UNIXSSH
DeviceType : Operating System
Address : machine

.EXAMPLE
Get-PASAccount -Keywords xtest

Finds accounts matching the specified keyword.
Only the first matching account will be returned.
If multiple accounts are found, a warning will be displayed before the result:

WARNING: 3 matching accounts found. Only the first result will be returned

AccountID : 19_9
Safe : TestSafe
Folder : Root
Name : Application-Cyberark-10.10.10.20-xTest3
UserName : xTest3
PlatformID : Cyberark
DeviceType : Application
Address : 10.10.10.20

.EXAMPLE
Get-PASAccount -search root -sort name -offset 100 -limit 5

Returns all accounts matching "root", sorted by AccountName, Search results offset by 100 and limited to 5.
*depreciated parameter in psPAS - nextLink functionality will fetch all results automatically

.INPUTS
All parameters can be piped by property name
Should accept pipeline objects from other *-PASAccount functions

.OUTPUTS
Outputs Object of Custom Type psPAS.CyberArk.Vault.Account
AccountID, Account Safe, Safe Folder, Account Name,
and any other set property of the account are contained in output.

Output format is defined via psPAS.Format.ps1xml.
To force all output to be shown, pipe to Select-Object *
Output format is defined via psPAS.Format.ps1xml.
To force all output to be shown, pipe to Select-Object *

.NOTES
New functionality added in version 10.4, limited functionality before this version.
As of psPAS v2.5.1+, the use of 'limit' and 'offset' parameters is discouraged - nextLink functionality was added

.LINK
https://pspas.pspete.dev/commands/Get-PASAccount

#>


    [CmdletBinding(DefaultParameterSetName = "v10ByQuery")]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByID"
        )]
        [Alias("AccountID")]
        [string]$id,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByFilter"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByQuery"
        )]
        [string]$search,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByFilter"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByQuery"
        )]
        [ValidateSet("startswith", "contains")]
        [string]$searchType,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByQuery"
        )]
        [string]$safeName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByQuery"
        )]
        [datetime]$modificationTime,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByFilter"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByQuery"
        )]
        [string[]]$sort,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByFilter"
        )]
        [int]$offset,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByFilter"
        )]
        [ValidateRange(1, 1000)]
        [int]$limit,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10ByFilter"
        )]
        [string]$filter,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9"
        )]
        [ValidateLength(0, 500)]
        [string]$Keywords,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9"
        )]
        [ValidateLength(0, 28)]
        [string]$Safe,

        [parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $false
        )]
        [int]$TimeoutSec

    )

    BEGIN {

    }#begin

    PROCESS {

        #Get Parameters to include in request
        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove modificationTime, SafeName
        $filterParameters = $PSBoundParameters | Get-PASParameter -ParametersToKeep modificationTime, SafeName
        $FilterString = $filterParameters | ConvertTo-FilterString

        switch ($PSCmdlet.ParameterSetName) {

            ( { $PSItem -match "v10" } ) {

                switch ($PSBoundParameters) {

                    ( { $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 = "$Script:BaseURI/api/Accounts"

            }

            "v9" {

                #assign type name
                $typeName = "psPAS.CyberArk.Vault.Account"

                #Create request URL
                $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Accounts"

            }

            "v10ByID" {

                #define "by ID" URL
                $URI = "$URI/$id"

                break

            }

            ( { $PSItem -ne "v10ByID" } ) {

                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 -WebSession $Script:WebSession -TimeoutSec $TimeoutSec

        If ($null -ne $result) {

            switch ($PSCmdlet.ParameterSetName) {

                "v10ByID" {

                    #return expected single result
                    $return = $result

                    break

                }

                "v10ByQuery" {

                    #to store list of query results
                    $AccountList = [Collections.Generic.List[Object]]@()

                    #add resultst to list
                    $null = $AccountList.Add($result.value)

                    #iterate any nextLinks
                    $NextLink = $result.nextLink
                    While ( $null -ne $NextLink ) {
                        $URI = "$Script:BaseURI/$NextLink"
                        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession -TimeoutSec $TimeoutSec
                        $NextLink = $result.nextLink
                        $null = $AccountList.AddRange(($result.value))
                    }

                    #return list
                    $return = $AccountList

                    break

                }

                "v9" {

                    $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

                }

            }

            if ($return) {

                #Return Results
                $return | Add-ObjectDetail -typename $typeName

            }

        }

    }#process

    END { }#end

}