Uninstall-GitHubApp¶
SYNOPSIS¶
Uninstall a GitHub App.
SYNTAX¶
App-ByTarget (Default)¶
Uninstall-GitHubApp -Target <Object> [-Context <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
App-ByObject¶
Uninstall-GitHubApp -InstallationObject <GitHubAppInstallation[]> [-Target <Object>]
[-Context <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
Enterprise-BySlug¶
Uninstall-GitHubApp -Organization <string> -AppSlug <string> [-Enterprise <string>]
[-Context <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
Enterprise-ByID¶
Uninstall-GitHubApp -Organization <string> -InstallationID <ulong> [-Enterprise <string>]
[-Context <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
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¶
-AppSlug¶
As Enterprise (IAT/UAT): app slug to uninstall (when the installation ID is unknown).
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Slug
- AppName
ParameterSets:
- Name: Enterprise-BySlug
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Context¶
Common: explicit context (APP for app mode; IAT/UAT with Enterprise for enterprise mode)
Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Enterprise¶
As Enterprise (IAT/UAT): enterprise slug or ID. Optional if the context already has Enterprise set.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Enterprise-BySlug
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: Enterprise-ByID
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-InstallationID¶
As Enterprise (IAT/UAT): installation ID to remove.
Type: System.UInt64
DefaultValue: 0
SupportsWildcards: false
Aliases:
- ID
ParameterSets:
- Name: Enterprise-ByID
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-InstallationObject¶
As APP via pipeline: installation objects.
Type: GitHubAppInstallation[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: App-ByObject
Position: Named
IsRequired: true
ValueFromPipeline: true
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Organization¶
As Enterprise (IAT/UAT): organization where the app is installed.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Enterprise-BySlug
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: Enterprise-ByID
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Target¶
As APP: target to uninstall. Accepts a name (enterprise/org/user) or an installation ID.
Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Name
ParameterSets:
- Name: App-ByObject
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: App-ByTarget
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-WhatIf¶
Runs the command in a mode that only reports what would happen without performing the actions.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
System.Object¶
{{ Fill in the Description }}
GitHubAppInstallation[]¶
{{ Fill in the Description }}