psPAS

5.5.110

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

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

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

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

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

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

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen1-NumberOfDaysRetention'
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'NumberOfDaysRetention'
        )]
        [ValidateRange(0, 3650)]
        [int]$NumberOfDaysRetention,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'NumberOfVersionsRetention'
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'NumberOfDaysRetention'
        )]
        [boolean]$AutoPurgeEnabled,

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

    BEGIN {
        $typename = 'psPAS.CyberArk.Vault.Safe'
    }#begin

    PROCESS {

        switch ($PSCmdlet.ParameterSetName) {

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

                #Create URL for request
                $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Safes"

                #create request body
                $body = @{

                    #add parameters to safe node
                    'safe' = $PSBoundParameters | Get-PASParameter

                } | ConvertTo-Json

                break

            }

            default {

                Assert-VersionRequirement -RequiredVersion 12.0

                #Create URL for request
                $URI = "$Script:BaseURI/API/Safes"

                $typename = "$typename.Gen2"

                $body = $PSBoundParameters | Get-PASParameter | ConvertTo-Json

                break

            }

        }

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

        If ($null -ne $result) {

            switch ($PSCmdlet.ParameterSetName) {

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

                    $return = $result.AddSafeResult

                    break

                }

                default {

                    $return = $result

                    break

                }

            }

            $return | Add-ObjectDetail -typename $typename
        }

    }#process

    END { }#end

}