functions/users/Remove-TssUserGroup.ps1
|
function Remove-TssUserGroup { <# .SYNOPSIS Remove a user from groups .DESCRIPTION Removes a user from one or more groups. .PARAMETER TssSession TssSession object created by New-TssSession for authentication .PARAMETER Id User ID .PARAMETER GroupId IDs of the groups to remove the user from .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Remove-TssUserGroup -TssSession $session -Id 42 -GroupId 8, 9 Removes user 42 from groups 8 and 9 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/users/Remove-TssUserGroup .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/users/Remove-TssUserGroup.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess)] [OutputType('Thycotic.PowerShell.Users.ActionResult')] param ( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('UserId')] [int[]] $Id, [Parameter(Mandatory)] [int[]] $GroupId ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { Get-TssInvocation $PSCmdlet.MyInvocation if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { Compare-TssVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($currentId in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'users', $currentId, 'groups' -join '/' $queryParams = @() switch ($tssParams.Keys) { 'GroupId' { foreach ($queryValue in $GroupId) { $queryParams += "groupIds=$($queryValue)" } } } if ($queryParams) { $uri = $uri, ($queryParams -join '&') -join '?' } $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' if ($PSCmdlet.ShouldProcess("User: $currentId", "$($invokeParams.Method) $uri")) { Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning 'Issue with Remove-TssUserGroup request' $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.Users.ActionResult](. $FilterTssResponse $restResponse ([Thycotic.PowerShell.Users.ActionResult])) } } } } else { Write-Warning 'No valid session found' } } } |