Functions/Public/identity/Set-vRAUserPrincipal.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 |
function Set-vRAUserPrincipal { <# .SYNOPSIS Update a vRA local user principal .DESCRIPTION Update a vRA Principal (user) .PARAMETER Id The principal id of the user .PARAMETER Tenant The tenant of the user .PARAMETER FirstName First Name .PARAMETER LastName Last Name .PARAMETER EmailAddress Email Address .PARAMETER Description Users text description .PARAMETER Password Users password .PARAMETER DisableAccount Disable the user principal .PARAMETER EnableAccount Enable or unlock the user principal .INPUTS System.String System.SecureString System.Diagnostics.Switch .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Set-vRAUserPrincipal -Id user@vsphere.local -FirstName FirstName-Updated -LastName LastName-Updated -EmailAddress userupdated@vsphere.local -Description Description-Updated .EXAMPLE Set-vRAUserPrincipal -Id user@vsphere.local -EnableAccount .EXAMPLE Set-vRAUserPrincipal -Id user@vsphere.local -DisableAccount .EXAMPLE $SecurePassword = ConvertTo-SecureString “P@ssword” -AsPlainText -Force Set-vRAUserPrincipal -Id user@vsphere.local -Password SecurePassword #> [CmdletBinding(SupportsShouldProcess,ConfirmImpact="Low")][OutputType('System.Management.Automation.PSObject')] Param ( [Alias("PrincipalId")] [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Tenant = $Global:vRAConnection.Tenant, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$FirstName, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$LastName, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$EmailAddress, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Description, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [SecureString]$Password, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Alias("LockAccount")] [Switch]$DisableAccount, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Alias("UnlockAccount")] [Switch]$EnableAccount ) Begin { # --- Test for vRA API version xRequires -Version 7.0 # --- Fix for bug found in 7.1 and 7.2 where the PUT will fail if the password attribute is sent back NULL # --- If the API version is 7.1 or 7.2 and the Password parameter is not passed Remove unsupported parameters from $PSBoundParameters # --- This will ensure that they are not evaluated below if (($Global:vRAConnection.APIVersion -eq "7.1") -or ($Global:vRAConnection.APIVersion -eq "7.2") -and (!$PSBoundParameters.ContainsKey("Password"))) { Write-Verbose -Message "API Version $($Global:vRAConnection.APIVersion) detected and Password parameter not passed. Removing unsupported parameters." $PSBoundParameters.Remove("FirstName") | Out-Null $PSBoundParameters.Remove("LastName") | Out-Null $PSBoundParameters.Remove("EmailAddress") | Out-Null $PSBoundParameters.Remove("Description") | Out-Null $PSBoundParameters.Remove("DisableAccount") | Out-Null $PSBoundParameters.Remove("EnableAccount") | Out-Null } } Process { try { foreach ($PrincipalId in $Id) { $URI = "/identity/api/tenants/$($Tenant)/principals/$($PrincipalId)" $PrincipalObject = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference # --- Should update will be set to true if a property is updated # --- This will stop PUT operations where password is null $ShouldUpdate = $false if ($PSBoundParameters.ContainsKey("FirstName")) { Write-Verbose -Message "Updating FirstName: $($PrincipalObject.FirstName) >> $($FirstName)" $PrincipalObject.FirstName = $FirstName $ShouldUpdate = $true } if ($PSBoundParameters.ContainsKey("LastName")) { Write-Verbose -Message "Updating LastName: $($PrincipalObject.LastName) >> $($LastName)" $PrincipalObject.LastName = $LastName $ShouldUpdate = $true } if ($PSBoundParameters.ContainsKey("EmailAddress")) { Write-Verbose -Message "Updating EmailAddress: $($PrincipalObject.EmailAddress) >> $($EmailAddress)" $PrincipalObject.EmailAddress = $EmailAddress $ShouldUpdate = $true } if ($PSBoundParameters.ContainsKey("Description")) { Write-Verbose -Message "Updating Description: $($PrincipalObject.Description) >> $($Description)" $PrincipalObject.Description = $Description $ShouldUpdate = $true } if ($PSBoundParameters.ContainsKey("Password")) { $InsecurePassword = (New-Object System.Management.Automation.PSCredential("username", $Password)).GetNetworkCredential().Password Write-Verbose -Message "Updating Password" $PrincipalObject.Password = $InsecurePassword $ShouldUpdate = $true } if ($PSBoundParameters.ContainsKey("DisableAccount")) { Write-Verbose -Message "Disabling Account" $PrincipalObject.Disabled = $true $ShouldUpdate = $true } if ($PSBoundParameters.ContainsKey("EnableAccount")) { Write-Verbose -Message "Enabling Account" $PrincipalObject.Disabled = $false $PrincipalObject.Locked = $false $ShouldUpdate = $true } $Body = $PrincipalObject | ConvertTo-Json -Compress if ($ShouldUpdate){ Write-Verbose -Message "ShouldUpdate is true. Proceeding with Update." if ($PSCmdlet.ShouldProcess($PrincipalId)){ # --- Run vRA REST Request Invoke-vRARestMethod -Method PUT -URI $URI -Body $Body -Verbose:$VerbosePreference | Out-Null Get-vRAUserPrincipal -Tenant $Tenant -Id $PrincipalId -Verbose:$VerbosePrefernce } } } } catch [Exception]{ throw } } End { } } |