Get-JiraGroup

NAME Get-JiraGroup



SYNOPSIS

Returns a group from Jira





SYNTAX

Get-JiraGroup [-GroupName] <String[]> [[-Credential] <PSCredential>] [<CommonParameters>]





DESCRIPTION

This function returns information regarding a specified group from JIRA.



To get the members of a group, use `Get-JiraGroupMember`.





PARAMETERS

-GroupName <String[]>

Name of the group to search for.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

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

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



OUTPUTS

[JiraPS.Group]







NOTES





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-JiraGroup -GroupName testGroup



Returns information about the group "testGroup"

-------------------------- EXAMPLE 2 --------------------------



Get-JiraGroup -GroupName testGroup |

Get-JiraGroupMember



This example retrieves the members of "testGroup".



RELATED LINKS

Online Version: https://atlassianps.org/docs/JiraPS/com ... JiraGroup/

Get-JiraGroupMember

Get-JiraUser

New-JiraGroup

Remove-JiraGroup