Get-JCUserGroupMember

NAME Get-JCUserGroupMember



SYNOPSIS

Returns the User Group members of a JumpCloud User Group.





SYNTAX

Get-JCUserGroupMember -ByID <System.String> [<CommonParameters>]



Get-JCUserGroupMember [-GroupName] <System.String> [<CommonParameters>]





DESCRIPTION

The Get-JCUserGroupMember function returns all the User Group members of a JumpCloud User Group.





PARAMETERS

-ByID <System.String>

If searching for a User Group using the GroupID populate the GroupID in the -ByID field.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-GroupName <System.String>

The name of the JumpCloud User Group you want to return the members of.



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







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-JCUserGroupMember -GroupName 'The Band'



Returns the JumpCloud users that are a member of the group 'The Band'

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



PS C:\\> Get-JCGroup -Type User | Get-JCUserGroupMember



Returns all the JumpCloud User Groups and their members.

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



PS C:\\> Get-JCGroup -Type User | Get-JCUserGroupMember | Where-Object Username -EQ 'cclemons'



Returns all the JumpCloud User Groups that the JumpCloud user with a username of 'cclemons' is a member of.



RELATED LINKS

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