functions/import-d365aaduser.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 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 |
<# .SYNOPSIS Used to import Aad users into D365FO .DESCRIPTION Provides a method for importing a AAD UserGroup or a comma separated list of AadUsers into D365FO. .PARAMETER AadGroupName Azure Active directory user group containing users to be imported .PARAMETER Users Array of users that you want to import into the D365FO environment .PARAMETER StartupCompany Startup company of users imported. Default is DAT .PARAMETER DatabaseServer The name of the database server If on-premises or classic SQL Server, use either short name og Fully Qualified Domain Name (FQDN) If Azure use the full address to the database server, e.g. server.database.windows.net .PARAMETER DatabaseName The name of the database .PARAMETER SqlUser The login name for the SQL Server instance .PARAMETER SqlPwd The password for the SQL Server user .PARAMETER IdPrefix A text that will be prefixed into the ID field. E.g. -IdPrefix "EXT-" will import users and set ID starting with "EXT-..." .PARAMETER NameSuffix A text that will be suffixed into the NAME field. E.g. -NameSuffix "(Contoso)" will import users and append "(Contoso)"" to the NAME .PARAMETER IdValue Specify which field to use as ID value when importing the users. Available options 'Login' / 'FirstName' Default is 'Login' .PARAMETER NameValue Specify which field to use as NAME value when importing the users. Available options 'FirstName' / 'DisplayName' Default is 'DisplayName' .PARAMETER AzureAdCredential Use a PSCredential object for connecting with AzureAd .PARAMETER SkipAzureAd Switch to instruct the cmdlet to skip validating against the Azure Active Directory .PARAMETER ForceExactAadGroupName Force to find the exact name of the Azure Active Directory Group .PARAMETER AadGroupId Azure Active directory user group ID containing users to be imported .EXAMPLE PS C:\> Import-D365AadUser -Users "Claire@contoso.com","Allen@contoso.com" Imports Claire and Allen as users .EXAMPLE PS C:\> $myPassword = ConvertTo-SecureString "MyPasswordIsSecret" -AsPlainText -Force PS C:\> $myCredentials = New-Object System.Management.Automation.PSCredential ("MyEmailIsAlso", $myPassword) PS C:\> Import-D365AadUser -Users "Claire@contoso.com","Allen@contoso.com" -AzureAdCredential $myCredentials This will import Claire and Allen as users. .EXAMPLE PS C:\> Import-D365AadUser -AadGroupName "CustomerTeam1" if more than one group match the AadGroupName, you can use the ExactAadGroupName parameter Import-D365AadUser -AadGroupName "CustomerTeam1" -ForceExactAadGroupName .EXAMPLE PS C:\> Import-D365AadUser -AadGroupName "CustomerTeam1" -ForceExactAadGroupName This is used to force the cmdlet to find the exact named group in Azure Active Directory. .EXAMPLE PS C:\> Import-D365AadUser -AadGroupId "99999999-aaaa-bbbb-cccc-9999999999" Imports all the users that is present in the AAD Group called CustomerTeam1 .EXAMPLE PS C:\> Import-D365AadUser -Users "Claire@contoso.com","Allen@contoso.com" -SkipAzureAd Imports Claire and Allen as users. Will NOT make you connect to the Azure Active Directory(AAD). The needed details will be based on the e-mail address only, and the rest will be blanked. .NOTES Tags: User, Users, Security, Configuration, Permission, AAD, Azure Active Directory, Group, Groups Author: Rasmus Andersen (@ITRasmus) Author: Charles Colombel (@dropshind) Author: Mötz Jensen (@Splaxi) Author: Miklós Molnár (@scifimiki) At no circumstances can this cmdlet be used to import users into a PROD environment. Only users from an Azure Active Directory that you have access to, can be imported. Use AAD B2B implementation if you want to support external people. Every imported users will get the System Administration / Administrator role assigned on import #> function Import-D365AadUser { [CmdletBinding(DefaultParameterSetName = 'UserListImport')] param ( [Parameter(Mandatory = $true, Position = 1, ParameterSetName = "GroupNameImport")] [String] $AadGroupName, [Parameter(Mandatory = $true, Position = 1, ParameterSetName = "UserListImport")] [string[]]$Users, [Parameter(Mandatory = $false, Position = 2)] [string] $StartupCompany = 'DAT', [Parameter(Mandatory = $false, Position = 3)] [string] $DatabaseServer = $Script:DatabaseServer, [Parameter(Mandatory = $false, Position = 4)] [string] $DatabaseName = $Script:DatabaseName, [Parameter(Mandatory = $false, Position = 5)] [string] $SqlUser = $Script:DatabaseUserName, [Parameter(Mandatory = $false, Position = 6)] [string] $SqlPwd = $Script:DatabaseUserPassword, [Parameter(Mandatory = $false, Position = 7)] [string] $IdPrefix = "", [Parameter(Mandatory = $false, Position = 8)] [string] $NameSuffix = "", [Parameter(Mandatory = $false, Position = 9)] [ValidateSet('Login', 'FirstName')] [string] $IdValue = "Login", [Parameter(Mandatory = $false, Position = 10)] [ValidateSet('FirstName', 'DisplayName')] [string] $NameValue = "DisplayName", [Parameter(Mandatory = $false, Position = 11)] [PSCredential] $AzureAdCredential, [Parameter(Mandatory = $false, Position = 12, ParameterSetName = "UserListImport")] [switch] $SkipAzureAd, [Parameter(Mandatory = $false, Position = 13, ParameterSetName = "GroupNameImport")] [switch] $ForceExactAadGroupName, [Parameter(Mandatory = $true, Position = 14, ParameterSetName = "GroupIdImport")] [string] $AadGroupId ) $UseTrustedConnection = Test-TrustedConnection $PSBoundParameters $SqlParams = @{ DatabaseServer = $DatabaseServer; DatabaseName = $DatabaseName; SqlUser = $SqlUser; SqlPwd = $SqlPwd } $SqlCommand = Get-SqlCommand @SqlParams -TrustedConnection $UseTrustedConnection $instanceProvider = Get-InstanceIdentityProvider $canonicalProvider = Get-CanonicalIdentityProvider try { Write-PSFMessage -Level Verbose -Message "Trying to connect to the Azure Active Directory" if ($PSBoundParameters.ContainsKey("AzureAdCredential") -eq $true) { $null = Connect-AzureAD -ErrorAction Stop -Credential $AzureAdCredential } else { if ($SkipAzureAd -eq $false) { $null = Connect-AzureAD -ErrorAction Stop } } } catch { Write-PSFMessage -Level Host -Message "Something went wrong while connecting to Azure Active Directory" -Exception $PSItem.Exception Stop-PSFFunction -Message "Stopping because of errors" return } $azureAdUsers = New-Object -TypeName "System.Collections.ArrayList" if (( $PSCmdlet.ParameterSetName -eq "GroupNameImport") -or ($PSCmdlet.ParameterSetName -eq "GroupIdImport")) { if ($PSCmdlet.ParameterSetName -eq 'GroupIdImport') { Write-PSFMessage -Level Verbose -Message "Search AadGroup by its ID : $AadGroupId" $group = Get-AzureADGroup -ObjectId $AadGroupId } else { if ($ForceExactAadGroupName) { Write-PSFMessage -Level Verbose -Message "Search AadGroup by its exactly name : $AadGroupName" $group = Get-AzureADGroup -Filter "DisplayName eq '$AadGroupName'" } else { Write-PSFMessage -Level Verbose -Message "Search AadGroup by searching with its name : $AadGroupName" $group = Get-AzureADGroup -SearchString $AadGroupName } } if ($null -eq $group) { Write-PSFMessage -Level Host -Message "Unable to find the specified group in the AAD. Please ensure the group exists and that you have enough permissions to access it." Stop-PSFFunction -Message "Stopping because of errors" return } else { Write-PSFMessage -Level Host -Message "Processing Azure AD user Group `"$($group[0].DisplayName)`"" } if ($group.Length -gt 1) { Write-PSFMessage -Level Host -Message "More than one group found" foreach ($foundGroup in $group) { Write-PSFMessage -Level Host -Message "Group found $($foundGroup.DisplayName)" } Stop-PSFFunction -Message "Stopping because of errors" return } $userlist = Get-AzureADGroupMember -ObjectId $group[0].ObjectId foreach ($user in $userlist) { if ($user.ObjectType -eq "User") { $azureAdUser = Get-AzureADUser -ObjectId $user.ObjectId if ($null -eq $azureAdUser.Mail) { Write-PSFMessage -Level Critical "User $($user.ObjectId) did not have an Mail" } else { $null = $azureAdUsers.Add((Get-AzureADUser -ObjectId $user.ObjectId)) } } } } else { foreach ($user in $Users) { if ($SkipAzureAd -eq $true) { $name = Get-LoginFromEmail $user $null = $azureAdUsers.Add([PSCustomObject]@{ Mail = $user GivenName = $name DisplayName = $name ObjectId = '' }) } else { $aadUser = Get-AzureADUser -SearchString $user if ($null -eq $aadUser) { Write-PSFMessage -Level Critical "Could not find user $user in AzureAAd" } else { $null = $azureAdUsers.Add($aadUser) } } } } try { $sqlCommand.Connection.Open() foreach ($user in $azureAdUsers) { $identityProvider = $canonicalProvider Write-PSFMessage -Level Verbose -Message "Getting tenant from $($user.Mail)." $tenant = Get-TenantFromEmail $user.Mail Write-PSFMessage -Level Verbose -Message "Getting domain from $($user.Mail)." $networkDomain = Get-NetworkDomain $user.Mail Write-PSFMessage -Level Verbose -Message "InstanceProvider : $InstanceProvider" Write-PSFMessage -Level Verbose -Message "Tenant : $Tenant" if ($user.Mail.ToLower().Contains("outlook.com") -eq $true) { $identityProvider = "live.com" } else { if ($instanceProvider.ToLower().Contains($tenant.ToLower()) -ne $True) { Write-PSFMessage -Level Verbose -Message "Getting identity provider from $($user.Mail)." $identityProvider = Get-IdentityProvider $user.Mail } } Write-PSFMessage -Level Verbose -Message "Getting sid from $($user.Mail) and identity provider : $identityProvider." $sid = Get-UserSIDFromAad $user.Mail $identityProvider Write-PSFMessage -Level Verbose -Message "Generated SID : $sid" $id = "" if ($IdValue -eq 'Login') { $id = $IdPrefix + $(Get-LoginFromEmail $user.Mail) } else { $id = $IdPrefix + $user.GivenName } if ($id.Length -gt 20) { $oldId = $id $id = $id -replace '^(.{0,20}).*','$1' Write-PSFMessage -Level Host -Message "The id <c='em'>'$oldId'</c> does not fit the <c='em'>20 character limit</c> on UserInfo table's ID field and will be truncated to <c='em'>'$id'</c>" } Write-PSFMessage -Level Verbose -Message "Id for user $($user.Mail) : $id" $name = "" if ($NameValue -eq 'DisplayName') { $name = $user.DisplayName + $NameSuffix } else { $name = $user.GivenName + $NameSuffix } Write-PSFMessage -Level Verbose -Message "Name for user $($user.Mail) : $name" Write-PSFMessage -Level Verbose -Message "Importing $($user.Mail) - SID $sid - Provider $identityProvider" Import-AadUserIntoD365FO $SqlCommand $user.Mail $name $id $sid $StartupCompany $identityProvider $networkDomain $user.ObjectId if (Test-PSFFunctionInterrupt) { return } } } catch { Write-PSFMessage -Level Host -Message "Something went wrong while working against the database" -Exception $PSItem.Exception Stop-PSFFunction -Message "Stopping because of errors" return } finally { if ($sqlCommand.Connection.State -ne [System.Data.ConnectionState]::Closed) { $sqlCommand.Connection.Close() } $sqlCommand.Dispose() } } |