Functions/Accounts/Add-PASPendingAccount.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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
function Add-PASPendingAccount {
    <#
.SYNOPSIS
Adds discovered account or SSH key as a pending account in the accounts feed.
 
.DESCRIPTION
Enables an account or SSH key that is discovered by an external scanner to be added
as a pending account to the Accounts Feed.
Users can identify privileged accounts and determine which are on-boarded to the vault.
 
.PARAMETER UserName
The name of the account user
 
.PARAMETER Address
The name or address of the machine where the account is used.
 
.PARAMETER AccountDiscoveryDate
The date when the account was discovered.
 
.PARAMETER OSType
The OS where the password was discovered.
Windows or Unix
 
.PARAMETER AccountEnabled
The account status in the discovery source.
 
.PARAMETER AccountOSGroups
The name of the group that the account belongs to
 
.PARAMETER AccountType
Account Type
 
.PARAMETER DiscoveryPlatformType
Platform where discovered account is used
 
.PARAMETER Domain
The domain of the account.
 
.PARAMETER LastLogonDate
Date, according to discovery source, when the account was last used to logon.
 
.PARAMETER LastPasswordSet
Date, according to discovery source, when the password for the account was last set
 
.PARAMETER PasswordNeverExpires
If the password will ever expire in the discovery source
 
.PARAMETER OSVersion
OS Version where the account was discovered
 
.PARAMETER OU
OU of the account
 
.PARAMETER AccountCategory
Whether the discovered account is privileged or non-privileged.
 
.PARAMETER AccountCategoryCriteria
Criteria that determines whether or not the discovered account is privileged.
For example, the user or groupname, etc.
Separate multiple strings with ";".
 
.PARAMETER UserDisplayName
User's display name
 
.PARAMETER AccountDescription
A description of the user, as defined in the discovery source.
This will be saved as an account after it is added to the pending accounts.
 
.PARAMETER AccountExpirationDate
The account expiration date defined in the discovery source.
 
.PARAMETER UID
The unique User ID
 
.PARAMETER GID
The Unique Group ID
 
.PARAMETER MachineOSFamily
The type of machine where the account was discovered.
 
.EXAMPLE
Add-PASPendingAccount -UserName Administrator -Address ServerA.domain.com -AccountDiscoveryDate 2017-01-01T00:00:00Z `
-AccountEnabled enabled
 
Adds matching discovered account as pending account.
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
None
#>

    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingUserNameAndPassWordParams', '', Justification = "Username not used for authentication")]
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword', 'LastPasswordSet', Justification = "Parameter does not hold password")]
    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [string]$UserName,

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

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("Windows", "Unix")]
        [string]$OSType,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("enabled", "disabled")]
        [string]$AccountEnabled,

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("domain", "local")]
        [string]$AccountType,

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

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

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

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

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

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

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("Privileged", "Non-privileged")]
        [string]$AccountCategory,

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

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

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

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

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("Workstation", "Server")]
        [string]$MachineOSFamily
    )

    BEGIN {}#begin

    PROCESS {

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

        #Get all parameters that will be sent in the request
        $boundParameters = $PSBoundParameters | Get-PASParameter

        If($PSBoundParameters.ContainsKey("AccountDiscoveryDate")) {

            #Convert ExpiryDate to string in Required format
            $Date = (Get-Date $AccountDiscoveryDate.ToUniversalTime() -Format "yyyy-MM-ddTHH:mm:ssZ").ToString()

            #Include date string in request
            $boundParameters["AccountDiscoveryDate"] = $Date

        }

        #Create body of request
        $body = @{

            #pendingaccount node
            "pendingAccount" = $boundParameters | Get-PASParameter

            #JSON object
        } | ConvertTo-Json

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

    }#process

    END {}#end
}