SecretScanningAlerts
Lists secret scanning alerts for the repository.
Table-Specific Information
Select
The connector uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
- Number supports the '=' comparison operator.
- State supports the '=' comparison operator.
- Resolution supports the '=,IN' comparison operators.
- SecretType supports the '=,IN' comparison operators.
- Validity supports the '=,IN' comparison operators.
- PubliclyLeaked supports the '=' comparison operator.
- MultiRepo supports the '=' comparison operator.
- HideSecret supports the '=' comparison operator.
For example, the following queries are processed server-side:
SELECT * FROM [SecretScanningAlerts]
SELECT * FROM [SecretScanningAlerts] WHERE [Number] = 123
SELECT * FROM [SecretScanningAlerts] WHERE [State] = 'open'
SELECT * FROM [SecretScanningAlerts] WHERE [Resolution] = 'false_positive'
SELECT * FROM [SecretScanningAlerts] WHERE [SecretType] = 'Val1'
SELECT * FROM [SecretScanningAlerts] WHERE [Validity] = 'active'
SELECT * FROM [SecretScanningAlerts] WHERE [PubliclyLeaked] = true
SELECT * FROM [SecretScanningAlerts] WHERE [MultiRepo] = true
SELECT * FROM [SecretScanningAlerts] WHERE [HideSecret] = true
The connector processes other filters client-side within the connector.
The connector uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
- CreatedAt
- UpdatedAt
SELECT * FROM [SecretScanningAlerts] ORDER BY [CreatedAt]
SELECT * FROM [SecretScanningAlerts] ORDER BY [UpdatedAt]
The connector processes ordering by other columns client-side within the connector.
Update
You can use the following columns to update a record:
- Number
- State
- Resolution
- ResolutionComment
UPDATE [SecretScanningAlerts] SET [State] = 'resolved', [Resolution] = 'used_in_tests', [ResolutionComment] = 'Used in tests.' WHERE [Number] = '1'
Columns
| Name | Type | ReadOnly | References | Description |
| Number [KEY] | Int | True |
The security alert number. | |
| Url | String | True |
The REST API URL for fetching the alert. | |
| HtmlUrl | String | True |
The GitHub URL for viewing the alert. | |
| LocationsUrl | String | True |
The REST API URL for fetching the list of locations for this alert. | |
| State | String | False |
Sets the state of the secret scanning alert. | |
| Resolution | String | False |
Required when state is resolved. The reason for resolving the alert. | |
| ResolutionComment | String | False |
An optional comment when closing or reopening an alert. | |
| ResolvedAt | Datetime | True |
The time that the alert was resolved. | |
| ResolvedByLogin | String | True |
The username of the user that resolved the alert. | |
| SecretType | String | True |
The type of secret that secret scanning detected. | |
| SecretTypeDisplayName | String | True |
User-friendly name for the detected secret type. | |
| Secret | String | True |
The secret that was detected. | |
| IsBase64Encoded | Bool | True |
Whether the secret is in base64 encoding. | |
| Validity | String | True |
The token status as of the latest validity check. | |
| PubliclyLeaked | Bool | True |
Whether the secret is publicly available online. | |
| MultiRepo | Bool | True |
Whether the secret was detected in multiple repositories. | |
| PushProtectionBypassed | Bool | True |
Whether push protection was bypassed for the detected secret. | |
| PushProtectionBypassedAt | Datetime | True |
The time that push protection was bypassed. | |
| PushProtectionBypassedByLogin | String | True |
The username of the user that bypassed push protection. | |
| PushProtectionBypassRequestReviewerLogin | String | True |
The username of the user requested to review the bypass. | |
| PushProtectionBypassRequestReviewerComment | String | True |
The comment provided by the bypass reviewer. | |
| PushProtectionBypassRequestComment | String | True |
The comment provided when requesting a bypass. | |
| PushProtectionBypassRequestHtmlUrl | String | True |
The GitHub URL for the bypass request. | |
| FirstLocationPath | String | True |
The file path where the secret was first detected. | |
| FirstLocationStartLine | Int | True |
Line number at which the secret starts in the file. | |
| FirstLocationEndLine | Int | True |
Line number at which the secret ends in the file. | |
| FirstLocationStartColumn | Int | True |
Column at which the secret starts in the file. | |
| FirstLocationEndColumn | Int | True |
Column at which the secret ends in the file. | |
| FirstLocationBlobSha | String | True |
SHA of the blob containing the secret. | |
| FirstLocationBlobUrl | String | True |
API URL of the blob containing the secret. | |
| FirstLocationCommitSha | String | True |
SHA of the commit containing the secret. | |
| FirstLocationCommitUrl | String | True |
API URL of the commit containing the secret. | |
| HasMoreLocations | Bool | True |
Whether the alert has additional locations beyond the first. | |
| AssignedToLogin | String | True |
The username of the user assigned to the alert. | |
| CreatedAt | Datetime | True |
The time that the alert was created. | |
| UpdatedAt | Datetime | True |
The time that the alert was updated. | |
| HideSecret | Bool | True |
Whether or not to hide literal secrets in the results. |