< Back
Remove-JCUser
Post
NAME Remove-JCUser
SYNOPSIS
Removes a JumpCloud User
SYNTAX
Remove-JCUser [-ByID] -UserID <System.String> [-force] [<CommonParameters>]
Remove-JCUser [-Username] <System.String> [-force] [<CommonParameters>]
DESCRIPTION
The Remove-JCUser function will remove a JumpCloud user from the JumpCloud organization. This will remove the
deleted users access to any JumpCloud bound resources.
PARAMETERS
-ByID <System.Management.Automation.SwitchParameter>
Use the -ByID parameter when the UserID is passed over the pipeline to the Remove-JCUser 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
-UserID <System.String>
The _id of the User which you want to delete.
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.
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-force <System.Management.Automation.SwitchParameter>
A SwitchParameter which suppresses the warning message when removing a JumpCloud User.
Required? false
Position? named
Default value False
Accept pipeline input? False
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-JCUser cclemons
Removes the JumpCloud User with Username 'cclemons'. A warning message will be presented to confirm this operation.
-------------------------- Example 2 --------------------------
PS C:\\> Remove-JCUser cclemons -Force
Removes the JumpCloud User with Username 'cclemons' using the -Force Parameter. A warning message will not be
presented to confirm this operation.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... ove-JCUser
SYNOPSIS
Removes a JumpCloud User
SYNTAX
Remove-JCUser [-ByID] -UserID <System.String> [-force] [<CommonParameters>]
Remove-JCUser [-Username] <System.String> [-force] [<CommonParameters>]
DESCRIPTION
The Remove-JCUser function will remove a JumpCloud user from the JumpCloud organization. This will remove the
deleted users access to any JumpCloud bound resources.
PARAMETERS
-ByID <System.Management.Automation.SwitchParameter>
Use the -ByID parameter when the UserID is passed over the pipeline to the Remove-JCUser 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
-UserID <System.String>
The _id of the User which you want to delete.
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.
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-force <System.Management.Automation.SwitchParameter>
A SwitchParameter which suppresses the warning message when removing a JumpCloud User.
Required? false
Position? named
Default value False
Accept pipeline input? False
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-JCUser cclemons
Removes the JumpCloud User with Username 'cclemons'. A warning message will be presented to confirm this operation.
-------------------------- Example 2 --------------------------
PS C:\\> Remove-JCUser cclemons -Force
Removes the JumpCloud User with Username 'cclemons' using the -Force Parameter. A warning message will not be
presented to confirm this operation.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... ove-JCUser