GitHub PowerShell

https://psmodule.io/GitHub/
Admin
This module provides a PowerShell-flavored approach to managing and automating GitHub environments,...
Tokens:143,184
Snippets:583
Trust Score:3.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example: Install GitHub App for All Repositories

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

Illustrates how to install a GitHub App for an organization within an enterprise, granting access to all repositories the app can access. This example uses the -RepositorySelection 'all' parameter.

```powershell
Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'all'
```

--------------------------------

### Example: Install GitHub App with Specific Repositories

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

Demonstrates how to install a GitHub App for a specific organization within an enterprise, granting access to selected repositories. This example utilizes the -RepositorySelection 'selected' parameter.

```powershell
Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'selected' -Repositories 'repo1', 'repo2'
```

--------------------------------

### Create GitHub App Installation Access Token for All Installations (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/New-GitHubAppInstallationAccessToken

This example shows how to obtain installation access tokens for all available GitHub App installations. It first connects to GitHub using client credentials, then retrieves all app installations, and finally generates a new installation access token for each retrieved installation. This is useful for managing access across multiple installations.

```powershell
Connect-GitHub -ClientID $ClientID -PrivateKey $PrivateKey
Get-GitHubAppInstallation | New-GitHubAppInstallationAccessToken
```

--------------------------------

### Example: Get All GitHub Releases (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Get-GitHubRelease

An example demonstrating how to retrieve all releases for the 'hello-world' repository owned by 'octocat' using the '-AllVersions' parameter.

```powershell
Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -AllVersions
```

--------------------------------

### Example: Get GitHub Release by Tag (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Get-GitHubRelease

An example demonstrating how to retrieve a specific release tagged 'v1.0.0' for the 'hello-world' repository owned by 'octocat'.

```powershell
Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0'
```

--------------------------------

### Example: Get Latest GitHub Release (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Get-GitHubRelease

An example demonstrating how to retrieve the latest release for the 'hello-world' repository owned by 'octocat'. This showcases the basic usage of the cmdlet.

```powershell
Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world'
```

--------------------------------

### Example: Get GitHub Release by ID (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Get-GitHubRelease

An example demonstrating how to retrieve a specific release with the ID '1234567' for the 'hello-world' repository owned by 'octocat'.

```powershell
Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567'
```

--------------------------------

### Get Installation by ID

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallation

Retrieves a single GitHub App installation by its unique ID. Requires the '-ID' parameter.

```APIDOC
## GET /app/installations/{installation_id}

### Description
Retrieves a single installation for the authenticated app by its unique ID.

### Method
GET

### Endpoint
/app/installations/{installation_id}

### Parameters
#### Path Parameters
- **installation_id** (integer) - Required - The unique identifier of the installation.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the installation.
- **account** (object) - The account (user or organization) the installation belongs to.
  - **login** (string) - The login name of the account.
  - **id** (integer) - The unique identifier of the account.
  - **node_id** (string) - The GraphQL node ID of the account.
  - **url** (string) - The URL for the account.
  - **html_url** (string) - The HTML URL for the account.
  - **type** (string) - The type of the account (e.g., 'User', 'Organization').
- **repository_selection** (string) - Indicates the repository selection (e.g., 'all', 'selected').
- **access_tokens_url** (string) - The URL to access tokens for this installation.
- **repositories_url** (string) - The URL to repositories associated with this installation.
- **html_url** (string) - The HTML URL for the installation.
- **app_id** (integer) - The ID of the app associated with this installation.
- **app_slug** (string) - The slug of the app associated with this installation.
- **target_id** (integer) - The ID of the target (enterprise or organization) for the installation.
- **target_type** (string) - The type of the target ('User', 'Organization', 'Enterprise').

### Response Example
```json
{
  "id": 1,
  "account": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "type": "User"
  },
  "repository_selection": "all",
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/settings/installations/1",
  "app_id": 12345,
  "app_slug": "my-app",
  "target_id": 1,
  "target_type": "User"
}
```
```

--------------------------------

### POST /app/installations/{installation_id}/access_tokens

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/New-GitHubAppInstallationAccessToken

Creates an installation access token for a GitHub App installation. This token allows the app to make authenticated API requests on behalf of the installation. The token expires after one hour.

```APIDOC
## POST /app/installations/{installation_id}/access_tokens

### Description
Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them.

### Method
POST

### Endpoint
`/app/installations/{installation_id}/access_tokens`

### Parameters
#### Path Parameters
- **installation_id** (integer) - Required - The unique identifier of the installation.

#### Query Parameters
None

#### Request Body
- **repositories** (array of strings) - Optional - A list of repository names that the token can access. If not specified, the token has access to all repositories the installation can access.
- **repository_ids** (array of integers) - Optional - A list of repository IDs that the token can access. If not specified, the token has access to all repositories the installation can access.
- **permissions** (object) - Optional - A map of permissions to grant the token. If not specified, the token has all permissions granted to the app.
  - **contents** (string) - Required/Optional - The level of permission to grant to the repository contents.
  - **deployments** (string) - Required/Optional - The level of permission to grant to deployments.
  - **issues** (string) - Required/Optional - The level of permission to grant to issues.
  - **metadata** (string) - Required/Optional - The level of permission to grant to metadata.
  - **pages** (string) - Required/Optional - The level of permission to grant to GitHub Pages.
  - **pull_requests** (string) - Required/Optional - The level of permission to grant to pull requests.
  - **repository_projects** (string) - Required/Optional - The level of permission to grant to repository projects.
  - **secrets** (string) - Required/Optional - The level of permission to grant to secrets.
  - **statuses** (string) - Required/Optional - The level of permission to grant to statuses.
  - **actions** (string) - Required/Optional - The level of permission to grant to Actions.
  - **checks** (string) - Required/Optional - The level of permission to grant to checks.
  - **code_scanning_alerts** (string) - Required/Optional - The level of permission to grant to code scanning alerts.
  - **members** (string) - Required/Optional - The level of permission to grant to members.
  - **organization_administration** (string) - Required/Optional - The level of permission to grant to organization administration.
  - **organization_projects** (string) - Required/Optional - The level of permission to grant to organization projects.
  - **organization_secrets** (string) - Required/Optional - The level of permission to grant to organization secrets.
  - **organization_teams** (string) - Required/Optional - The level of permission to grant to organization teams.
  - **packages** (string) - Required/Optional - The level of permission to grant to packages.
  - **security_events** (string) - Required/Optional - The level of permission to grant to security events.
  - **single_file** (string) - Required/Optional - The level of permission to grant to single file.
  - **all** (string) - Required/Optional - The level of permission to grant to all resources.

### Request Example
```json
{
  "repositories": [
    "my-repo"
  ],
  "permissions": {
    "issues": "write",
    "pull_requests": "write"
  }
}
```

### Response
#### Success Response (201)
- **token** (string) - The installation access token.
- **expires_at** (string) - The expiration date and time of the token.

#### Response Example
```json
{
  "token": "gho_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "expires_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Install GitHub App Syntax

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

Provides the syntax for the Install-GitHubApp cmdlet, including default and enterprise organization parameter sets. It outlines the required and optional parameters for installing a GitHub App.

```powershell
Install-GitHubApp -ClientID <String> [-RepositorySelection <String>] [-Repositories <String[]>] [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

```powershell
Install-GitHubApp -Enterprise <String> -Organization <String> -ClientID <String> [-RepositorySelection <String>] [-Repositories <String[]>] [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

--------------------------------

### Example: List Specific GitHub Release Asset by Name and Release ID (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Assets/Get-GitHubReleaseAsset

This example shows how to get a particular release asset by its name ('example.zip') from a specific release identified by its Release ID ('7654321') within a GitHub repository.

```powershell
Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ReleaseID '7654321' -Name 'example.zip'
```

--------------------------------

### Grant GitHub App Repository Access (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Add-GitHubAppInstallationRepositoryAccess

This example demonstrates how to grant repository access to a GitHub App installation. It utilizes a hashtable for parameters, including enterprise, organization, installation ID, and a list of repositories. This is useful for automating GitHub App permissions.

```powershell
$params = @{
    Enterprise          = 'msx'
    Organization        = 'PSModule'
    InstallationID      = 12345678
    Repositories        = 'repo1', 'repo2'
}
Add-GitHubAppInstallationRepositoryAccess @params
```

--------------------------------

### Create GitHub App Installation Access Token (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/New-GitHubAppInstallationAccessToken

This code snippet demonstrates how to create an installation access token for a GitHub App using the New-GitHubAppInstallationAccessToken cmdlet. It requires the installation ID as input. This token is valid for one hour and is used to authenticate API requests for the app's installation.

```powershell
New-GitHubAppInstallationAccessToken -InstallationID 12345678
```

--------------------------------

### Example: Get GitHub Release Asset by ID (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Assets/Get-GitHubReleaseAsset

A practical example demonstrating how to fetch a GitHub release asset using its specific ID. This example calls the function with 'octocat' as the owner, 'hello-world' as the repository, and '1234567' as the asset ID.

```powershell
Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567'
```

--------------------------------

### Update GitHub App Installation Repository Access (All Repositories)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Update-GitHubAppInstallationRepositoryAccess

This example demonstrates how to update the repository access for a GitHub App installation to include all repositories within a specified organization and enterprise. It requires the enterprise slug, organization name, installation ID, and repository selection set to 'all'.

```powershell
Update-GitHubAppInstallationRepositoryAccess -Enterprise 'msx' -Organization 'PSModule' -InstallationID 12345678 -RepositorySelection 'all'
```

--------------------------------

### Get GitHub Repository Permission - PowerShell Example

Source: https://psmodule.io/GitHub/Functions/Repositories/Permissions/Get-GitHubRepositoryPermission

This example demonstrates how to use the Get-GitHubRepositoryPermission cmdlet to retrieve the permission level of the 'core' team for the 'Hello-World' repository owned by 'octocat'. The output is expected to be 'Admin'.

```powershell
Get-GitHubRepositoryPermission -Owner 'octocat' -Name 'Hello-World' -Team 'core'
```

--------------------------------

### List Installations for the Authenticated App

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallation

Lists all installations for the authenticated GitHub App. This includes installations on organizations or enterprises. Supports pagination with '-PerPage'.

```APIDOC
## GET /app/installations

### 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.

### Method
GET

### Endpoint
/app/installations

### Parameters
#### Query Parameters
- **per_page** (integer) - Optional - The number of results per page (max 100).

### Response
#### Success Response (200)
- **installations** (array) - A list of installation objects.
  - **id** (integer) - The unique identifier of the installation.
  - **account** (object) - The account (user or organization) the installation belongs to.
    - **login** (string) - The login name of the account.
    - **id** (integer) - The unique identifier of the account.
    - **node_id** (string) - The GraphQL node ID of the account.
    - **url** (string) - The URL for the account.
    - **html_url** (string) - The HTML URL for the account.
    - **type** (string) - The type of the account (e.g., 'User', 'Organization').
  - **repository_selection** (string) - Indicates the repository selection (e.g., 'all', 'selected').
  - **access_tokens_url** (string) - The URL to access tokens for this installation.
  - **repositories_url** (string) - The URL to repositories associated with this installation.
  - **html_url** (string) - The HTML URL for the installation.
  - **app_id** (integer) - The ID of the app associated with this installation.
  - **app_slug** (string) - The slug of the app associated with this installation.
  - **target_id** (integer) - The ID of the target (enterprise or organization) for the installation.
  - **target_type** (string) - The type of the target ('User', 'Organization', 'Enterprise').

### Response Example
```json
{
  "installations": [
    {
      "id": 1,
      "account": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "type": "User"
      },
      "repository_selection": "all",
      "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/settings/installations/1",
      "app_id": 12345,
      "app_slug": "my-app",
      "target_id": 1,
      "target_type": "User"
    }
  ]
}
```
```

--------------------------------

### Install GitHub PowerShell Module

Source: https://psmodule.io/GitHub/index

Installs the GitHub PowerShell module from the PowerShell Gallery. It ensures the module is available for use in managing GitHub resources.

```powershell
Install-PSResource -Name GitHub -Repository PSGallery -TrustRepository

```

--------------------------------

### Connect-GitHubApp - By Installation Object

Source: https://psmodule.io/GitHub/Functions/Auth/Connect-GitHubApp

Connects to GitHub using a provided GitHub App Installation object.

```APIDOC
## POST /connect/github/app/installation

### Description
Connects to GitHub using a provided GitHub App Installation object.

### Method
POST

### Endpoint
/connect/github/app/installation

### Parameters
#### Request Body
- **Installation** (GitHubAppInstallation[]) - Required - Installation objects from pipeline for parallel processing.

#### Query Parameters
- **PassThru** (SwitchParameter) - Optional - Passes the context object to the pipeline.
- **Silent** (SwitchParameter) - Optional - Suppresses the output of the function.
- **Default** (SwitchParameter) - Optional - Sets the connection as the default context.
- **Context** (Object) - Optional - The context to run the command in. Can be either a string or a GitHubContext object.
- **ProgressAction** (ActionPreference) - Optional - Fill ProgressAction Description

### Request Example
```json
{
  "Installation": [
    {
      "id": 12345,
      "account": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "type": "User"
      },
      "repository_selection": "all",
      "access_tokens_url": "https://api.github.com/app/installations/12345/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories"
    }
  ],
  "PassThru": false,
  "Silent": false,
  "Default": false,
  "Context": null,
  "ProgressAction": "Continue"
}
```

### Response
#### Success Response (200)
- **GitHubContext** (Object) - The context object for the GitHub connection.

#### Response Example
```json
{
  "message": "Successfully connected to GitHub using the provided installation object."
}
```
```

--------------------------------

### Get GitHub App Installation Repository Access (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallationRepositoryAccess

Retrieves repositories accessible to a GitHub App installation. Requires 'Enterprise', 'Organization', and 'ID' parameters. The GitHub App needs specific permissions on the enterprise.

```powershell
Get-GitHubAppInstallationRepositoryAccess -Enterprise 'msx' -Organization 'PSModule' -ID 12345678
```

--------------------------------

### List GitHub App Installation Requests

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App/Get-GitHubAppInstallationRequest

This cmdlet retrieves all pending installation requests for the authenticated GitHub App. It requires no specific parameters for a basic listing.

```powershell
Get-GitHubAppInstallationRequest
```

--------------------------------

### Update GitHub App Installation Repository Access (Selected Repositories)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Update-GitHubAppInstallationRepositoryAccess

This example shows how to update the repository access for a GitHub App installation to a specific list of repositories. It utilizes a parameter splatting for clarity, providing the enterprise slug, organization name, installation ID, repository selection set to 'selected', and an array of repository names.

```powershell
$params = @{
    Enterprise          = 'msx'
    Organization        = 'PSModule'
    InstallationID      = 12345678
    RepositorySelection = 'selected'
    Repositories        = 'repo1', 'repo2'
}
Update-GitHubAppInstallationRepositoryAccess @params
```

--------------------------------

### List Installations on an Organization

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallation

Lists installations for the authenticated app on a specific organization. Requires the '-Organization' parameter.

```APIDOC
## GET /orgs/{org}/installation

### Description
Lists installations for the authenticated app on a specific organization.

### Method
GET

### Endpoint
/orgs/{org}/installation

### Parameters
#### Path Parameters
- **org** (string) - Required - The name of the organization.

#### Query Parameters
- **per_page** (integer) - Optional - The number of results per page (max 100).

### Response
#### Success Response (200)
- **installations** (array) - A list of installation objects for the specified organization.
  - **id** (integer) - The unique identifier of the installation.
  - **account** (object) - The account (organization) the installation belongs to.
    - **login** (string) - The login name of the account.
    - **id** (integer) - The unique identifier of the account.
    - **node_id** (string) - The GraphQL node ID of the account.
    - **url** (string) - The URL for the account.
    - **html_url** (string) - The HTML URL for the account.
    - **type** (string) - The type of the account ('Organization').
  - **repository_selection** (string) - Indicates the repository selection (e.g., 'all', 'selected').
  - **access_tokens_url** (string) - The URL to access tokens for this installation.
  - **repositories_url** (string) - The URL to repositories associated with this installation.
  - **html_url** (string) - The HTML URL for the installation.
  - **app_id** (integer) - The ID of the app associated with this installation.
  - **app_slug** (string) - The slug of the app associated with this installation.
  - **target_id** (integer) - The ID of the target organization for the installation.
  - **target_type** (string) - The type of the target ('Organization').

### Response Example
```json
{
  "installations": [
    {
      "id": 3,
      "account": {
        "login": "my-org",
        "id": 3,
        "node_id": "MDQ6 organization3",
        "url": "https://api.github.com/orgs/my-org",
        "html_url": "https://github.com/my-org",
        "type": "Organization"
      },
      "repository_selection": "selected",
      "access_tokens_url": "https://api.github.com/app/installations/3/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/settings/installations/3",
      "app_id": 12345,
      "app_slug": "my-app",
      "target_id": 3,
      "target_type": "Organization"
    }
  ]
}
```
```

--------------------------------

### Example: Get GitHub Teams for an Organization (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Teams/Get-GitHubTeam

Demonstrates how to use the Get-GitHubTeam cmdlet to list all teams associated with the 'GitHub' organization.

```powershell
Get-GitHubTeam -Organization 'GitHub'
```

--------------------------------

### Connect to GitHub App (By Installation ID)

Source: https://psmodule.io/GitHub/Functions/Auth/Connect-GitHubApp

Connects to GitHub directly using one or more installation IDs. This approach bypasses the need for installation objects and is efficient for connecting to known installations. It accepts pipeline input by property name and is written in PowerShell.

```powershell
Connect-GitHubApp -ID <Int32[]>

```

--------------------------------

### Example: Get Repositories for Authenticated User (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Repositories/Get-GitHubRepository

Demonstrates the basic usage of the Get-GitHubRepository cmdlet to list all repositories for the currently authenticated GitHub user. This is the simplest way to query the user's repositories without any filters.

```powershell
Get-GitHubRepository
```

--------------------------------

### Connect-GitHubApp - By Installation ID

Source: https://psmodule.io/GitHub/Functions/Auth/Connect-GitHubApp

Connects to GitHub using one or more GitHub App Installation IDs.

```APIDOC
## POST /connect/github/app/installation/{id}

### Description
Connects to GitHub using one or more GitHub App Installation IDs.

### Method
POST

### Endpoint
/connect/github/app/installation/{id}

### Parameters
#### Path Parameters
- **ID** (Int32[]) - Required - The installation ID(s) to connect to directly.

#### Query Parameters
- **PassThru** (SwitchParameter) - Optional - Passes the context object to the pipeline.
- **Silent** (SwitchParameter) - Optional - Suppresses the output of the function.
- **Default** (SwitchParameter) - Optional - Sets the connection as the default context.
- **Context** (Object) - Optional - The context to run the command in. Can be either a string or a GitHubContext object.
- **ProgressAction** (ActionPreference) - Optional - Fill ProgressAction Description

### Request Example
```json
{
  "ID": [12345, 67890],
  "PassThru": false,
  "Silent": false,
  "Default": false,
  "Context": null,
  "ProgressAction": "Continue"
}
```

### Response
#### Success Response (200)
- **GitHubContext** (Object) - The context object for the GitHub connection.

#### Response Example
```json
{
  "message": "Successfully connected to GitHub using the provided installation ID(s)."
}
```
```

--------------------------------

### Connect to GitHub App (By Installation Object)

Source: https://psmodule.io/GitHub/Functions/Auth/Connect-GitHubApp

Connects to GitHub using a provided GitHub App installation object. This method allows for direct manipulation and processing of installation objects, potentially for parallel operations. The code is in PowerShell.

```powershell
Connect-GitHubApp -Installation <GitHubAppInstallation[]>

```

--------------------------------

### List Installations on an Enterprise Organization

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallation

Lists installations for the authenticated app on a specific enterprise organization. Requires both '-Enterprise' and '-Organization' parameters.

```APIDOC
## GET /enterprises/{enterprise}/installed_apps/{app_slug}/installations

### Description
Lists installations for the authenticated app on a specific enterprise organization.

### Method
GET

### Endpoint
/enterprises/{enterprise}/installed_apps/{app_slug}/installations

### Parameters
#### Path Parameters
- **enterprise** (string) - Required - The enterprise name.
- **app_slug** (string) - Required - The slug of the app.

#### Query Parameters
- **per_page** (integer) - Optional - The number of results per page (max 100).

### Response
#### Success Response (200)
- **installations** (array) - A list of installation objects for the specified enterprise.
  - **id** (integer) - The unique identifier of the installation.
  - **account** (object) - The account (organization) the installation belongs to.
    - **login** (string) - The login name of the account.
    - **id** (integer) - The unique identifier of the account.
    - **node_id** (string) - The GraphQL node ID of the account.
    - **url** (string) - The URL for the account.
    - **html_url** (string) - The HTML URL for the account.
    - **type** (string) - The type of the account ('Organization').
  - **repository_selection** (string) - Indicates the repository selection (e.g., 'all', 'selected').
  - **access_tokens_url** (string) - The URL to access tokens for this installation.
  - **repositories_url** (string) - The URL to repositories associated with this installation.
  - **html_url** (string) - The HTML URL for the installation.
  - **app_id** (integer) - The ID of the app associated with this installation.
  - **app_slug** (string) - The slug of the app associated with this installation.
  - **target_id** (integer) - The ID of the target enterprise for the installation.
  - **target_type** (string) - The type of the target ('Enterprise').

### Response Example
```json
{
  "installations": [
    {
      "id": 2,
      "account": {
        "login": "my-enterprise",
        "id": 2,
        "node_id": "MDQ6VW50ZXJwcmlzZTI=",
        "url": "https://api.github.com/orgs/my-enterprise",
        "html_url": "https://github.com/enterprises/my-enterprise",
        "type": "Enterprise"
      },
      "repository_selection": "all",
      "access_tokens_url": "https://api.github.com/app/installations/2/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/settings/installations/2",
      "app_id": 12345,
      "app_slug": "my-app",
      "target_id": 2,
      "target_type": "Enterprise"
    }
  ]
}
```
```

--------------------------------

### Example: Save-GitHubReleaseAsset with Asset ID (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Assets/Save-GitHubReleaseAsset

Demonstrates downloading a release asset using its ID. The example specifies the owner, repository, asset ID, and a destination path. The output shows the downloaded file details.

```powershell
Save-GitHubReleaseAsset -Owner 'octocat' -Repository 'Hello-World' -ID '123456' -Path 'C:\Assets'
```

--------------------------------

### Connect-GitHubApp - All Installations (Default)

Source: https://psmodule.io/GitHub/Functions/Auth/Connect-GitHubApp

Connects to GitHub as all available installations (users, organizations, enterprises) using the logged-in GitHub App. This is the default behavior if no specific filters are provided.

```APIDOC
## POST /connect/github/app/all

### Description
Connects to GitHub as all available targets (users, organizations, enterprises) using the logged-in GitHub App.

### Method
POST

### Endpoint
/connect/github/app/all

### Parameters
#### Query Parameters
- **PassThru** (SwitchParameter) - Optional - Passes the context object to the pipeline.
- **Silent** (SwitchParameter) - Optional - Suppresses the output of the function.
- **Default** (SwitchParameter) - Optional - Sets the connection as the default context.
- **Context** (Object) - Optional - The context to run the command in. Can be either a string or a GitHubContext object.
- **ProgressAction** (ActionPreference) - Optional - Fill ProgressAction Description

### Request Example
```json
{
  "PassThru": false,
  "Silent": false,
  "Default": false,
  "Context": null,
  "ProgressAction": "Continue"
}
```

### Response
#### Success Response (200)
- **GitHubContext** (Object) - The context object for the GitHub connection.

#### Response Example
```json
{
  "message": "Successfully connected to GitHub as all installations."
}
```
```

--------------------------------

### Example: List GitHub Teams with Repository Access (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Teams/Get-GitHubTeam

Shows an example of how to list all teams that have access to the 'my-repo' repository within the 'github' organization.

```powershell
Get-GitHubTeam -Organization 'github' -Repository 'my-repo'
```

--------------------------------

### Get GitHub App Installations (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallation

Retrieves a list of installations for the authenticated GitHub App. This includes installations on an enterprise or a specific organization. It can also fetch a single installation by its unique ID.

```powershell
Get-GitHubAppInstallation
Get-GitHubAppInstallation -PerPage <Int32>
Get-GitHubAppInstallation -Enterprise <String> -Organization <String>
Get-GitHubAppInstallation -Organization <String>
Get-GitHubAppInstallation -ID <Int32>
```

--------------------------------

### Install-GitHubApp API

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

This section details the parameters and usage for installing a GitHub App.

```APIDOC
## POST /api/github/apps/install

### Description
Installs the provided GitHub App on the specified target organization or enterprise.

### Method
POST

### Endpoint
/api/github/apps/install

### Parameters
#### Request Body
- **ClientID** (String) - Required - The client ID of the GitHub App to install.
- **Enterprise** (String) - Optional - The enterprise slug or ID. Required if installing within an enterprise context.
- **Organization** (String) - Optional - The organization name. Required if installing within an organization context.
- **RepositorySelection** (String) - Optional - Specifies the repository selection for the app. Can be 'all' or 'selected'. Defaults to 'selected'.
- **Repositories** (String[]) - Optional - An array of repository names to grant access to when RepositorySelection is 'selected'.
- **Context** (Object) - Optional - The context to run the command in. Can be a string or a GitHubContext object.

### Request Example
```json
{
  "ClientID": "YOUR_CLIENT_ID",
  "Enterprise": "your_enterprise",
  "Organization": "your_organization",
  "RepositorySelection": "selected",
  "Repositories": ["repo1", "repo2"]
}
```

### Response
#### Success Response (200)
- **message** (String) - A success message indicating the app was installed.

#### Response Example
```json
{
  "message": "GitHub App installed successfully."
}
```

#### Error Response (400/401/404)
- **error** (String) - An error message detailing the issue.

#### Error Response Example
```json
{
  "error": "Invalid ClientID provided."
}
```
```

--------------------------------

### Create GitHub Repository from Template to User

Source: https://psmodule.io/GitHub/Functions/Repositories/New-GitHubRepository

Creates a new repository for the authenticated user based on a specified template repository. Requires template owner and repository name. Optional parameters allow customization of visibility, description, and other repository settings.

```powershell
New-GitHubRepository -Name <String> -TemplateOwner <String> -TemplateRepository <String> [-IncludeAllBranches]
 [-Visibility <String>] [-Description <String>] [-Homepage <Uri>] [-IsArchived <Boolean>]
 [-IsTemplate <Boolean>] [-WebCommitSignoffRequired <Boolean>]
 [-DefaultBranch <String>] [-HasWiki <Boolean>] [-HasIssues <Boolean>]
 [-HasSponsorships <Boolean>] [-HasDiscussions <Boolean>] [-HasProjects <Boolean>]
 [-AllowMergeCommitWith <String>] [-AllowSquashMergingWith <String>]
 [-AllowRebaseMerging <Boolean>] [-SuggestUpdateBranch <Boolean>]
 [-AllowAutoMerge <Boolean>] [-DeleteBranchOnMerge <Boolean>]
 [-EnableAdvancedSecurity <Boolean>] [-EnableCodeSecurity <Boolean>]
 [-EnableSecretScanning <Boolean>] [-EnableSecretScanningPushProtection <Boolean>]
 [-EnableSecretScanningAIDetection <Boolean>]
 [-EnableSecretScanningNonProviderPatterns <Boolean>] [-Context <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

--------------------------------

### Example: List Specific GitHub Release Asset by Name and Tag (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Assets/Get-GitHubReleaseAsset

Demonstrates fetching a specific release asset named 'example.zip' from a GitHub repository's release tagged with 'v1.0.0'. This is useful for pinpointing assets from versioned releases.

```powershell
Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Name 'example.zip'
```

--------------------------------

### Create GitHub Repository - Basic Example

Source: https://psmodule.io/GitHub/Functions/Repositories/New-GitHubRepository

Creates a new public GitHub repository with specified name, description, and homepage. Enables features like issues, projects, wiki, discussions, and sets it as a template repository. Allows squash merging and auto-merge, with branch deletion on merge.

```powershell
$params = @{
    Name                     = 'Hello-World'
    Description              = 'This is your first repository'
    Homepage                 = 'https://github.com'
    HasIssues                = $true
    HasProjects              = $true
    HasWiki                  = $true
    HasDiscussions           = $true
    IsTemplate               = $true
    AddReadme                = $true
    AllowSquashMerge         = $true
    AllowAutoMerge           = $true
    DeleteBranchOnMerge      = $true
    SquashMergeCommitTitle   = 'PR_TITLE'
    SquashMergeCommitMessage = 'PR_BODY'
}
New-GitHubRepository @params
```

--------------------------------

### Common PowerShell Parameters for GitHub Cmdlets

Source: https://psmodule.io/GitHub/Functions/Repositories/New-GitHubRepository

Demonstrates the usage of common PowerShell parameters for controlling command execution and output, such as -WhatIf, -Confirm, and -ProgressAction.

```powershell
# Example Usage:
# New-GitHubRepository -Name "my-repo" -WhatIf
# New-GitHubRepository -Name "my-repo" -Confirm
# New-GitHubRepository -Name "my-repo" -ProgressAction SilentlyContinue
```

--------------------------------

### GitHub Organization Examples (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Organization/Get-GitHubOrganization

This section provides practical examples of using the Get-GitHubOrganization cmdlet. It illustrates how to list organizations for the authenticated user, public organizations for a specific user, all organizations made after a certain ID, a specific organization by name, and organizations belonging to an enterprise.

```powershell
# List all organizations for the authenticated user.
Get-GitHubOrganization

# List public organizations for a specific user.
Get-GitHubOrganization -Username 'octocat'

# List all organizations made after an ID.
Get-GitHubOrganization -All -Since 142951047

# Get a specific organization.
Get-GitHubOrganization -Name 'PSModule'

# Get the organizations belonging to an Enterprise.
Get-GitHubOrganization -Enterprise 'msx'
```

--------------------------------

### Get a specific gitignore template by name

Source: https://psmodule.io/GitHub/Functions/Gitignore/Get-GitHubGitignore

Fetches a specific gitignore template by its name. The template content is returned as a string. For example, to get the VisualStudio gitignore template, use '-Name "VisualStudio"'.

```powershell
Get-GitHubGitignore -Name 'VisualStudio'
```

--------------------------------

### Example: Save-GitHubReleaseAsset with Tag, Name, Expand, and Force (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Releases/Assets/Save-GitHubReleaseAsset

Illustrates downloading a release asset by tag and name, including options to expand downloaded archives and force overwrite existing files. The example also specifies a destination path and shows the resulting directory listing.

```powershell
Save-GitHubReleaseAsset -Owner 'octocat' -Repository 'Hello-World' -Tag 'v1.0.0' -Name 'binary.zip' -Path 'C:\Assets\app' -Expand -Force
```

--------------------------------

### GET /rest/apps/{owner}/installations/{installation_id}/repositories

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppInstallationRepositoryAccess

Retrieves a list of repositories that a GitHub App installation can access. This endpoint is useful for understanding the scope of access granted to an app installation within an organization or enterprise.

```APIDOC
## GET /rest/apps/{owner}/installations/{installation_id}/repositories

### Description
Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization. The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (read) permission.

### Method
GET

### Endpoint
`/rest/apps/{owner}/installations/{installation_id}/repositories`

### Parameters
#### Path Parameters
- **owner** (string) - Required - The organization or enterprise owner of the installation.
- **installation_id** (integer) - Required - The unique identifier of the installation.

#### Query Parameters
- **per_page** (integer) - Optional - The number of results per page (max 100).
- **page** (integer) - Optional - Page number of the results to fetch.

### Request Example
```json
{
  "owner": "PSModule",
  "installation_id": 12345678
}
```

### Response
#### Success Response (200)
- **repositories** (array) - A list of repository objects.
  - **id** (integer) - The unique identifier of the repository.
  - **name** (string) - The name of the repository.
  - **full_name** (string) - The full name of the repository (owner/name).
  - **private** (boolean) - Indicates if the repository is private.

#### Response Example
```json
{
  "repositories": [
    {
      "id": 123456789,
      "name": "repo1",
      "full_name": "PSModule/repo1",
      "private": false
    },
    {
      "id": 987654321,
      "name": "repo2",
      "full_name": "PSModule/repo2",
      "private": true
    }
  ]
}
```

### Error Handling
- **404 Not Found**: If the organization, installation, or repositories are not found.
- **403 Forbidden**: If the authenticated app does not have the necessary permissions.
```

--------------------------------

### Get Accessible Repositories

Source: https://psmodule.io/GitHub/Functions/Apps/GitHub%20App%20Installations/Get-GitHubAppAccessibleRepository

This endpoint retrieves repositories belonging to an enterprise-owned organization that can be made accessible to a GitHub App installed on that organization. The authenticated GitHub App must be installed on the enterprise and have the necessary permissions.

```APIDOC
## GET /repos/access

### Description
Retrieves a list of repositories belonging to an enterprise-owned organization that can be made accessible to a GitHub App installed on that organization.

### Method
GET

### Endpoint
/repos/access

### Parameters
#### Query Parameters
- **enterprise** (String) - Required - The enterprise slug or ID.
- **organization** (String) - Required - The organization name. The name is not case sensitive.
- **per_page** (Int32) - Optional - The number of results per page (max 100).
- **context** (Object) - Optional - The context to run the command in. Can be either a string or a GitHubContext object.

### Request Example
```json
{
  "enterprise": "msx",
  "organization": "PSModule",
  "per_page": 50
}
```

### Response
#### Success Response (200)
- **repositories** (GitHubRepository[]) - A list of GitHubRepository objects representing accessible repositories.

#### Response Example
```json
{
  "repositories": [
    {
      "id": 12345,
      "name": "my-repo",
      "full_name": "org/my-repo",
      "private": false
    }
  ]
}
```
```

--------------------------------

### POST /repos/{owner}/{repo}/dispatches

Source: https://psmodule.io/GitHub/Functions/Repositories/Repositories/Start-GitHubRepositoryEvent

Triggers a webhook event called `repository_dispatch` to activate GitHub Actions workflows or GitHub Apps based on external activity. The `client_payload` parameter can include additional information for the workflow.

```APIDOC
## POST /repos/{owner}/{repo}/dispatches

### Description
Creates a repository dispatch event to trigger workflows or GitHub Apps based on external activity. The `client_payload` can contain extra information for the workflow.

### Method
POST

### Endpoint
`/repos/{owner}/{repo}/dispatches`

### Parameters
#### Path Parameters
- **owner** (String) - Required - The account owner of the repository.
- **repo** (String) - Required - The name of the repository without the .git extension.

#### Query Parameters
None

#### Request Body
- **event_type** (String) - Required - A custom webhook event name. Must be 100 characters or fewer.
- **client_payload** (Object) - Optional - JSON payload with extra information about the webhook event. Maximum of 10 top-level properties.

### Request Example
```json
{
  "event_type": "on-demand-test",
  "client_payload": {
    "unit": false,
    "integration": true
  }
}
```

### Response
#### Success Response (204 No Content)
This endpoint returns a 204 No Content response upon successful dispatch.

#### Response Example
(No content returned on success)
```

--------------------------------

### Get GitHub Secret Selected Repository Example

Source: https://psmodule.io/GitHub/Functions/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository

This example demonstrates how to use the Get-GitHubSecretSelectedRepository cmdlet to retrieve repositories associated with a specific secret ('hello-world') within an organization ('octocat'). It requires the Owner and Name parameters and outputs a list of selected repositories with their details.

```powershell
Get-GitHubSecretSelectedRepository -Owner 'octocat' -Name 'hello-world'
```

--------------------------------

### Command Exploration

Source: https://psmodule.io/GitHub/index

How to discover available cmdlets within the GitHub module.

```APIDOC
## GET /api/powershell/cmdlets

### Description
Retrieves a list of all available cmdlets within the installed GitHub PowerShell module.

### Method
GET

### Endpoint
/api/powershell/cmdlets

### Parameters
#### Query Parameters
- **Module** (string) - Required - Specifies the module name, which is 'GitHub' in this case.

### Request Example
```powershell
Get-Command -Module GitHub
```

### Response
#### Success Response (200)
- **Cmdlets** (array of strings) - A list of cmdlet names available in the module.

#### Response Example
```json
{
  "Cmdlets": [
    "Connect-GitHubAccount",
    "Get-GitHubRepo",
    "Submit-Issue"
  ]
}
```
```

--------------------------------

### Example: Get GitHub Team by Slug (PowerShell)

Source: https://psmodule.io/GitHub/Functions/Teams/Get-GitHubTeam

Illustrates fetching a specific team from the 'github' organization using its slug, 'my-team-name'.

```powershell
Get-GitHubTeam -Organization 'github' -Slug 'my-team-name'
```

--------------------------------

### Get Specific GitHub License Template by Name (PowerShell)

Source: https://psmodule.io/GitHub/Functions/License/Get-GitHubLicense

Fetches a specific license template from GitHub using its name or SPDX ID. For example, 'mit' or 'mpl-2.0'.

```powershell
Get-GitHubLicense -Name mit
```
Tokens:
Raw