---
title: "GitHubAppInstallationAuth"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/GitHubAppInstallationAuth"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# GitHubAppInstallationAuth

Defines the GitHub App authorization strategy used by the GitHub integration. This strategy enables secure access to GitHub APIs using app installation tokens. It supports both API-based interactions and real-time event delivery via GitHub webhooks. Unlike standard OAuth flows, this strategy leverages GitHub's custom app installation flow and token lifecycle, making it ideal for deep, organization-level GitHub integration.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    GitHubAppInstallationAuth:
      type: object
      description: >
        Defines the GitHub App authorization strategy used by the GitHub
        integration.

        This strategy enables secure access to GitHub APIs using app
        installation tokens.

        It supports both API-based interactions and real-time event delivery via
        GitHub webhooks.

        Unlike standard OAuth flows, this strategy leverages GitHub's custom app
        installation flow

        and token lifecycle, making it ideal for deep, organization-level GitHub
        integration.
      required:
        - type
        - config
      properties:
        type:
          type: string
          enum:
            - github_app_installation
          x-terraform-transform-const: true
        config:
          type: object
          required:
            - app_install_url
            - app_manage_url
            - authorize_app_installation_endpoint
            - pending_app_installs_endpoint
          properties:
            app_install_url:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/install
                  description: >
                    The URL where customers are directed to install the GitHub
                    App into their

                    GitHub organization.
            app_manage_url:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/manage
                  description: The GitHub App management page URL where users can view, configure,
                    or uninstall the app after installation.
            authorize_app_installation_endpoint:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/authorize-installation
                  description: >
                    The endpoint used to link a completed GitHub App
                    installation with a customer account in the catalog.

                    This step finalizes the integration by exchanging metadata
                    from the GitHub installation event.
            pending_app_installs_endpoint:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/pending-installs
                  description: >
                    The endpoint used to return a list of in-progress or
                    unlinked GitHub App installations awaiting user
                    confirmation.
```