Set-JCUserGroupLDAP

NAME Set-JCUserGroupLDAP



SYNOPSIS

The Set-JCUserGroupLDAP command adds or removes a JumpCloud user group and the members to/from the JumpCloud LDAP

directory.





SYNTAX

Set-JCUserGroupLDAP [-GroupID] <System.String> -LDAPEnabled <System.Boolean> [<CommonParameters>]



Set-JCUserGroupLDAP [-GroupName] <System.String> -LDAPEnabled <System.Boolean> [<CommonParameters>]





DESCRIPTION

By default a JumpCloud user group and it's members are not added to the JumpCloud LDAP directory. To add a

JumpCloud user group and its members to JumpCloud LDAP from within the admin console this can be toggled via the

checkmark under the 'directories tab' for each user group. Alternatively this can be done using the

'Set-JCUserGroupLDAP' command and by leveraging this command with the 'Get-JCGroup -type User' command modifying

JumpCloud User Group LDAP membership can be done in bulk.





PARAMETERS

-GroupID <System.String>

The ID of the JumpCloud user group to modify



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-GroupName <System.String>

The name of the JumpCloud user group to modify



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LDAPEnabled <System.Boolean>

A boolean $true/$false value to enable or disable LDAP for a group



Required? true

Position? named

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 --------------------------



Set-JCUserGroupLDAP -GroupName Developers -LDAPEnabled $true



Adds the JumpCloud group 'Developers' ( Group names are case sensitive ) and the members of this group to

JumpCloud LDAP directory.

-------------------------- Example 2 --------------------------



Set-JCUserGroupLDAP -GroupName Developers -LDAPEnabled $False



Removes the JumpCloud group 'Developers' ( Group names are case sensitive ) and the members of this group from the

JumpCloud LDAP directory.

-------------------------- Example 3 --------------------------



Get-JCGroup -Type User | Set-JCUserGroupLDAP -LDAPEnabled $true



This command users the 'Get-JCGroup -Type User' command to pass all JumpCloud user groups to the

'Set-JCUserGroupLDAP' command and enables JumpCloud LDAP for all user groups within a JumpCloud tenant.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... rGroupLDAP