GitHub: Update the AI Scan setting for an organization

← Code scanning operations · Get started

Operation github.code_scanning_update_ai_scan_enablement_for_org

Provider route: PATCH /orgs/{org}/code-scanning/ai-scan. 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["codeScanning"]["codeScanningUpdateAiScanEnablementForOrg"]>[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.codeScanning.codeScanningUpdateAiScanEnablementForOrg(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.code_scanning.code_scanning_update_ai_scan_enablement_for_org(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	Model	Required within parent	Expand Update the AI Scan setting for an organization — request body — body

Referenced models: Update the AI Scan setting for an organization — request body — body

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 Get the AI Scan setting for an organization — response body

Referenced models: Get the AI Scan setting for an organization — response body

Schemas

Get the AI Scan setting for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	The AI Scan organization setting
pr_scan	string	Required within parent	Whether AI Scan on pull requests is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable AI Scan; when enabled, repositories can still opt out. Known values: enabled, disabled

Update the AI Scan setting for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The AI Scan organization setting to apply Minimum fields: 1 Additional keys: not allowed
pr_scan	string	Optional	Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out. One of: enabled, disabled

Policy, approvals and errors

SDK function policy ID: github.code_scanning_update_ai_scan_enablement_for_org. Catalog operation: code-scanning/update-ai-scan-enablement-for-org. 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