< Back

Remove-JiraGroup

Thu Jan 16, 2020 8:11 am

NAME Remove-JiraGroup



SYNOPSIS

Removes an existing group from JIRA





SYNTAX

Remove-JiraGroup [-Group] <Object[]> [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

This function removes an existing group from JIRA.



> Deleting a group does not delete users from JIRA.





PARAMETERS

-Group <Object[]>

Group Object or ID to delete.



Required? true

Position? 1

Default value None

Accept pipeline input? True (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



-Force [<SwitchParameter>]

Suppress user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

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







OUTPUTS



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



Remove-JiraGroup -GroupName testGroup



Removes the JIRA group testGroup



RELATED LINKS

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

Get-JiraGroup

New-JiraGroup