org_secret_scanning_pattern_configurations

Creates, updates, deletes, gets or lists an org_secret_scanning_pattern_configurations resource.

Overview

Name	org_secret_scanning_pattern_configurations
Type	Resource
Id	github.secret_scanning.org_secret_scanning_pattern_configurations

Fields

The following fields are returned by SELECT queries:

list_org_pattern_configs

Response

Name	Datatype	Description
custom_pattern_overrides	array	Overrides for custom patterns defined by the organization.
pattern_config_version	string	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.
provider_pattern_overrides	array	Overrides for partner patterns.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_org_pattern_configs	select	org		Lists the secret scanning pattern configurations for an organization. Personal access tokens (classic) need the read:org scope to use this endpoint.
update_org_pattern_configs	update	org		Updates the secret scanning pattern configurations for an organization. Personal access tokens (classic) need the write:org scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.

SELECT examples

list_org_pattern_configs

Lists the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the read:org scope to use this endpoint.

SELECT
custom_pattern_overrides,
pattern_config_version,
provider_pattern_overrides
FROM github.secret_scanning.org_secret_scanning_pattern_configurations
WHERE org = '{{ org }}' -- required
;

UPDATE examples

update_org_pattern_configs

Updates the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the write:org scope to use this endpoint.

UPDATE github.secret_scanning.org_secret_scanning_pattern_configurations
SET 
pattern_config_version = '{{ pattern_config_version }}',
provider_pattern_settings = '{{ provider_pattern_settings }}',
custom_pattern_settings = '{{ custom_pattern_settings }}'
WHERE 
org = '{{ org }}' --required
RETURNING
pattern_config_version;