VCS Integrations

ClaimGitHubIntegration

Links an existing, unlinked Pulumi GitHub App installation (for example one installed directly from the GitHub Marketplace) to the organization. The caller must be able to update organization integrations, and must control the installation on the GitHub side, verified via the caller's GitHub identity (their GitHub OAuth token, or a matching GitHub account for the user or organization). Idempotent when the installation is already linked to this organization. Returns 409 if the installation is linked to a different organization; contact support to move an installation between organizations.

post/api/console/orgs/{orgName}/integrations/github/claim

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/console/orgs/{orgName}/integrations/github/claim
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

Request body

installationIdinteger required

The numeric GitHub App installation ID to link, as assigned by GitHub.

Response

OK

accountIDinteger

The GitHub account ID (user or org).

accountNamestring

The GitHub account name (login).

avatarUrlstring

The avatar URL of the GitHub account.

createdstring date-time

When the installation was created.

disableCodeAccessForReviewsboolean required

Whether code access for AI reviews is disabled for this installation.

disableDetailedDiffboolean required

Whether detailed property-level diffs are disabled for PR comments.

disableDraftPRCommentsboolean

Whether PR comments are disabled while a pull request is in draft.

disableNeoSummariesboolean required

Whether Neo AI summaries are disabled for this installation.

disablePRCommentsboolean required

Whether PR comments are disabled for this installation.

hasContentsPermissionboolean required

Whether the installation has the 'contents' permission.

hasMembersPermissionboolean required

Whether the installation has the 'members' permission (only relevant for organization accounts).

idstring required

The Pulumi ID of the GitHub App installation.

individualAuthEnabledboolean

Whether per-user (individual) GitHub Enterprise authentication is enabled. Only applies to self-hosted GitHub Enterprise installations.

installationIDinteger required

The GitHub installation ID.

isOrganizationboolean required

Whether the GitHub account is an organization (as opposed to a personal account).

isSelfHostedboolean required

Whether this is a self-hosted GitHub Enterprise installation.

Changes

No recorded changes to this operation across all 1 revision of this API.