Remove JCUser

Remove-JCUser

SYNOPSIS

Removes a JumpCloud User

SYNTAX

Username (Default)

Remove-JCUser [-Username] <String> [-force] [-CascadeManager <String>]
 [<CommonParameters>]

UserID

Remove-JCUser -UserID <String> [-ByID] [-force] [-CascadeManager <String>]
 [<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.

EXAMPLES

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. If the cclemons is a manager of other users, the Force parameter will clear cclemons' subordinates manager field. In other words if a user is managed by cclemons, removing cclemons will also remove that user's manager field in JumpCloud.

Example 3

PS C:\> Remove-JCUser cclemons -CascadeManager null

Removes the Jumpcloud user with Username 'cclemons'. If cclemons manages other JumpCloud users, those user's will have their manager field set to null. Note. This command as the same effect as running Remove-JCUser cclemons -Force

Example 4

PS C:\> Remove-JCUser cclemons -CascadeManager automatic

Removes the JumpCloud user with the username 'cclemons' and automatically update's their subordinates manager field to cclemons manager. Ex. If cclemons is a manager and is also managed by another user with username: some.manager, the users managed by cclemons will be reassigned to some.manager upon cclemons removal. If cclemons is not managed by anyone, the manager field for the cclemons subordinates will be set to null.

Example 5

PS C:\> Remove-JCUser cclemons -CascadeManager User -CascadeManagerUser some.manager

Removes the JumpCloud user with the username cclemons. If cclemons is a manager, their subordinates will be reassigned to the manager specified by the provided username/id with CascadeManagerUser parameter. In this case, cclemons subordinates will be managed by the user with username: some.manager after cclemons is removed.

PARAMETERS

-ByID

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.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: UserID
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CascadeManager

A SwitchParameter for Cascading the manager of the user to the users managed by the user. NULL, AUTOMATIC (bubble up), ID (prompt for manager ID)

Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: NULL, Automatic, User

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-force

A SwitchParameter which suppresses the warning message when removing a JumpCloud User.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserID

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.

Type: System.String
Parameter Sets: UserID
Aliases: _id

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Username

The Username of the JumpCloud user you wish to remove.

Type: System.String
Parameter Sets: Username
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS