functions/Remove-OrganizationMembership.ps1
|
function Remove-OrganizationMembership { <# .SYNOPSIS Removes a user from an organization .DESCRIPTION Removes a user from an organization .EXAMPLE PS C:\> Remove-ZendeskOrganizationMembership -Id 1 Deletes the organization membership with id 1 .EXAMPLE PS C:\> Remove-ZendeskOrganizationMembership -Id 1 -UserId 2 Deletes the organization membership with id 1 explicitly for user with id 2 .EXAMPLE PS C:\> Remove-ZendeskOrganizationMembership -Id 1, 2, 3 Deletes the organization memberships with ids 1, 2, and 3 #> [OutputType([PSCustomObject])] [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')] Param ( # Unique Id of the organization membership to remove [Parameter(Mandatory = $true)] [ValidateRange(1, [Int64]::MaxValue)] [ValidateNotNullOrEmpty()] [Int64[]] $Id, # Unique Id of the user to remove organization membership for [Parameter(Mandatory = $false)] [ValidateRange(1, [Int64]::MaxValue)] [ValidateNotNullOrEmpty()] [Int64] $UserId, # Zendesk Connection Context from `Get-ZendeskConnection` [Parameter(Mandatory = $false)] [PSTypeName('ZendeskContext')] [PSCustomObject] $Context = $null ) Assert-IsAgent -Context $Context if ($PSBoundParameters.ContainsKey('UserId')) { if ($Id.count -gt 1) { throw 'Bulk delete not supported when associated with a specific user.' } else { $path = "/api/v2/users/$UserId/organization_memberships/$Id.json" } } else { if ($Id.count -gt 1) { $ids = $Id -join ',' $path = "/api/v2/organization_memberships/destroy_many.json?ids=$ids" } else { $path = "/api/v2/organization_memberships/$Id.json" } } if ($PSCmdlet.ShouldProcess("$Id", 'Delete Organization Membership')) { $result = Invoke-Method -Context $Context -Method 'Delete' -Path $path -Verbose:$VerbosePreference $result } } |