Functions/Safes/Set-PASSafe.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
# .ExternalHelp psPAS-help.xml
function Set-PASSafe {
    [CmdletBinding(SupportsShouldProcess,
        DefaultParameterSetName = 'Gen2-NumberOfDaysRetention')]
    param(
        [Parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { $_ -notmatch ".*(\\|\/|:|\*|<|>|`"|\.|\||^\s).*" })]
        [ValidateLength(0, 28)]
        [string]$SafeName,

        [Parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { $_ -notmatch ".*(\\|\/|:|\*|<|>|`"|\.|\||^\s).*" })]
        [ValidateLength(0, 28)]
        [string]$NewSafeName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [ValidateLength(0, 100)]
        [string]$Description,

        [Parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2-NumberOfDaysRetention'
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2-NumberOfVersionsRetention'
        )]
        [string]$location,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [boolean]$OLACEnabled,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [string]$ManagingCPM,

        [Parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2-NumberOfVersionsRetention'
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = 'Gen1-NumberOfVersionsRetention'
        )]
        [ValidateRange(1, 999)]
        [int]$NumberOfVersionsRetention,

        [Parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2-NumberOfDaysRetention'
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = 'Gen1-NumberOfDaysRetention'
        )]
        [ValidateRange(1, 3650)]
        [int]$NumberOfDaysRetention,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen1-NumberOfVersionsRetention'
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen1-NumberOfDaysRetention'
        )]
        [switch]$UseGen1API

    )

    BEGIN { }#begin

    PROCESS {

        $typename = 'psPAS.CyberArk.Vault.Safe'

        $BoundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove SafeName, NewSafeName

        if ($PSBoundParameters.ContainsKey('NewSafeName')) {

            $BoundParameters['SafeName'] = $PSBoundParameters['NewSafeName']

        }

        switch ($PSCmdlet.ParameterSetName) {

            ( { $PSItem -match '^Gen2-' } ) {

                Assert-VersionRequirement -RequiredVersion 12.2

                $typename = "$typename.Gen2"

                #Create URL for Request
                $URI = "$Script:BaseURI/api/Safes/$($SafeName | Get-EscapedString)"

                #Create Request Body
                $body = $BoundParameters | ConvertTo-Json

                break

            }

            ( { $PSItem -match '^Gen1-' } ) {

                Assert-VersionRequirement -MaximumVersion 12.3

                #Create URL for Request
                $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Safes/$($SafeName | Get-EscapedString)"

                #Create Request Body
                $body = @{

                    'safe' = $BoundParameters

                } | ConvertTo-Json

                break

            }

        }

        if ($PSCmdlet.ShouldProcess($SafeName, 'Update Safe Properties')) {

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

            If ($null -ne $result) {

                switch ($PSCmdlet.ParameterSetName) {

                    ( { $PSItem -match '^Gen1-' } ) {

                        $return = $result.UpdateSafeResult

                        break

                    }

                    default {

                        $return = $result

                        break

                    }

                }

                $return | Add-ObjectDetail -typename $typename

            }

        }

    }#process

    END { }#end

}