Public/Groups/UserGroups/Remove-JCUserGroupMember.ps1
|
Function Remove-JCUserGroupMember () { [CmdletBinding(DefaultParameterSetName = 'ByName')] param ( [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'ByName', Position = 0, HelpMessage = 'The name of the JumpCloud User Group that you want to remove the User from.')] [Parameter(ValueFromPipelineByPropertyName, ParameterSetName = 'ByID', Position = 0, HelpMessage = 'The name of the JumpCloud User Group that you want to remove the User from.')] [Alias('name')] [String]$GroupName, [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'ByName', Position = 1, HelpMessage = 'The Username of the JumpCloud user you wish to remove from the User Group.')] [String]$Username, [Parameter(ParameterSetName = 'ByID', HelpMessage = 'Use the -ByID parameter when either the UserID or GroupID is passed over the pipeline to the Add-JCUserGroupMember function. The -ByID SwitchParameter will set the ParameterSet to ''ByID'' which will increase the function speed and performance.')] [Switch]$ByID, [Parameter(ValueFromPipelineByPropertyName, ParameterSetName = 'ByID', HelpMessage = 'The GroupID is used in the ParameterSet ''ByID''. The GroupID for a User Group can be found by running the command: PS C:\> Get-JCGroup -type ''User''')] [string]$GroupID, [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'ByID', HelpMessage = 'The _id of the User which you want to remove from the User Group. To find a JumpCloud UserID run the command: PS C:\> Get-JCUser | Select username, _id The UserID will be the 24 character string populated for the _id field. UserID has an Alias of _id. This means you can leverage the PowerShell pipeline to populate this field automatically using the Get-JCUser function before calling Remove-JCUserGroupMember. This is shown in EXAMPLES 2, 3, and 4.')] [Alias('_id', 'id')] [string]$UserID ) begin { Write-Debug 'Verifying JCAPI Key' if ($JCAPIKEY.length -ne 40) {Connect-JConline} Write-Debug 'Populating API headers' $hdrs = @{ 'Content-Type' = 'application/json' 'Accept' = 'application/json' 'X-API-KEY' = $JCAPIKEY } if ($JCOrgID) { $hdrs.Add('x-org-id', "$($JCOrgID)") } Write-Debug 'Initilizing resultsArray' $resultsArray = @() if ($PSCmdlet.ParameterSetName -eq 'ByName') { Write-Debug 'Populating GroupNameHash' $GroupNameHash = Get-Hash_UserGroupName_ID Write-Debug 'Populating UserNameHash' $UserNameHash = Get-Hash_UserName_ID } } process { if ($PSCmdlet.ParameterSetName -eq 'ByName') { if ($GroupNameHash.containsKey($GroupName)) {} else { Throw "Group does not exist. Run 'Get-JCGroup -type User' to see a list of all your JumpCloud user groups."} Write-Debug 'Populating UserNameHash' if ($UserNameHash.containsKey($Username)) {} else { Throw "Username does not exist. Run 'Get-JCUser | select username' to see a list of all your JumpCloud users."} $GroupID = $GroupNameHash.Get_Item($GroupName) $UserID = $UserNameHash.Get_Item($Username) $body = @{ type = "user" op = "remove" id = $UserID } $jsonbody = $body | ConvertTo-Json Write-Debug $jsonbody $GroupsURL = "$JCUrlBasePath/api/v2/usergroups/$GroupID/members" Write-Debug $GroupsURL try { $GroupAdd = Invoke-RestMethod -Method POST -Body $jsonbody -Uri $GroupsURL -Headers $hdrs -UserAgent:(Get-JCUserAgent) $Status = 'Removed' } catch { $Status = $_.ErrorDetails } $FormattedResults = [PSCustomObject]@{ 'GroupName' = $GroupName 'Username' = $Username 'UserID' = $UserID 'Status' = $Status } $resultsArray += $FormattedResults } elseif ($PSCmdlet.ParameterSetName -eq 'ByID') { if (!$GroupID) { Write-Debug 'Populating GroupNameHash' $GroupNameHash = Get-Hash_UserGroupName_ID $GroupID = $GroupNameHash.Get_Item($GroupName) } $body = @{ type = "user" op = "remove" id = $UserID } $jsonbody = $body | ConvertTo-Json Write-Debug $jsonbody $GroupsURL = "$JCUrlBasePath/api/v2/usergroups/$GroupID/members" Write-Debug $GroupsURL try { $GroupRemove = $GroupAdd = Invoke-RestMethod -Method POST -Body $jsonbody -Uri $GroupsURL -Headers $hdrs -UserAgent:(Get-JCUserAgent) $Status = 'Removed' } catch { $Status = $_.ErrorDetails } $FormattedResults = [PSCustomObject]@{ 'GroupID' = $GroupID 'UserID' = $UserID 'Status' = $Status } $resultsArray += $FormattedResults } } end { return $resultsArray } } |