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
# .ExternalHelp psPAS-help.xml
function Get-PASUser {
    [CmdletBinding(DefaultParameterSetName = "Gen2")]
    param(

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

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

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


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

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

    BEGIN { }#begin

    PROCESS {

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

        switch ($PSCmdlet.ParameterSetName) {

            "Gen2ID" {

                Assert-VersionRequirement -RequiredVersion 10.10
                #Create URL for request
                $URI = "$URI/$id"

                break;

            }

            "Gen2" {

                Assert-VersionRequirement -RequiredVersion 10.9
                #Get Parameters to include in request
                $boundParameters = $PSBoundParameters | Get-PASParameter

                #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;

            }

            "Gen1" {

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

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

                break;

            }

        }

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

        #Handle return
        if ($PSCmdlet.ParameterSetName -match "Gen2") {

            #All "V10" operations have the same output type
            $TypeName = "psPAS.CyberArk.Vault.User.Extended"

            #User search will return an object with a Total property
            If ($result.Total -ge 1) {

                #Return only users property if Total indicates results
                $result = $result.Users

            } ElseIf ($result.Total -eq 0) {

                #Total indicates no results, return null
                $result = $null

            }

        }

        If ($null -ne $result) {

            $result | Add-ObjectDetail -typename $TypeName

        }

    }#process

    END { }#end

}