Uninstall-GitHubApp

SYNOPSIS

Uninstall a GitHub App.

SYNTAX

App-ByTarget (Default)

Uninstall-GitHubApp -Target <Object> [-Context <Object>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

App-ByObject

Uninstall-GitHubApp [-Target <Object>] -InstallationObject <GitHubAppInstallation[]> [-Context <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Enterprise-BySlug

Uninstall-GitHubApp -Organization <String> [-Enterprise <String>] -AppSlug <String> [-Context <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Enterprise-ByID

Uninstall-GitHubApp -Organization <String> [-Enterprise <String>] -InstallationID <UInt64> [-Context <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Uninstalls a GitHub App installation. Works in two modes: - As the authenticated App (APP context): remove installations by target name, ID, or pipeline objects. - As an enterprise installation (IAT/UAT context with Enterprise): remove an app from an organization by InstallationID or AppSlug.

EXAMPLES

EXAMPLE 1

Uninstall-GitHubApp -Target 'octocat'
Uninstall-GitHubApp -Target 12345

As an App: uninstall by target name (enterprise/org/user) or by exact installation ID

EXAMPLE 2

Get-GitHubAppInstallation | Uninstall-GitHubApp

As an App: uninstall using pipeline objects

EXAMPLE 3

Uninstall-GitHubApp -Organization 'org' -InstallationID 123456 -Context (Connect-GitHubApp -Enterprise 'msx' -PassThru)

As an enterprise installation: uninstall by installation ID in an org

EXAMPLE 4

Uninstall-GitHubApp -Organization 'org' -AppSlug 'my-app' -Context (Connect-GitHubApp -Enterprise 'msx' -PassThru)

As an enterprise installation: uninstall by app slug in an org

PARAMETERS

-Target

As APP: target to uninstall. Accepts a name (enterprise/org/user) or an installation ID.

Type: Object
Parameter Sets: App-ByTarget
Aliases: Name

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

Type: Object
Parameter Sets: App-ByObject
Aliases: Name

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

-InstallationObject

As APP via pipeline: installation objects.

Type: GitHubAppInstallation[]
Parameter Sets: App-ByObject
Aliases:

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

-Organization

As Enterprise (IAT/UAT): organization where the app is installed.

Type: String
Parameter Sets: Enterprise-BySlug, Enterprise-ByID
Aliases:

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

-Enterprise

As Enterprise (IAT/UAT): enterprise slug or ID. Optional if the context already has Enterprise set.

Type: String
Parameter Sets: Enterprise-BySlug, Enterprise-ByID
Aliases:

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

-InstallationID

As Enterprise (IAT/UAT): installation ID to remove.

Type: UInt64
Parameter Sets: Enterprise-ByID
Aliases: ID

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

-AppSlug

As Enterprise (IAT/UAT): app slug to uninstall (when the installation ID is unknown).

Type: String
Parameter Sets: Enterprise-BySlug
Aliases: Slug, AppName

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

-Context

Common: explicit context (APP for app mode; IAT/UAT with Enterprise for enterprise mode)

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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

NOTES

RELATED LINKS

https://psmodule.io/GitHub/Functions/Apps/GitHub%20App/Uninstall-GitHubApp