< Back
Set-JCSystemUser
Post
NAME Set-JCSystemUser
SYNOPSIS
Updates the permissions of a JumpCloud user on a JumpCloud system
SYNTAX
Set-JCSystemUser -Administrator <System.Boolean> -SystemID <System.String> -UserID <System.String>
[<CommonParameters>]
Set-JCSystemUser [-Username] <System.String> -Administrator <System.Boolean> -SystemID <System.String>
[<CommonParameters>]
DESCRIPTION
The Set-JCSystemUser function updates the permissions between a JumpCloud user and a JumpCloud system. The command
can be used to add or remove Administrator permissions for a JumpCloud user on a JumpCloud managed system.
PARAMETERS
-Administrator <System.Boolean>
A boolean $true/$false value to add or remove Administrator permissions on a target JumpCloud system
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SystemID <System.String>
The _id of the JumpCloud System which you want to modify the permissions on
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserID <System.String>
The _id of the JumpCloud User whose system permissions will be modified
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 whose system permissions will be modified
Required? true
Position? 0
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
System.Boolean
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Set-JCSystemUser -SystemID 5n0795a712704la4eve154r -Username cclemons -Administrator $True
Sets user with username 'cclemons' as an Administrator on the JumpCloud system with SystemID
'5n0795a712704la4eve154r'
-------------------------- Example 2 --------------------------
PS C:\\> Set-JCSystemUser -SystemID 5n0795a712704la4eve154r -Username cclemons -Administrator $False
Sets user with username 'cclemons' as a standard user on the JumpCloud system with SystemID
'5n0795a712704la4eve154r'
-------------------------- Example 3 --------------------------
PS C:\\> Get-JCSystemUser 5n0795a712704la4eve154r | Set-JCSystemUser -Administrator $False
Gets all users bound to JumpCloud system with SystemID '5n0795a712704la4eve154r' and sets them as standard users.
Note any users who have Global Administrator permissions would keep their Administrator permissions. To find users
with Global Administrator permissions run the command: 'Get-JCUser | Where-Object sudo -EQ $true'
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... SystemUser
SYNOPSIS
Updates the permissions of a JumpCloud user on a JumpCloud system
SYNTAX
Set-JCSystemUser -Administrator <System.Boolean> -SystemID <System.String> -UserID <System.String>
[<CommonParameters>]
Set-JCSystemUser [-Username] <System.String> -Administrator <System.Boolean> -SystemID <System.String>
[<CommonParameters>]
DESCRIPTION
The Set-JCSystemUser function updates the permissions between a JumpCloud user and a JumpCloud system. The command
can be used to add or remove Administrator permissions for a JumpCloud user on a JumpCloud managed system.
PARAMETERS
-Administrator <System.Boolean>
A boolean $true/$false value to add or remove Administrator permissions on a target JumpCloud system
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SystemID <System.String>
The _id of the JumpCloud System which you want to modify the permissions on
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserID <System.String>
The _id of the JumpCloud User whose system permissions will be modified
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 whose system permissions will be modified
Required? true
Position? 0
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
System.Boolean
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Set-JCSystemUser -SystemID 5n0795a712704la4eve154r -Username cclemons -Administrator $True
Sets user with username 'cclemons' as an Administrator on the JumpCloud system with SystemID
'5n0795a712704la4eve154r'
-------------------------- Example 2 --------------------------
PS C:\\> Set-JCSystemUser -SystemID 5n0795a712704la4eve154r -Username cclemons -Administrator $False
Sets user with username 'cclemons' as a standard user on the JumpCloud system with SystemID
'5n0795a712704la4eve154r'
-------------------------- Example 3 --------------------------
PS C:\\> Get-JCSystemUser 5n0795a712704la4eve154r | Set-JCSystemUser -Administrator $False
Gets all users bound to JumpCloud system with SystemID '5n0795a712704la4eve154r' and sets them as standard users.
Note any users who have Global Administrator permissions would keep their Administrator permissions. To find users
with Global Administrator permissions run the command: 'Get-JCUser | Where-Object sudo -EQ $true'
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... SystemUser