GitHub: Update organization pattern configurations

← Secret scanning operations · Get started

Operation github.secret_scanning_update_org_pattern_configs

Provider route: PATCH /orgs/{org}/secret-scanning/pattern-configurations. 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["secretScanning"]["secretScanningUpdateOrgPatternConfigs"]>[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.secretScanning.secretScanningUpdateOrgPatternConfigs(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.secret_scanning.secret_scanning_update_org_pattern_configs(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.custom_pattern_settings	array	Optional	Pattern settings for custom patterns.
body.custom_pattern_settings[]	object	Each item
body.custom_pattern_settings[].custom_pattern_version	Model	Optional	Expand Update a repository custom pattern — response body — custom pattern version
body.custom_pattern_settings[].push_protection_setting	string	Optional	Push protection setting to set for the pattern. One of: disabled, enabled
body.custom_pattern_settings[].token_type	string	Optional	The ID of the pattern to configure.
body.pattern_config_version	Model	Optional	Expand Update a repository custom pattern — response body — custom pattern version
body.provider_pattern_settings	array	Optional	Pattern settings for provider patterns.
body.provider_pattern_settings[]	object	Each item
body.provider_pattern_settings[].push_protection_setting	string	Optional	Push protection setting to set for the pattern. One of: not-set, disabled, enabled
body.provider_pattern_settings[].token_type	string	Optional	The ID of the pattern to configure.

Referenced models: Update a repository custom pattern — response body — custom pattern version

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
$	object	Root
pattern_config_version	string	Optional	The updated pattern configuration version.

Schemas

Update a repository custom pattern — response body — custom pattern version

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.secret_scanning_update_org_pattern_configs. Catalog operation: secret-scanning/update-org-pattern-configs. 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