Public/Set/Set-HaloUser.ps1
|
Function Set-HaloUser { <# .SYNOPSIS Updates a user via the Halo API. .DESCRIPTION Function to send a user update request to the Halo API .OUTPUTS Outputs an object containing the response from the web request. #> [CmdletBinding( SupportsShouldProcess = $True )] [OutputType([Object])] Param ( # Object containing properties and values used to update an existing user. [Parameter( Mandatory = $True, ValueFromPipeline )] [Object]$User ) Invoke-HaloPreFlightCheck try { $ObjectToUpdate = Get-HaloUser -UserID $User.id if ($ObjectToUpdate) { if ($PSCmdlet.ShouldProcess('Users', 'Update')) { New-HaloPOSTRequest -Object $User -Endpoint 'users' -Update } } else { Throw 'User was not found in Halo to update.' } } catch { New-HaloError -ErrorRecord $_ } } |