< Back
Get-JiraGroupMember
Post
NAME Get-JiraGroupMember
SYNOPSIS
Returns members of a given group in JIRA
SYNTAX
Get-JiraGroupMember [-Group] <Object[]> [[-StartIndex] <UInt32>] [[-MaxResults] <UInt32>] [[-Credential]
<PSCredential>] [-IncludeInactive] [-PageSize <UInt32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
DESCRIPTION
This function returns members of a provided group in JIRA.
PARAMETERS
-Group <Object[]>
Group object of which to display the members.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-IncludeInactive [<SwitchParameter>]
Include inactive users in the results.
By default they are not shown.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PageSize <UInt32>
Maximum number of results to fetch per call.
This setting can be tuned to get better performance according to the load on the server.
> Warning: too high of a PageSize can cause a timeout on the request.
Required? false
Position? named
Default value 25
Accept pipeline input? False
Accept wildcard characters? false
-StartIndex <UInt32>
> NOTE: This parameter has been marked as deprecated and will be removed with the next major release. > Use
`-Skip` instead.
Index of the first user to return.
This can be used to "page" through users in a large group or a slow connection.
Required? false
Position? 2
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-MaxResults <UInt32>
> NOTE: This parameter has been marked as deprecated and will be removed with the next major release. > Use
`-First` instead.
Maximum number of results to return.
By default, all users will be returned.
Required? false
Position? 3
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many things will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? 4
Default value None
Accept pipeline input? False
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
[JiraPS.Group]
The group to query for members
OUTPUTS
[JiraPS.User]
NOTES
By default, this will return all active users who are members of the given group. For large groups, this can
take quite some time.
To limit the number of group members returned, use the MaxResults parameter. You can also combine this with
the `-StartIndex` parameter to "page" through results.
This function does not return inactive users. This appears to be a limitation of JIRA's REST API.
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraGroupMember testGroup
This example returns all members of the JIRA group testGroup.
-------------------------- EXAMPLE 2 --------------------------
Get-JiraGroup 'Developers' | Get-JiraGroupMember
This example illustrates the use of the pipeline to return members of the Developers group in JIRA.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... oupMember/
Get-JiraGroup
Add-JiraGroupMember
New-JiraGroup
New-JiraUser
Remove-JiraGroupMember
SYNOPSIS
Returns members of a given group in JIRA
SYNTAX
Get-JiraGroupMember [-Group] <Object[]> [[-StartIndex] <UInt32>] [[-MaxResults] <UInt32>] [[-Credential]
<PSCredential>] [-IncludeInactive] [-PageSize <UInt32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
DESCRIPTION
This function returns members of a provided group in JIRA.
PARAMETERS
-Group <Object[]>
Group object of which to display the members.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-IncludeInactive [<SwitchParameter>]
Include inactive users in the results.
By default they are not shown.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PageSize <UInt32>
Maximum number of results to fetch per call.
This setting can be tuned to get better performance according to the load on the server.
> Warning: too high of a PageSize can cause a timeout on the request.
Required? false
Position? named
Default value 25
Accept pipeline input? False
Accept wildcard characters? false
-StartIndex <UInt32>
> NOTE: This parameter has been marked as deprecated and will be removed with the next major release. > Use
`-Skip` instead.
Index of the first user to return.
This can be used to "page" through users in a large group or a slow connection.
Required? false
Position? 2
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-MaxResults <UInt32>
> NOTE: This parameter has been marked as deprecated and will be removed with the next major release. > Use
`-First` instead.
Maximum number of results to return.
By default, all users will be returned.
Required? false
Position? 3
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many things will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? 4
Default value None
Accept pipeline input? False
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
[JiraPS.Group]
The group to query for members
OUTPUTS
[JiraPS.User]
NOTES
By default, this will return all active users who are members of the given group. For large groups, this can
take quite some time.
To limit the number of group members returned, use the MaxResults parameter. You can also combine this with
the `-StartIndex` parameter to "page" through results.
This function does not return inactive users. This appears to be a limitation of JIRA's REST API.
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraGroupMember testGroup
This example returns all members of the JIRA group testGroup.
-------------------------- EXAMPLE 2 --------------------------
Get-JiraGroup 'Developers' | Get-JiraGroupMember
This example illustrates the use of the pipeline to return members of the Developers group in JIRA.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... oupMember/
Get-JiraGroup
Add-JiraGroupMember
New-JiraGroup
New-JiraUser
Remove-JiraGroupMember