GitHub: List organization pattern configurations

GitHub secretScanning.secretScanningListOrgPatternConfigs: arguments, response, policy and SDK examples.

← Secret scanning operations · Get started

Operation github.secret_scanning_list_org_pattern_configs

Provider route: GET /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"]["secretScanningListOrgPatternConfigs"]>[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.secretScanningListOrgPatternConfigs(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_list_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

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 List organization pattern configurations — response body

Referenced models: List organization pattern configurations — response body

Schemas

List organization pattern configurations — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A collection of secret scanning patterns and their settings related to push protection.
`custom_pattern_overrides`	array	Optional	Overrides for custom patterns defined by the organization.
`custom_pattern_overrides[]`	Model	Each item	Expand List organization pattern configurations — response body — custom pattern overrides item
`pattern_config_version`	Model	Optional	Expand Update a repository custom pattern — response body — custom pattern version
`provider_pattern_overrides`	array	Optional	Overrides for partner patterns.
`provider_pattern_overrides[]`	Model	Each item	Expand List organization pattern configurations — response body — custom pattern overrides item

Referenced models: List organization pattern configurations — response body — custom pattern overrides item, Update a repository custom pattern — response body — custom pattern version

List organization pattern configurations — response body — custom pattern overrides item

Field	Type	Presence	Description and constraints
`$`	object	Root
`alert_total`	JSON	Optional
`alert_total (anyOf 1)`	integer	Alternative	The total number of alerts generated by this pattern.
`alert_total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`alert_total_percentage`	JSON	Optional
`alert_total_percentage (anyOf 1)`	integer	Alternative	The percentage of all alerts that this pattern represents, rounded to the nearest integer.
`alert_total_percentage (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`bypass_rate`	JSON	Optional
`bypass_rate (anyOf 1)`	integer	Alternative	The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer.
`bypass_rate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`custom_pattern_version`	JSON	Optional
`custom_pattern_version (anyOf 1)`	string	Alternative	The version of this pattern if it's a custom pattern.
`custom_pattern_version (anyOf 2)`	null	Alternative
`default_setting`	string	Optional	The default push protection setting for this pattern. Known values: disabled, enabled
`display_name`	string	Optional	The user-friendly name for the pattern.
`enterprise_setting`	JSON	Optional
`enterprise_setting (anyOf 1)`	string	Alternative	The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. Known values: not-set, disabled, enabled
`enterprise_setting (anyOf 2)`	null	Alternative
`false_positive_rate`	JSON	Optional
`false_positive_rate (anyOf 1)`	integer	Alternative	The percentage of alerts from this pattern that are false positives, rounded to the nearest integer.
`false_positive_rate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`false_positives`	JSON	Optional
`false_positives (anyOf 1)`	integer	Alternative	The number of false positive alerts generated by this pattern.
`false_positives (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`setting`	string	Optional	The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. Known values: not-set, disabled, enabled
`slug`	string	Optional	The slug of the pattern.
`token_type`	string	Optional	The ID of the pattern.

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_list_org_pattern_configs. Catalog operation: secret-scanning/list-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

Report an issue with this page