Skip to content

Uninstall-GitHubApp

SYNOPSIS

Uninstall a GitHub App.

SYNTAX

__AllParameterSets (Default)

Uninstall-GitHubApp -ID <String> [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

EnterpriseOrganization

Uninstall-GitHubApp -Enterprise <String> -Organization <String> -ID <String> [-Context <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Uninstalls the provided GitHub App on the specified target.

EXAMPLES

EXAMPLE 1

Uninstall-GitHubApp -Enterprise 'msx' -Organization 'org' -InstallationID '123456'

Uninstall the GitHub App with the installation ID '123456' from the organization 'org' in the enterprise 'msx'.

PARAMETERS

-Enterprise

The enterprise slug or ID.

Type: String
Parameter Sets: EnterpriseOrganization
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Organization

The organization name. The name is not case sensitive.

Type: String
Parameter Sets: EnterpriseOrganization
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ID

The client ID of the GitHub App to install.

Type: String
Parameter Sets: (All)
Aliases: installation_id, InstallationID

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: Named
Default value: (Get-GitHubContext)
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

NOTES