Functions/Applications/Get-PASApplication.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
function Get-PASApplication {
    <#
.SYNOPSIS
Returns details of applications in the Vault

.DESCRIPTION
Returns information on Applications from the Vault.
Results can be filtered by specifying additional parameters.
Applications can be found by name, or searched for.
Audit Users permission is required.

.PARAMETER AppID
Application Name

.PARAMETER ExactMatch
By Default, the function will search the vault.
All found applications (based on parameters supplied) will be returned.
When Specifying this parameter, the function will not search;
data for the supplied AppID will be returned.

.PARAMETER Location
Location of the application in the Vault hierarchy.
Default=\

.PARAMETER IncludeSubLocations
Will search be carried out in sublocations of specified location?
Boolean

.EXAMPLE
Get-PASApplication

Returns information on all defined applications

.EXAMPLE
Get-PASApplication NewApp -ExactMatch

Gets details of the application "NewApp":

AppID Description Location Disabled
----- ----------- -------- --------
NewApp A new application \ False

.EXAMPLE
Get-PASApplication NewApp

Gets details of all application matching "NewApp":

AppID Description Location Disabled
----- ----------- -------- --------
NewApp A new application \ False
NewApp1 A new application \ False
NewApp7 A new application \ False

.INPUTS
All parameters can be piped by property name, except ExactMatch
Should accept pipeline objects from other *-PASApplication* functions

.OUTPUTS
Outputs Object of Custom Type psPAS.CyberArk.Vault.Application
Output format is defined via psPAS.Format.ps1xml.
To force all output to be shown, pipe to Select-Object *

.LINK
https://pspas.pspete.dev/commands/Get-PASApplication
#>

    [CmdletBinding(DefaultParameterSetName = 'byQuery')]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "byAppID"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "byQuery"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$AppID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = "byAppID"
        )]
        [switch]$ExactMatch,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "byQuery"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$Location,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "byQuery"
        )]
        [boolean]$IncludeSublocations
    )

    BEGIN { }#begin

    PROCESS {

        #Base URL for Request
        $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Applications"

        #If AppID specified
        If ($($PSCmdlet.ParameterSetName) -eq "byAppID") {

            #Build URL from base URL
            $URI = "$URI/$($AppID | Get-EscapedString)"

        }

        #If search query specified
        ElseIf ($($PSCmdlet.ParameterSetName) -eq "byQuery") {

            #Get Parameters to include in request
            $boundParameters = $PSBoundParameters | Get-PASParameter

            #Create query string
            $queryString = $boundParameters | ConvertTo-QueryString

            if ($null -ne $queryString) {

                #Build URL from base URL
                $URI = "$URI`?$queryString"

            }

        }

        #Send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        If ($null -ne $result) {

            #Return results
            $result.application | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Application

        }

    }#process

    END { }#end

}