PSRandomUser.psm1

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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
function New-RandomUser {
    <#
        .SYNOPSIS
            The function New-RandomUser creates a random user using the API provided by the creators of RANDOM USER GENERATOR - https://randomuser.me
 
        .DESCRIPTION
            The function New-RandomUser creates a random user using the API provided by the creators of RANDOM USER GENERATOR - https://randomuser.me a free and easy to use service to generate random user data for application testing.
 
            You can request a different nationality of a randomuser. Pictures won't be affected by this, but data such as location, home phone, id, etc. will be more appropriate.
 
        .EXAMPLE
            New-RandomUser
            Creates a single random user
 
        .EXAMPLE
            New-RandomUser -Nationality GB -PassLength 14 -Quantity 10 -Email "leigh-services.com"
            Creates 10 random users from United Kingdom, with a password length of 14 characters and with an email address @leigh-services.com
 
        .INPUTS
            [string] Nationality
            [int] PassLength
            [int] Quantity
            [string] Email
         
        .OUTPUTS
            [PSObject]
                 
        .NOTES
            Author: Luke Leigh
            Website: https://blog.lukeleigh.com/
            LinkedIn: https://www.linkedin.com/in/lukeleigh/
            GitHub: https://github.com/BanterBoy/
            GitHubGist: https://gist.github.com/BanterBoy
 
        .LINK
            https://github.com/BanterBoy
    #>


    [CmdletBinding(
        DefaultParameterSetName = "Default")]
    Param
    (
        # Please select the user nationality. The default setting will choose a Random nationality.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please select the user nationality. The default setting will choose a Random nationality.")]
        [ValidateSet('AU', 'BR', 'CA', 'CH', 'DE', 'DK', 'ES', 'FI', 'FR', 'GB', 'IE', 'IR', 'NO', 'NL', 'NZ', 'TR', 'US', 'Random') ]
        [string]
        $Nationality = "Random",
        # Please enter or select password length. The default length is 10 characters.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please enter or select password length. The default length is 10 characters.")]
        [ValidateSet('8', '10', '12', '14', '16', '18', '20') ]
        [int]
        $PassLength = "10",
        # Please select number of results. The default is 1. Min-Max = 1-5000
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please select number of results. The default is 1. Min-Max = 1-5000")]
        [ValidateRange(1, 5000)]
        [int]
        $Quantity = "1",
        # Specify the user's e-mail address. This parameter sets the EmailAddress property of a user object. The default value is $env:USERDNSDOMAIN.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Specify the user's e-mail address. This parameter sets the EmailAddress property of a user object.")]
        [string]
        $Email = "$env:USERDNSDOMAIN"
    )

    BEGIN {
        [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    }

    PROCESS {

        $Uri = "https://randomuser.me/api/?nat=$Nationality&password=upper,lower,special,number,$PassLength&format=PrettyJSON&results=$Quantity"
        $Results = Invoke-RestMethod -Method GET -Uri $Uri -UseBasicParsing
        $mail = ($Email).ToLower()
        
        try {
            foreach ( $item in $Results.results ) {
                $RandomUser = [ordered]@{
                    "Name"              = $item.name.first + " " + $item.name.last
                    "Title"             = $item.name.title
                    "GivenName"         = $item.name.first
                    "Surname"           = $item.name.last
                    "DisplayName"       = $item.name.title + " " + $item.name.first + " " + $item.name.last
                    "HouseNumber"       = $item.location.street.number
                    "StreetAddress"     = $item.location.street.name
                    "City"              = $item.location.city
                    "State"             = $item.location.state
                    "Country"           = $item.location.country
                    "PostalCode"        = $item.location.postcode
                    "UserPrincipalName" = $item.name.first + "." + $item.name.last + "@" + $mail
                    "PersonalEmail"     = $item.email
                    "SamAccountName"    = $item.name.first + $item.name.last
                    "HomePhone"         = $item.phone
                    "MobilePhone"       = $item.cell
                    "Gender"            = $item.gender
                    "Nationality"       = $item.nat
                    "Age"               = $item.dob.age
                    "DateOfBirth"       = $item.dob.date
                    "NINumber"          = $item.id.value
                    "TimeZone"          = $item.location.timezone.description
                    "TimeOffset"        = $item.location.timezone.offset
                    "Latitude"          = $item.location.coordinates.latitude
                    "Longitude"         = $item.location.coordinates.longitude
                    "Username"          = $item.login.username
                    "UUID"              = $item.login.uuid
                    "AccountPassword"   = $item.login.password
                    "Salt"              = $item.login.salt
                    "MD5"               = $item.login.md5
                    "Sha1"              = $item.login.sha1
                    "Sha256"            = $item.login.sha256
                    "LargePicture"      = $item.picture.large
                    "MediumPicture"     = $item.picture.medium
                    "ThumbnailPicture"  = $item.picture.thumbnail
                }
                $obj = New-Object -TypeName PSObject -Property $RandomUser
                Write-Output $obj
            }
        }
        catch {
            Write-Verbose -Message "$_"
        }

    }

    END {

    }

}
function New-TempADUser {

    <#
        .SYNOPSIS
        This function creates a new temporary AD user using the data parsed from New-TempADUserDetails.
 
        .DESCRIPTION
        Function to
        https://randomuser.me/
 
        .EXAMPLE
        New-TempADUserDetails | New-TempADUser
 
        .INPUTS
            [PSObject]
         
        .OUTPUTS
                 
        .NOTES
        Author: Luke Leigh
        Website: https://blog.lukeleigh.com/
        LinkedIn: https://www.linkedin.com/in/lukeleigh/
        GitHub: https://github.com/BanterBoy/
        GitHubGist: https://gist.github.com/BanterBoy
 
        .LINK
        https://github.com/BanterBoy
    #>

            
    [CmdletBinding(
        SupportsShouldProcess = $true,
        DefaultParameterSetName = "Default")]
    param (
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $Name,
            
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $Title,
    
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $GivenName,

        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $Surname,
        
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $DisplayName,

        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $SamAccountName,

        
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $StreetAddress,
        
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $State,
            
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $City,
            
        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $Country,

        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $PostalCode,

        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $UserPrincipalName,

        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please enter the DistinguishedName for the OU path for your Email address."
        )]
        [string]
        $Path = (Get-ADDomain).UsersContainer,

        # Parameter help description
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = "Please enter your"
        )]
        [string]
        $AccountPassword
            
    )
            
    begin {
                
    }
    
    process {
        if ($path) {
            $userUserSettings = @{
                Name                  = $_.Name
                Title                 = $_.Title
                GivenName             = $_.GivenName
                Surname               = $_.Surname
                DisplayName           = $_.DisplayName
                SamAccountName        = $_.SamAccountName
                UserPrincipalName     = $_.UserPrincipalName
                StreetAddress         = $_.StreetAddress
                State                 = $_.State
                City                  = $_.City
                Country               = $_.Country
                PostalCode            = $_.PostalCode
                AccountPassword       = (ConvertTo-SecureString -String $AccountPassword -AsPlainText -Force)
                Enabled               = $true
                ChangePasswordAtLogon = $true
                Path                  = $Path
            }
            
            New-ADUser @userUserSettings -Verbose
        }
        else {
            $userUserSettings = @{
                Name                  = $_.Name
                Title                 = $_.Title
                GivenName             = $_.GivenName
                Surname               = $_.Surname
                DisplayName           = $_.DisplayName
                SamAccountName        = $_.SamAccountName
                UserPrincipalName     = $_.UserPrincipalName
                StreetAddress         = $_.StreetAddress
                State                 = $_.State
                City                  = $_.City
                Country               = $_.Country
                PostalCode            = $_.PostalCode
                AccountPassword       = (ConvertTo-SecureString -String $AccountPassword -AsPlainText -Force)
                Enabled               = $true
                ChangePasswordAtLogon = $true
            }
            
            New-ADUser @userUserSettings -Verbose
        }
    }
        
    end {
        
    }
}
function New-TempADUserDetails {
    
    <#
        .SYNOPSIS
            The function New-TempADUserDetails creates user account details for use in creating Temporary Active Directory users, by accessing the API provided by the creators of RANDOM USER GENERATOR - https://randomuser.me.
 
        .DESCRIPTION
            The function New-TempADUserDetails creates user account details for use in creating Temporary Active Directory users. It does this by accessing the API provided by the creators of RANDOM USER GENERATOR - https://randomuser.me a free and easy to use service to generate random user data for application testing.
 
            You can specify the nationality of a user and data such as location, home phone, id, etc. will be more appropriate.
 
            This Function was created to produce random user details tailored for Active Directory Users. This function can be piped into New-TempADUser to create a random user into Active Directory.
 
        .EXAMPLE
            New-TempADUserDetails
            Creates a single set of random user details for use in creating a Temporary Active Directory user.
 
        .EXAMPLE
            New-TempADUserDetails -Path (Get-ADDomain).UsersContainer
            Creates a single set of random user details for use in creating a Temporary Active Directory user and adds it to the specified Users Container in Active Directory.
 
        .EXAMPLE
            New-TempADUserDetails -Nationality GB -PassLength 14 -Quantity 10 -Email "leigh-services.com"
            Creates 10 Active Directory users from United Kingdom, with a password length of 14 characters and with an email address @leigh-services.com. The users will be added to the Users Container of the current Active Directory Domain.
 
        .INPUTS
            [string] Nationality
            [int] PassLength
            [int] Quantity
            [string] Email
         
        .OUTPUTS
            [PSObject]
         
        .NOTES
            Author: Luke Leigh
            Website: https://blog.lukeleigh.com/
            LinkedIn: https://www.linkedin.com/in/lukeleigh/
            GitHub: https://github.com/BanterBoy/
            GitHubGist: https://gist.github.com/BanterBoy
 
        .LINK
            https://github.com/BanterBoy
    #>


    [CmdletBinding(
        DefaultParameterSetName = "Default")]
    Param
    (
        # Please select the user nationality. The default setting will choose a Random nationality.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please select the user nationality. The default setting will choose a Random nationality.")]
        [ValidateSet('AU', 'BR', 'CA', 'CH', 'DE', 'DK', 'ES', 'FI', 'FR', 'GB', 'IE', 'IR', 'NO', 'NL', 'NZ', 'TR', 'US', 'Random') ]
        [string]
        $Nationality = "Random",
        # Please enter or select password length. The default length is 10 characters.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please enter or select password length. The default length is 10 characters.")]
        [ValidateSet('8', '10', '12', '14', '16', '18', '20') ]
        [int]
        $PassLength = "10",
        # Please select number of results. The default is 1. Min-Max = 1-5000
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Please select number of results. The default is 1. Min-Max = 1-5000")]
        [ValidateRange(1, 5000)]
        [int]
        $Quantity = "1",
        # Specify the user's e-mail address. This parameter sets the EmailAddress property of a user object. The default value is $env:USERDNSDOMAIN.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Specify the user's e-mail address. This parameter sets the EmailAddress property of a user object.")]
        [string]
        $Email = "$env:USERDNSDOMAIN",
        # Enter the X.500 path of the Organizational Unit (OU) or container where the new object is created.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Default",
            ValueFromPipeline = $True,
            ValueFromPipelineByPropertyName = $True,
            HelpMessage = "Enter the X.500 path of the Organizational Unit (OU) or container where the new object is created.")]
        [string]
        $Path
    )

    BEGIN {
        [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    }

    PROCESS {

        $Uri = "https://randomuser.me/api/?nat=$Nationality&password=upper,lower,special,number,$PassLength&format=json&results=$Quantity"
        $Results = Invoke-RestMethod -Method GET -Uri $Uri -UseBasicParsing
        $mail = ($Email).ToLower()
        
        try {
            foreach ( $item in $Results.results ) {
                if ($Path) {
                    $NewFakeUser = [ordered]@{
                        "Name"              = $item.name.first + " " + $item.name.last
                        "Title"             = $item.name.title
                        "GivenName"         = $item.name.first
                        "Surname"           = $item.name.last
                        "DisplayName"       = $item.name.title + " " + $item.name.first + " " + $item.name.last
                        "HouseNumber"       = $item.location.street.number
                        "StreetAddress"     = $item.location.street.name
                        "City"              = $item.location.city
                        "State"             = $item.location.state
                        "Country"           = $item.nat
                        "PostalCode"        = $item.location.postcode
                        "UserPrincipalName" = $item.name.first + "." + $item.name.last + "@" + $mail
                        "SamAccountName"    = $item.name.first + $item.name.last
                        "AccountPassword"   = $item.login.password
                        "Path"              = $Path
                    }
                    $obj = New-Object -TypeName PSObject -Property $NewFakeUser
                    Write-Output $obj
                }
                else {
                    $NewFakeUser = [ordered]@{
                        "Name"              = $item.name.first + " " + $item.name.last
                        "Title"             = $item.name.title
                        "GivenName"         = $item.name.first
                        "Surname"           = $item.name.last
                        "DisplayName"       = $item.name.title + " " + $item.name.first + " " + $item.name.last
                        "HouseNumber"       = $item.location.street.number
                        "StreetAddress"     = $item.location.street.name
                        "City"              = $item.location.city
                        "State"             = $item.location.state
                        "Country"           = $item.nat
                        "PostalCode"        = $item.location.postcode
                        "UserPrincipalName" = ($item.name.first + "." + $item.name.last).ToLower() + "@" + $mail
                        "SamAccountName"    = $item.name.first + $item.name.last
                        "AccountPassword"   = $item.login.password
                    }
                    $obj = New-Object -TypeName PSObject -Property $NewFakeUser
                    Write-Output $obj
                }
            }
        }
        catch {
            Write-Verbose -Message "$_"
        }

    }

    END {

    }

}