Skip to content

Get-GitHubAppInstallation

SYNOPSIS

List installations for the authenticated app, on organization or enterprise organization.

SYNTAX

__AllParameterSets (Default)

Get-GitHubAppInstallation [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Enterprise

Get-GitHubAppInstallation -Enterprise <String> -Organization <String> [-PerPage <Int32>] [-Context <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Organization

Get-GitHubAppInstallation -Organization <String> [-PerPage <Int32>] [-Context <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Lists the installations for the authenticated app. If the app is installed on an enterprise, the installations for the enterprise are returned. If the app is installed on an organization, the installations for the organization are returned.

EXAMPLES

Example 1

PS C:> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Enterprise

The enterprise slug or ID.

Type: String
Parameter Sets: Enterprise
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: Enterprise, Organization
Aliases:

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

-PerPage

The number of results per page (max 100).

Type: Int32
Parameter Sets: Enterprise, Organization
Aliases:

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