Public/New-TempADUserDetails.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
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 {

    }

}