Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@kmaranionjc
kmaranionjc committed Dec 17, 2024
1 parent c823b41 commit 67501fa
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 8 deletions.
26 changes: 21 additions & 5 deletions PowerShell/JumpCloud Module/Docs/Remove-JCUser.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ Removes a JumpCloud User

### Username (Default)
```
Remove-JCUser [-Username] <String> [-force] [<CommonParameters>]
Remove-JCUser [-Username] <String> [-force] [-CascadeManager <String>]
[<CommonParameters>]
```

### UserID
```
Remove-JCUser -UserID <String> [-ByID] [-force] [<CommonParameters>]
Remove-JCUser -UserID <String> [-ByID] [-force] [-CascadeManager <String>]
[<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -42,15 +44,13 @@ 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
```powershell
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
```powershell
PS C:\> Remove-JCUser cclemons -CascadeManager automatic
Expand Down Expand Up @@ -83,6 +83,22 @@ 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)
```yaml
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.
Expand Down Expand Up @@ -148,4 +164,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
### System.Object
## NOTES
## RELATED LINKS
## RELATED LINKS
2 changes: 1 addition & 1 deletion PowerShell/JumpCloud Module/JumpCloud.psd1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: JumpCloud Solutions Architect Team
#
# Generated on: 12/16/2024
# Generated on: 12/17/2024
#

@{
Expand Down
69 changes: 68 additions & 1 deletion PowerShell/JumpCloud Module/en-Us/JumpCloud-help.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17231,6 +17231,23 @@ PS C:\&gt; New-JCPolicy -TemplateName darwin_Login_Window_Text -Values $policyV
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>CascadeManager</maml:name>
<maml:description>
<maml:para>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)</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" command:variableLength="false">NULL</command:parameterValue>
<command:parameterValue required="false" command:variableLength="false">Automatic</command:parameterValue>
<command:parameterValue required="false" command:variableLength="false">User</command:parameterValue>
</command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
<dev:type>
<maml:name>System.String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>force</maml:name>
<maml:description>
Expand Down Expand Up @@ -17274,6 +17291,23 @@ PS C:\&gt; New-JCPolicy -TemplateName darwin_Login_Window_Text -Values $policyV
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>CascadeManager</maml:name>
<maml:description>
<maml:para>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)</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" command:variableLength="false">NULL</command:parameterValue>
<command:parameterValue required="false" command:variableLength="false">Automatic</command:parameterValue>
<command:parameterValue required="false" command:variableLength="false">User</command:parameterValue>
</command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
<dev:type>
<maml:name>System.String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>force</maml:name>
<maml:description>
Expand Down Expand Up @@ -17301,6 +17335,18 @@ PS C:\&gt; New-JCPolicy -TemplateName darwin_Login_Window_Text -Values $policyV
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>CascadeManager</maml:name>
<maml:description>
<maml:para>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)</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
<dev:type>
<maml:name>System.String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>force</maml:name>
<maml:description>
Expand Down Expand Up @@ -17380,7 +17426,28 @@ PS C:\&gt; New-JCPolicy -TemplateName darwin_Login_Window_Text -Values $policyV
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
<dev:code>PS C:\&gt; Remove-JCUser cclemons -Force</dev:code>
<dev:remarks>
<maml:para>Removes the JumpCloud User with Username 'cclemons' using the -Force Parameter. A warning message will not be presented to confirm this operation.</maml:para>
<maml:para>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.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 3 --------------------------</maml:title>
<dev:code>PS C:\&gt; Remove-JCUser cclemons -CascadeManager null</dev:code>
<dev:remarks>
<maml:para>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`</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 4 --------------------------</maml:title>
<dev:code>PS C:\&gt; Remove-JCUser cclemons -CascadeManager automatic</dev:code>
<dev:remarks>
<maml:para>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.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 5 --------------------------</maml:title>
<dev:code>PS C:\&gt; Remove-JCUser cclemons -CascadeManager User -CascadeManagerUser some.manager</dev:code>
<dev:remarks>
<maml:para>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.</maml:para>
</dev:remarks>
</command:example>
</command:examples>
Expand Down
2 changes: 1 addition & 1 deletion PowerShell/ModuleChangelog.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 2.16.0

Release Date: December 16, 2024
Release Date: December 17, 2024

#### RELEASE NOTES

Expand Down

0 comments on commit 67501fa

Please sign in to comment.