Sonatype GitHub App Configuration API

openapi: 3.2.0
info:
  title: Sonatype GitHub App Configuration API
  version: '1.0'
  description: 'Operations tagged GitHub App Configuration across 2 of this provider''s published API definitions: sonatype-lifecycle-openapi.yml, sonatype-iq-openapi.yml. Each path carries the servers of the definition it was published in.'
security:
- BasicAuth: []
  BearerAuth: []
tags:
- description: GitHub App configuration operations
  name: GitHub App Configuration
paths:
  /api/v2/githubApp/manifest:
    post:
      description: 'Generate a GitHub App manifest for registration. Returns manifest JSON with a state token for CSRF protection. The state token is cryptographically secure, single-use, and expires after 10 minutes. Submit the manifest to GitHub''s app creation flow, which will redirect back to IQ Server with the state token for validation.


        **Permissions Required:** Configure System Configuration and Users'
      operationId: generateManifest
      parameters:
      - description: Owner (organization/application) ID
        in: query
        name: ownerId
        required: true
        schema:
          minLength: 1
          type: string
      - description: GitHub organization name
        in: query
        name: organizationName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Manifest generated successfully
        '400':
          description: Missing owner id or organization name
        '500':
          description: Base URL not configured or invalid request
      summary: Generate GitHub App manifest
      tags:
      - GitHub App Configuration
  /api/v2/githubApp/redirect:
    get:
      description: Handles redirect from GitHub after manifest submission. Exchanges temporary code for permanent app credentials. The user's browser is automatically redirected here by GitHub - not intended for direct use. **Permissions Required:** Configure System Configuration and Users
      operationId: handleRedirect
      parameters:
      - description: Temporary manifest conversion code from GitHub
        in: query
        name: code
        required: true
        schema:
          type: string
      - description: OAuth state token for CSRF protection
        in: query
        name: state
        schema:
          type: string
      responses:
        '303':
          description: Successfully registered GitHub App, redirecting to settings page
        '400':
          description: Invalid or expired code
        '401':
          description: Authentication required
        '403':
          description: Insufficient permissions
      summary: GitHub App registration redirect callback
      tags:
      - GitHub App Configuration
  /api/v2/githubApp/setupInstallation:
    get:
      description: Process the redirect from GitHub after OAuth authorization, validate state token, exchange OAuth code with PKCE verification, verify user ownership, configure the installation for the specified organization/application, and redirect to the configuration page
      operationId: handleInstallationSetup
      parameters:
      - description: GitHub App installation ID
        in: query
        name: installation_id
        required: true
        schema:
          format: int64
          minimum: 1
          type: integer
      - description: State token for CSRF protection
        in: query
        name: state
        required: true
        schema:
          minLength: 1
          type: string
      - description: OAuth authorization code
        in: query
        name: code
        required: true
        schema:
          minLength: 1
          type: string
      responses:
        '302':
          description: Redirect to source control configuration page
        '400':
          description: Invalid or missing parameters
        '500':
          description: Failed to configure GitHub App installation
      summary: Handle GitHub App installation setup callback with OAuth + PKCE
      tags:
      - GitHub App Configuration
  /api/v2/githubApp/{githubAppId}:
    delete:
      tags:
      - GitHub App Configuration
      summary: Delete a GitHub App
      description: 'Deletes a specific GitHub App by its ID. Validates ownership before deletion. Best-effort cleanup of the GitHub installation via API.


        **Permissions Required:** Configure System Configuration and Users'
      operationId: deleteGitHubApp
      parameters:
      - name: githubAppId
        in: path
        description: GitHub App ID
        required: true
        schema:
          type: string
      - name: ownerId
        in: query
        description: Owner (organization/application) ID
        required: true
        schema:
          minLength: 1
          type: string
      responses:
        '204':
          description: GitHub App deleted successfully
        '404':
          description: GitHub App not found for specified owner
  /api/v2/githubApp:
    get:
      tags:
      - GitHub App Configuration
      summary: List GitHub Apps for an owner
      description: 'Returns all GitHub Apps directly registered at this owner level. Does not include inherited apps from parent organizations.


        **Permissions Required:** View IQ Elements'
      operationId: listGitHubApps
      parameters:
      - name: ownerId
        in: query
        description: Owner (organization/application) ID
        required: true
        schema:
          minLength: 1
          type: string
      responses:
        '200':
          description: List of GitHub Apps
components:
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
x-refined-from:
- sonatype-lifecycle-openapi.yml
- sonatype-iq-openapi.yml