Functions/Accounts/Get-PASAccount.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# .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 = 'Gen2Filter'
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2Query'
        )]
        [string]$search,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2Filter'
        )]
        [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'
        )]
        [datetime]$modificationTime,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2Filter'
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2Query'
        )]
        [string[]]$sort,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2Filter'
        )]
        [string]$filter,

        [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

    )

    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 'Gen2' } ) {

                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"

            }

            'Gen1' {

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

                #Create request URL
                $URI = "$Script: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 -WebSession $Script:WebSession -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 {

                    #return list
                    $return = $Result | Get-NextLink -TimeoutSec $TimeoutSec

                    break

                }

            }

            if ($return) {

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

            }

        }

    }#process

    END { }#end

}