functions/groups/Remove-GroupMember.ps1
|
function Remove-GroupMember { <# .SYNOPSIS Remove membership of a given group .DESCRIPTION Remove membership of a given group .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Remove-TssGroupMember -TssSession $session -Id 8 -UserId 34 Remove User ID 34 from Group ID 8 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/Remove-TssGroupMember .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/Remove-GroupMember.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess)] [OutputType('TssDelete')] param ( # TssSession object created by New-TssSession for auth [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [TssSession] $TssSession, # Group ID [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('GroupId')] [int] $Id, # User ID [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [int] $UserId ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeTssParams $TssSession } process { Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation $restResponse = $null $uri = $TssSession.ApiUrl, 'groups', $Id, 'users', $UserId -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' if (-not $PSCmdlet.ShouldProcess("Group ID: $Id | User ID: $UserId", "$($invokeParams.Method) $uri")) { return } Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $restResponse = . $InvokeApi @invokeParams } catch { Write-Warning "Issue removing User [$UserId] from Group [$Id]" $err = $_ . $ErrorHandling $err } if ($restResponse) { [TssDelete]@{ Id = $restResponse.id ObjectType = $restResponse.objectType } } } else { Write-Warning 'No valid session found' } } } |