Method: projects.locations.connections.fetchGitHubInstallations

connections.fetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection. For github.com, only installations accessible to the authorizer token are returned. For GitHub Enterprise, all installations are returned.

HTTP request

GET https://developerconnect.googleapis.com/v1/{connection=projects/*/locations/*/connections/*}:fetchGitHubInstallations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
connection

string

Required. The resource name of the connection in the format projects/*/locations/*/connections/*.

Request body

The request body must be empty.

Response body

Response of fetching github installations.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "installations": [
    {
      object (Installation)
    }
  ]
}
Fields
installations[]

object (Installation)

List of installations available to the OAuth user (for github.com) or all the installations (for GitHub enterprise).

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the connection resource:

  • developerconnect.connections.fetchGitHubInstallations

For more information, see the IAM documentation.

Installation

Represents an installation of the GitHub App.

JSON representation 
{
  "id": string,
  "name": string,
  "type": string
}
Fields
id

string (int64 format)

ID of the installation in GitHub.
name

string

Name of the GitHub user or organization that owns this installation.
type

string

Either "user" or "organization".