public/Remove-TNOrganizationUser.ps1
|
function Remove-TNOrganizationUser { <# .SYNOPSIS Removes a list of organization users .DESCRIPTION Removes a list of organization users .PARAMETER SessionObject Optional parameter to force using specific SessionObjects. By default, each command will connect to all connected servers that have been connected to using Connect-TNServer .PARAMETER Organization The name of the target organization .PARAMETER Name The name of the target organization user .PARAMETER InputObject Description for InputObject .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with 'sea of red' exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this 'nice by default' feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE PS C:\> Remove-TNOrganizationUser Removes a list of organization users #> [CmdletBinding()] param ( [Parameter(ValueFromPipelineByPropertyName)] [object[]]$SessionObject = (Get-TNSession), [string[]]$Organization, [Alias("Username")] [string]$Name, [parameter(ValueFromPipeline)] [object[]]$InputObject, [switch]$EnableException ) process { foreach ($session in $SessionObject) { $PSDefaultParameterValues["*:SessionObject"] = $session if (-not $session.sc) { Stop-PSFFunction -EnableException:$EnableException -Message "Only tenable.sc supported" -Continue } if (-not $InputObject) { $InputObject = Get-TNOrganizationUser -Organization $Organization -Name $Name if (-not $InputObject) { Stop-PSFFunction -Message "User $Name does not in exist at $($session.URI)" -Continue } } foreach ($user in $InputObject) { $params = @{ SessionObject = $session EnableException = $EnableException Method = "DELETE" Path = "/organization/$($user.OrganizationId)/securityManager/$($user.Id)" } Invoke-TNRequest @params | ConvertFrom-TNRestResponse } } } } |