Skip to content

Remove-GitHubOrganizationInvitation

SYNOPSIS

Cancel an organization invitation

SYNTAX

Remove-GitHubOrganizationInvitation [-Organization] <String> [-ID] <String> [[-Context] <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers notifications.

EXAMPLES

EXAMPLE 1

Remove-GitHubOrganizationInvitation -Organization 'github' -InvitationID '12345678'

Cancel the invitation with the ID '12345678' for the organization github.

PARAMETERS

-Organization

The organization name. The name is not case sensitive.

Type: String
Parameter Sets: (All)
Aliases: Org

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

-ID

The unique identifier of the invitation.

Type: String
Parameter Sets: (All)
Aliases: invitation_id, InvitationID

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

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: (Get-GitHubContext)
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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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.

INPUTS

OUTPUTS

System.Boolean

NOTES

Cancel an organization invitation