Functions/SafeMembers/Get-PASSafeMember.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
function Get-PASSafeMember {
    <#
.SYNOPSIS
Lists the members of a Safe

.DESCRIPTION
Lists the members of a Safe.
View Safe Members permission is required.

If a Safe Member Name is provided, the full permissions of the member on the Safe will be returned.
Includes AccessWithoutConfirmation, InitiateCPMAccountManagementOperations, RequestsAuthorizationLevel &
SpecifyNextAccountContent which are not included when querying by safe only.

.PARAMETER SafeName
The name of the safe to get the members of

.PARAMETER MemberName
Specify the name of a safe member to return their safe permissions in full.
You cannot report on the permissions of the user authenticated to the API.

.PARAMETER sessionToken
Hashtable containing the session token returned from New-PASSession

.PARAMETER WebSession
WebRequestSession object returned from New-PASSession

.PARAMETER BaseURI
PVWA Web Address
Do not include "/PasswordVault/"

.PARAMETER PVWAAppName
The name of the CyberArk PVWA Virtual Directory.
Defaults to PasswordVault

.PARAMETER ExternalVersion
The External CyberArk Version, returned automatically from the New-PASSession function from version 9.7 onwards.

.EXAMPLE
$token | Get-PASSafeMember -SafeName Target_Safe

Lists all members with permissions on Target_Safe

.EXAMPLE
$token | Get-PASSafeMember -SafeName Target_Safe -MemberName SomeUser

Lists all permissions for member SomeUser on Target_Safe

.INPUTS
All parameters can be piped by property name
Accepts pipeline input from *-PASSafe, or any function which
contains SafeName in the output

.OUTPUTS
Outputs Object of Custom Type psPAS.CyberArk.Vault.Safe.Member
SessionToken, WebSession, BaseURI are passed through and
contained in output object for inclusion in subsequent
pipeline operations.

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

.NOTES

.LINK
#>

    [Alias("Get-PASSafeMembers")]
    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [string]$SafeName,

        [Alias("UserName")]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "MemberPermissions"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$MemberName,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [hashtable]$sessionToken,

        [parameter(
            ValueFromPipelinebyPropertyName = $true
        )]
        [Microsoft.PowerShell.Commands.WebRequestSession]$WebSession,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$BaseURI,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$PVWAAppName = "PasswordVault",

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [System.Version]$ExternalVersion = "0.0"

    )

    BEGIN {

        $Method = "GET"
        $Request = @{ }

    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$baseURI/$PVWAAppName/WebServices/PIMServices.svc/Safes/$($SafeName |

            Get-EscapedString)/Members"


        #Get full permissions for specific user on safe
        if ($PSCmdlet.ParameterSetName -eq "MemberPermissions") {

            #Create URL for member specific request
            $URI = "$URI/$($MemberName | Get-EscapedString)"
            #Send a PUT Request instead of GET
            $Method = "PUT"
            #Send an empty body
            #Add to Request parameters for PUT Request
            $Request["Body"] = @{"member" = @{ } } | ConvertTo-Json

        }

        #Build Request Parameters
        $Request["URI"] = $URI
        $Request["Method"] = $Method
        $Request["Headers"] = $sessionToken
        $Request["WebSession"] = $WebSession

        #Send request to webservice
        $result = Invoke-PASRestMethod @Request

        if ($result) {

            if ($PSCmdlet.ParameterSetName -eq "MemberPermissions") {

                #format output
                $Output = $result.member | Select-Object MembershipExpirationDate,

                @{Name = "UserName"; "Expression" = {

                        $MemberName }

                },

                @{Name = "Permissions"; "Expression" = {

                        $_.Permissions | Where-Object { $_.value } | Select-Object -ExpandProperty key }

                }

            }

            Else {

                #output
                $Output = $result.members | Select-Object UserName, @{Name = "Permissions"; "Expression" = {

                        ($_.Permissions).psobject.properties | Where-Object { $_.Value -eq $true } |

                        Select-Object -ExpandProperty Name }

                }

            }

            $Output | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Safe.Member -PropertyToAdd @{

                "SafeName"        = $SafeName
                "sessionToken"    = $sessionToken
                "WebSession"      = $WebSession
                "BaseURI"         = $BaseURI
                "PVWAAppName"     = $PVWAAppName
                "ExternalVersion" = $ExternalVersion

            }

        }

    }#process

    END { }#end

}