Skip to content

Install-GitHubAppOnEnterpriseOrganization

SYNOPSIS

Install an app on an Enterprise-owned organization

SYNTAX

Install-GitHubAppOnEnterpriseOrganization [-Enterprise] <String> [-Organization] <String> [-ClientID] <String>
 [[-RepositorySelection] <String>] [[-Repositories] <String[]>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Installs the provided GitHub App on the specified organization owned by the enterprise.

The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission.

EXAMPLES

EXAMPLE 1

Install-GitHubAppOnEnterpriseOrganization -Enterprise 'msx' -Organization 'org' -ClientID '123456'

PARAMETERS

-Enterprise

The enterprise slug or ID.

Type: String
Parameter Sets: (All)
Aliases:

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

-Organization

The organization name. The name is not case sensitive.

Type: String
Parameter Sets: (All)
Aliases:

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

-ClientID

The client ID of the GitHub App to install.

Type: String
Parameter Sets: (All)
Aliases:

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

-RepositorySelection

The repository selection for the GitHub App. Can be one of: - all - all repositories that the authenticated GitHub App installation can access. - selected - select specific repositories.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: All
Accept pipeline input: False
Accept wildcard characters: False

-Repositories

The names of the repositories to which the installation will be granted access.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
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