GitHub: Register an app installation for external custom properties

← Orgs operations · Get started

Operation github.orgs_external_properties_for_repos_register_organization_app_installation

Provider route: POST /orgs/{org}/properties/installations. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["orgs"]["orgsExternalPropertiesForReposRegisterOrganizationAppInstallation"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.orgs.orgsExternalPropertiesForReposRegisterOrganizationAppInstallation(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.orgs.orgs_external_properties_for_repos_register_organization_app_installation(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.org	string	Required within parent
body	object	Required within parent
body.display_name	string	Required within parent	The display name for this app installation’s external custom properties in the organization. Must be 1 to 15 characters and contain only letters and numbers. Capitalization is preserved as entered. This can’t be changed after the app installation is registered. Maximum length: 15 Minimum length: 1 Pattern: ^[a-zA-Z0-9]+$
body.installation_id	integer	Optional	The unique identifier of the GitHub App installation to register for managing external custom properties. When authenticating as a GitHub App installation, this defaults to the authenticated installation and can be omitted. It is required for all other callers (users and fine-grained personal access tokens).

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Register an app installation for external custom properties — response body

Referenced models: Register an app installation for external custom properties — response body

Schemas

Register an app installation for external custom properties — response body

Field	Type	Presence	Description and constraints
$	object	Root	A GitHub App installation that has been registered to read and write an organization's external custom properties, together with the display name assigned to it.
display_name	string	Required within parent	The display name assigned to the app installation's external custom properties in the organization.
installation	object	Required within parent	The GitHub App installation that was registered.
installation.id	JSON	Required within parent
installation.id (anyOf 1)	integer	Alternative	The unique identifier of the GitHub App installation.
installation.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.orgs_external_properties_for_repos_register_organization_app_installation. Catalog operation: orgs/external-properties-for-repos-register-organization-app-installation. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source