On this page

    Remove-JiraGroupMember

    SYNOPSIS

    Removes a user from a JIRA group

    SYNTAX

    Remove-JiraGroupMember [-Group] <Object[]> [-User] <Object[]> [[-Credential] <PSCredential>] [-PassThru]
 [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

    DESCRIPTION

    This function removes a JIRA user from a JIRA group.

    EXAMPLES

    EXAMPLE 1

    Remove-JiraGroupMember -Group testUsers -User jsmith

    This example removes the user jsmith from the group testUsers.

    EXAMPLE 2

    Get-JiraGroup 'Project Admins' | Remove-JiraGroupMember -User jsmith

    This example illustrates the use of the pipeline to remove jsmith from the “Project Admins” group in JIRA.

    PARAMETERS

    -Group

    Group Object or ID from which to remove the user(s).

    Type: Object[]
Parameter Sets: (All)
Aliases: GroupName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

    -User

    Username or user object obtained from Get-JiraUser

    Type: Object[]
Parameter Sets: (All)
Aliases: UserName

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Credential

    Credentials to use to connect to JIRA.
    If not specified, this function will use anonymous access.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -PassThru

    Whether output should be provided after invoking this function

    Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

    -Force

    Suppress user confirmation.

    Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

    -WhatIf

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

    Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

    INPUTS

    [JiraPS.Group[]]

    Group(s) from which users should be removed

    [JiraPS.User[]]

    User(s) which to remove

    OUTPUTS

    [JiraPS.Group]

    If the -PassThru parameter is provided, this function will provide a reference to the JIRA group modified. Otherwise, this function does not provide output.

    NOTES

    This REST method is still marked Experimental in JIRA’s REST API. That means that there is a high probability this will break in future versions of JIRA. The function will need to be re-written at that time.

    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.

    Add-JiraGroupMember

    Get-JiraGroup

    Get-JiraGroupMember

    Get-JiraUser

    New-JiraGroup