You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,12 +82,8 @@ After your pattern is created, {% data variables.product.prodname_secret_scannin
82
82
83
83
## Defining a custom pattern for an enterprise account
84
84
85
-
{% ifversion fpt or ghec or ghes %}
86
-
87
85
Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest/{% endif %}/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)."
88
86
89
-
{% endif %}
90
-
91
87
{% note %}
92
88
93
89
**Note:** As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire enterprise. That way, you can avoid creating excess false-positive {% data variables.product.prodname_secret_scanning %} alerts.
@@ -98,12 +94,12 @@ Before defining a custom pattern, you must ensure that you enable secret scannin
98
94
{% data reusables.enterprise-accounts.policies-tab %}
99
95
{% data reusables.enterprise-accounts.advanced-security-policies %}
100
96
{% data reusables.enterprise-accounts.advanced-security-security-features %}
101
-
1. Under "Secret scanning custom patterns", click {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %}**New pattern**{% elsif ghes = 3.2 %}**New custom pattern**{% endif %}.
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
103
99
104
100
After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
105
101
106
-
{% ifversion fpt or ghes > 3.2 or ghec %}
102
+
{% ifversion fpt or ghes > 3.2 or ghec or ghae %}
107
103
## Editing a custom pattern
108
104
109
105
When you save a change to a custom pattern, this closes all the {% data variables.product.prodname_secret_scanning %} alerts that were created using the previous version of the pattern.
@@ -120,7 +116,7 @@ When you save a change to a custom pattern, this closes all the {% data variable
120
116
121
117
* For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above.
122
118
* For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above.
123
-
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
119
+
{%- ifversion fpt or ghes > 3.2 or ghae %}
124
120
1. To the right of the custom pattern you want to remove, click {% octicon "trash" aria-label="The trash icon" %}.
125
121
1. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern.
Copy file name to clipboardExpand all lines: content/rest/reference/secret-scanning.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,12 @@ miniTocMaxHeadingLevel: 3
11
11
12
12
{% data reusables.secret-scanning.api-beta %}
13
13
14
-
The {% data variables.product.prodname_secret_scanning %} API lets you retrieve and update secret scanning alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For more information on secret scanning, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)."
14
+
The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %}:
15
+
16
+
- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation.
17
+
- Retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For futher details, see the sections below.
18
+
{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository.{% endif %}
19
+
20
+
For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)."
0 commit comments