Functions/User/Get-PASUser.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
function Get-PASUser {
    <#
.SYNOPSIS
Returns details of a user

.DESCRIPTION
Returns information on specific vault user.

.PARAMETER id
The numeric id of the user to return details of.
Requires CyberArk version 10.10+

.PARAMETER Search
Search string.
Requires CyberArk version 10.9+

.PARAMETER UserType
The type of the user.
Requires CyberArk version 10.9+

.PARAMETER ComponentUser
Whether the user is a known component or not.
Requires CyberArk version 10.9+

.PARAMETER UserName
The user's name

.EXAMPLE
Get-PASUser

Returns information for all found Users

.EXAMPLE
Get-PASUser -id 123

Returns information on User with id 123

.EXAMPLE
Get-PASUser -search SearchTerm -ComponentUser $False

Returns information for all matching Users

.EXAMPLE
Get-PASUser -UserName Target_User

Displays information on Target_User

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

    [CmdletBinding(DefaultParameterSetName = "10_9")]
    param(

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "10_10"
        )]
        [int]$id,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "10_9"
        )]
        [string]$Search,


        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "10_9"
        )]
        [string]$UserType,


        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "10_9"
        )]
        [boolean]$ComponentUser,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "legacy"
        )]
        [string]$UserName
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.9"
        $RequiredVersion = [System.Version]"10.10"
    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/Users"

        If ($PSCmdlet.ParameterSetName -eq "10_10") {

            Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $RequiredVersion

            $URI = "$URI/$id"

            $TypeName = "psPAS.CyberArk.Vault.User.Extended"

        }
        ElseIf ($PSCmdlet.ParameterSetName -eq "10_9") {

            Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

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

            #Create Query String, escaped for inclusion in request URL
            $queryString = $boundParameters | ConvertTo-QueryString

            if ($queryString) {

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

            }

            $TypeName = "psPAS.CyberArk.Vault.User.Extended"

        }

        ElseIf ($PSCmdlet.ParameterSetName -eq "legacy") {

            #Create URL for request
            $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Users/$($UserName | Get-EscapedString)"

            $TypeName = "psPAS.CyberArk.Vault.User"

        }

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

        #Handle return
        If ($result) {

            #Handle V10 list return
            If ($result.Users) {

                $result = $result.Users

            }

            $result | Add-ObjectDetail -typename $TypeName

        }

    }#process

    END { }#end

}