> ## Documentation Index
> Fetch the complete documentation index at: https://bloodhound.specterops.io/llms.txt
> Use this file to discover all available pages before exploring further.

# GH_SecretScanningAlert

> A GitHub Advanced Security alert indicating a secret was accidentally committed to a repository

<img noZoom src="https://mintcdn.com/specterops/tTIczgde9H07oLXf/assets/enterprise-AND-community-edition-pill-tag.svg?fit=max&auto=format&n=tTIczgde9H07oLXf&q=85&s=ad49a576589f4d2a8081df77d07fdf56" alt="Applies to BloodHound Enterprise and CE" width="482" height="45" data-path="assets/enterprise-AND-community-edition-pill-tag.svg" />

## General Information

Represents a GitHub secret scanning alert detected in a repository. Secret scanning alerts are raised when GitHub detects a known secret pattern (such as an API key, token, or credential) committed to a repository. The alert captures the secret type, validity status, and current resolution state.

## Properties

| Property | Type | Description |
| - | - | - |
| `name` | `string` | The node name used for matching and display. |
| `displayname` | `string` | The human-readable display name. |
| `environmentid` | `string` | The identifier of the GitHub environment where this node was collected. |
| `last_seen` | `datetime` | The timestamp when this node was last observed during collection. |
| `node_id` | `string` | The stable identifier used as the OpenGraph node ID; this is the native GitHub node ID where available. |
| `repository_name` | `string` | The name of the repository where the secret was detected. |
| `secret_type` | `string` | The type of secret detected (e.g., `github_personal_access_token`, `aws_access_key_id`). |
| `secret_type_display_name` | `string` | A human-readable name for the secret type. |
| `validity` | `string` | The validity status of the detected secret (e.g., `active`, `inactive`, `unknown`). |
| `state` | `string` | The alert state (e.g., `open`, `resolved`). |
| `url` | `string` | The HTML URL to view the alert on GitHub. |
| `query_repository` | `string` | Query for repository. |
| `query_alert_viewers` | `string` | Query for alert viewers. |

## Diagram

```mermaid theme={null}
graph LR
    n0["GH_OrgRole"]
    n1["GH_SecretScanningAlert"]
    n2["GH_Organization"]
    n3["GH_RepoRole"]
    n4["GH_Repository"]
    n5["GH_User"]
    n0 -->|GH_CanReadSecretScanningAlert| n1
    n2 -.->|GH_Contains| n1
    n3 -->|GH_CanReadSecretScanningAlert| n1
    n4 -.->|GH_Contains| n1
    n1 -->|GH_ValidToken| n5
```

## Edges

<Note>
  The tables below list edges defined by the GitHub extension only. Additional edges to or from this node may be created by other extensions.
</Note>

```mermaid theme={null}
flowchart LR

    GH_Organization["GH_Organization"]
    GH_OrgRole["GH_OrgRole"]
    GH_RepoRole["GH_RepoRole"]
    GH_Repository["GH_Repository"]
    GH_SecretScanningAlert["GH_SecretScanningAlert"]
    GH_User["GH_User"]
    GH_Organization -- GH_Contains --> GH_SecretScanningAlert
    GH_OrgRole -- GH_CanReadSecretScanningAlert --> GH_SecretScanningAlert
    GH_RepoRole -- GH_CanReadSecretScanningAlert --> GH_SecretScanningAlert
    GH_Repository -- GH_Contains --> GH_SecretScanningAlert
    GH_SecretScanningAlert -- GH_ValidToken --> GH_User
```

### Inbound Edges

| Edge Type | Source Node Types | Traversable |
| - | - | - |
| [GH\_CanReadSecretScanningAlert](/opengraph/extensions/github/edges/gh_canreadsecretscanningalert) | [GH\_OrgRole](/opengraph/extensions/github/nodes/gh_orgrole), [GH\_RepoRole](/opengraph/extensions/github/nodes/gh_reporole) | ✅ |
| [GH\_Contains](/opengraph/extensions/github/edges/gh_contains) | [GH\_Organization](/opengraph/extensions/github/nodes/gh_organization), [GH\_Repository](/opengraph/extensions/github/nodes/gh_repository) | ❌ |

### Outbound Edges

| Edge Type | Destination Node Types | Traversable |
| - | - | - |
| [GH\_ValidToken](/opengraph/extensions/github/edges/gh_validtoken) | [GH\_User](/opengraph/extensions/github/nodes/gh_user) | ✅ |

## Properties

| Property | Type | Description |
| - | - | - |
| `name` | `str` | - |
| `displayname` | `str` | - |
| `environmentid` | `str` | - |
| `last_seen` | `datetime` | - |
| `node_id` | `str` | - |
| `repository_name` | `str \| None` | The name of the repository where the secret was detected. |
| `secret_type` | `str \| None` | The type of secret detected (e.g., `github_personal_access_token`, `aws_access_key_id`). |
| `secret_type_display_name` | `str \| None` | A human-readable name for the secret type. |
| `validity` | `str \| None` | The validity status of the detected secret (e.g., `active`, `inactive`, `unknown`). |
| `state` | `str \| None` | The alert state (e.g., `open`, `resolved`). |
| `url` | `str \| None` | The HTML URL to view the alert on GitHub. |
| `query_repository` | `str \| None` | Query for repository. |
| `query_alert_viewers` | `str \| None` | Query for alert viewers. |
