< Back
Remove-JCUserGroupMember
Post
NAME Remove-JCUserGroupMember
SYNOPSIS
Removes a JumpCloud User from a JumpCloud User Group
SYNTAX
Remove-JCUserGroupMember [[-GroupName] <System.String>] [-ByID] [-GroupID <System.String>] -UserID <System.String>
[<CommonParameters>]
Remove-JCUserGroupMember [-GroupName] <System.String> [-Username] <System.String> [<CommonParameters>]
DESCRIPTION
The Remove-JCUserGroupMember function is used to remove a JumpCloud User from a JumpCloud User Group. The user can
be removed by Username or by UserID.
PARAMETERS
-ByID <System.Management.Automation.SwitchParameter>
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-GroupID <System.String>
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'
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GroupName <System.String>
The name of the JumpCloud User Group that you want to remove the User from.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserID <System.String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Username <System.String>
The Username of the JumpCloud user you wish to remove from the User Group.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Remove-JCUserGroupMember -Username cclemons -GroupName 'The Band'
Removes the JumpCloud user with Username 'cclemons' from the User Group 'The Band'
-------------------------- Example 2 --------------------------
PS C:\\> Get-JCUser | Where-Object sudo -EQ $false | Remove-JCUserGroupMember -GroupName 'Administrators'
Removes all JumpCloud users where the 'sudo' attribute is equal to $false from the User Group 'Administrators'
-------------------------- Example 3 --------------------------
PS C:\\> Get-JCUser | Where-Object created -lt (Get-Date).AddDays(-7) | Remove-JCUserGroupMember -GroupName 'New
Hires'
Removes all JumpCloud users not created within the last 7 days from the User Group 'New Hires'
-------------------------- Example 4 --------------------------
Get-JCUser | Select-Object username, @{name='Attribute Value'; expression={$_.attributes.value}} | Where-Object
'Attribute Value' -Like *Marketing* | Remove-JCUserGroupMember -GroupName Sales
Removes all JumpCloud users with a custom attribute value which contains 'Marketing' from the JumpCloud User Group
'Sales'. Note that to access the value of a nested property you must use Select-Object to access the nested
property. In this example a calculated property is also used.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... roupMember
SYNOPSIS
Removes a JumpCloud User from a JumpCloud User Group
SYNTAX
Remove-JCUserGroupMember [[-GroupName] <System.String>] [-ByID] [-GroupID <System.String>] -UserID <System.String>
[<CommonParameters>]
Remove-JCUserGroupMember [-GroupName] <System.String> [-Username] <System.String> [<CommonParameters>]
DESCRIPTION
The Remove-JCUserGroupMember function is used to remove a JumpCloud User from a JumpCloud User Group. The user can
be removed by Username or by UserID.
PARAMETERS
-ByID <System.Management.Automation.SwitchParameter>
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-GroupID <System.String>
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'
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GroupName <System.String>
The name of the JumpCloud User Group that you want to remove the User from.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserID <System.String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Username <System.String>
The Username of the JumpCloud user you wish to remove from the User Group.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Remove-JCUserGroupMember -Username cclemons -GroupName 'The Band'
Removes the JumpCloud user with Username 'cclemons' from the User Group 'The Band'
-------------------------- Example 2 --------------------------
PS C:\\> Get-JCUser | Where-Object sudo -EQ $false | Remove-JCUserGroupMember -GroupName 'Administrators'
Removes all JumpCloud users where the 'sudo' attribute is equal to $false from the User Group 'Administrators'
-------------------------- Example 3 --------------------------
PS C:\\> Get-JCUser | Where-Object created -lt (Get-Date).AddDays(-7) | Remove-JCUserGroupMember -GroupName 'New
Hires'
Removes all JumpCloud users not created within the last 7 days from the User Group 'New Hires'
-------------------------- Example 4 --------------------------
Get-JCUser | Select-Object username, @{name='Attribute Value'; expression={$_.attributes.value}} | Where-Object
'Attribute Value' -Like *Marketing* | Remove-JCUserGroupMember -GroupName Sales
Removes all JumpCloud users with a custom attribute value which contains 'Marketing' from the JumpCloud User Group
'Sales'. Note that to access the value of a nested property you must use Select-Object to access the nested
property. In this example a calculated property is also used.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... roupMember