Functions/Applications/Add-PASApplicationAuthenticationMethod.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
function Add-PASApplicationAuthenticationMethod {
    <#
.SYNOPSIS
Adds an authentication method to an application.

.DESCRIPTION
Adds a new authentication method to a specific application iin the vault.
The "Manage Users" permission is required to be held by the user running the function.

.PARAMETER AppID
The name of the application for which a new authentication method is being added.

.PARAMETER path
The path to configure as an authentication method

.PARAMETER hash
A file hash to configure as an authentication method

.PARAMETER osUser
An osUser to configure as an authentication method

.PARAMETER machineAddress
Address value to configure as an authentication method

.PARAMETER certificateserialnumber
Certificate Serial Number to configure as an authentication method

.PARAMETER Subject
The content of the subject attribute.

.PARAMETER Issuer
The content of the issuer attribute

.PARAMETER SubjectAlternativeName
The content of the subject alternative name attribute
Accepts attributes "DNS Name", "IP Address", "URI", "RFC822"

.PARAMETER IsFolder
Boolean value denoting if path is a folder.

.PARAMETER AllowInternalScripts
Boolean value denoting if internal scripts are allowed.

.PARAMETER Comment
Note Property

.EXAMPLE
Add-PASApplicationAuthenticationMethod -AppID NewApp -machineAddress "AppServer1.domain.com"

Adds a Machine Address application authentication mechanism to NewApp

.EXAMPLE
Add-PASApplicationAuthenticationMethod -AppID NewApp -osUser "Domain\SomeUser"

Adds an osUSer application authentication mechanism to NewApp

.EXAMPLE
Add-PASApplicationAuthenticationMethod -AppID NewApp -path "SomePath"

Adds path application authentication mechanism to NewApp

.EXAMPLE
Add-PASApplicationAuthenticationMethod -AppID NewApp -certificateserialnumber 040000000000FA3DEFE9A9 -Comment "DEV Cert"

Adds certificateserialnumber application authentication mechanism to NewApp

.EXAMPLE
Add-PASApplicationAuthenticationMethod -AppID AppWebService -Subject "CN=application.company.com"

Adds Certificate Attribute authentication

.EXAMPLE
Add-PASApplicationAuthenticationMethod -AppID AppWebService -SubjectAlternativeName "DNS Name=application.service"

Adds Certificate Attribute authentication for certificate SAN attribute

.LINK
https://pspas.pspete.dev/commands/Add-PASApplicationAuthenticationMethod
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "path"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateattr"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateserialnumber"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "hash"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "osUser"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "machineAddress"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$AppID,

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

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

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

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

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateattr"
        )]
        [string[]]$Subject,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateattr"
        )]
        [string[]]$Issuer,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateattr"
        )]
        [string[]]$SubjectAlternativeName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "path"
        )]
        [boolean]$IsFolder,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "path"
        )]
        [boolean]$AllowInternalScripts,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateattr"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "certificateserialnumber"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "hash"
        )]
        [string]$Comment
    )

    BEGIN { }#begin

    PROCESS {

        $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Applications/$($AppID | Get-EscapedString)/Authentications"

        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove AppID

        #Accepted authtype names match parameterset names
        $boundParameters.Add("AuthType", $($PSCmdlet.ParameterSetName))

        #When parameterset name matches parametername
        If ($boundParameters.ContainsKey($PSCmdlet.ParameterSetName)) {

            #Rename hashtable key to "AuthValue"
            $boundParameters.Add("AuthValue", $boundParameters.$($PSCmdlet.ParameterSetName))
            $boundParameters.Remove($($PSCmdlet.ParameterSetName))

        }

        $Body = @{

            "authentication" = $boundParameters

        } | ConvertTo-Json

        Invoke-PASRestMethod -Uri $URI -Method POST -Body $Body -WebSession $Script:WebSession

    }#process

    END { }#end

}