Functions/Requests/New-PASRequest.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
function New-PASRequest {
    <#
.SYNOPSIS
Creates an access request for a specific account

.DESCRIPTION
Creates an access request for a specific account.
This account may be either a password account or an SSH Key account.
Officially supported from version 9.10. Reports received that function works in 9.9 also.

.PARAMETER accountId
The ID of the account to access

.PARAMETER reason
The reason why the account will be accessed

.PARAMETER TicketingSystemName
The name of the Ticketing system specified in the request

.PARAMETER TicketId
The Ticket ID given by the ticketing system.

.PARAMETER ConnectionComponent
If the connection is through PSM, the name of the connection component to connect with,
as defined in the configuration.

.PARAMETER MultipleAccessRequired
Whether the request is for multiple accesses

.PARAMETER FromDate
If the request is for a timeframe, the time from when the user wants to access the account.

.PARAMETER ToDate
If the request is for a timeframe, the time until the user wants to access the account.

.PARAMETER AdditionalInfo
Additional information included in the request

.PARAMETER UseConnect
Whether or not the request is for connection through the PSM.

.PARAMETER ConnectionComponent
If the connection is through PSM, the name of the connection component to connect with, as defined in the configuration

.PARAMETER AllowMappingLocalDrives
Whether or not to redirect their local hard drives to the remote server.

.PARAMETER AllowConnectToConsole
Whether or not to connect to the administrative console of the remote machine.

.PARAMETER RedirectSmartCards
Whether or not to redirect Smart Card so that the certificate stored on the card can be accessed on the target

.PARAMETER PSMRemoteMachine
Address of the remote machine to connect to.

.PARAMETER LogonDomain
The NetBIOS domain name of the account being used.

.PARAMETER AllowSelectHTML5
Specify which connection method, HTML5-based or RDP-file, to use when connecting to the remote server

.PARAMETER ConnectionParams
A list of parameters required to perform the connection, as defined in each connection component configuration

.EXAMPLE
New-PASRequest -AccountId $ID -Reason "Task ABC" -MultipleAccessRequired $true -ConnectionComponent PSM-RDP

Creates a new request for access to account with ID in $ID

.NOTES
Minimum CyberArk Version 9.10

.LINK
https://pspas.pspete.dev/commands/New-PASRequest
#>

    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "ConnectionParams")]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [string]$AccountId,

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

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

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

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [datetime]$FromDate,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [datetime]$ToDate,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [hashtable]$AdditionalInfo,

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

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ConnectionParams"
        )]
        [ValidateSet("Yes", "No")]
        [string]$AllowMappingLocalDrives,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ConnectionParams"
        )]
        [ValidateSet("Yes", "No")]
        [string]$AllowConnectToConsole,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ConnectionParams"
        )]
        [ValidateSet("Yes", "No")]
        [string]$RedirectSmartCards,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ConnectionParams"
        )]
        [string]$PSMRemoteMachine,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ConnectionParams"
        )]
        [string]$LogonDomain,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ConnectionParams"
        )]
        [ValidateSet("Yes", "No")]
        [string]$AllowSelectHTML5,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "ManualParams"
        )]
        [hashtable]$ConnectionParams
    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 9.10
    }#begin

    PROCESS {

        #Create URL for Request
        $URI = "$Script:BaseURI/API/MyRequests"

        $boundParameters = $PSBoundParameters | Get-PASParameter

        if ($boundParameters.ContainsKey("FromDate")) {

            #convert to unix time
            $boundParameters["FromDate"] = $FromDate | ConvertTo-UnixTime

        }

        if ($boundParameters.ContainsKey("ToDate")) {

            #convert to unix time
            $boundParameters["ToDate"] = $ToDate | ConvertTo-UnixTime

        }

        #Nest parameters "AllowMappingLocalDrives", "AllowConnectToConsole","RedirectSmartCards",
        #"PSMRemoteMachine", "LogonDomain" & "AllowSelectHTML5" under ConnectionParams Property
        $boundParameters = $boundParameters | ConvertTo-ConnectionParam

        #Create body of request
        $body = $boundParameters | ConvertTo-Json

        if ($PSCmdlet.ShouldProcess($AccountId, "Create Request for Account Access")) {

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

            If ($null -ne $result) {

                $result | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Request

            }

        }

    }#process

    END { }#end

}