{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/main/json-schema/github-organization-secret-scanning-alert-schema.json",
  "title": "organization-secret-scanning-alert",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/github-secret-scanning-api-openapi.yml#/components/schemas/organization-secret-scanning-alert",
  "type": "object",
  "properties": {
    "number": {
      "$ref": "#/$defs/alert-number"
    },
    "created_at": {
      "$ref": "#/$defs/alert-created-at"
    },
    "updated_at": {
      "$ref": "#/$defs/nullable-alert-updated-at"
    },
    "url": {
      "$ref": "#/$defs/alert-url"
    },
    "html_url": {
      "$ref": "#/$defs/alert-html-url"
    },
    "locations_url": {
      "type": "string",
      "format": "uri",
      "description": "The REST API URL of the code locations for this alert."
    },
    "state": {
      "$ref": "#/$defs/secret-scanning-alert-state"
    },
    "resolution": {
      "$ref": "#/$defs/secret-scanning-alert-resolution"
    },
    "resolved_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
    },
    "resolved_by": {
      "$ref": "#/$defs/nullable-simple-user"
    },
    "secret_type": {
      "type": "string",
      "description": "The type of secret that secret scanning detected."
    },
    "secret_type_display_name": {
      "type": "string",
      "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\""
    },
    "secret": {
      "type": "string",
      "description": "The secret that was detected."
    },
    "repository": {
      "$ref": "#/$defs/simple-repository"
    },
    "push_protection_bypassed": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether push protection was bypassed for the detected secret."
    },
    "push_protection_bypassed_by": {
      "$ref": "#/$defs/nullable-simple-user"
    },
    "push_protection_bypassed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
    },
    "resolution_comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "The comment that was optionally added when this alert was closed"
    }
  },
  "$defs": {
    "alert-created-at": {
      "type": "string",
      "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "alert-html-url": {
      "type": "string",
      "description": "The GitHub URL of the alert resource.",
      "format": "uri",
      "readOnly": true
    },
    "alert-number": {
      "type": "integer",
      "description": "The security alert number.",
      "readOnly": true
    },
    "alert-url": {
      "type": "string",
      "description": "The REST API URL of the alert resource.",
      "format": "uri",
      "readOnly": true
    },
    "nullable-alert-updated-at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "nullable-simple-user": {
      "title": "Simple User",
      "description": "A GitHub user.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "login": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "node_id": {
          "type": "string"
        },
        "avatar_url": {
          "type": "string",
          "format": "uri"
        },
        "gravatar_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "followers_url": {
          "type": "string",
          "format": "uri"
        },
        "following_url": {
          "type": "string"
        },
        "gists_url": {
          "type": "string"
        },
        "starred_url": {
          "type": "string"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri"
        },
        "repos_url": {
          "type": "string",
          "format": "uri"
        },
        "events_url": {
          "type": "string"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri"
        },
        "type": {
          "type": "string"
        },
        "site_admin": {
          "type": "boolean"
        },
        "starred_at": {
          "type": "string"
        }
      },
      "required": [
        "avatar_url",
        "events_url",
        "followers_url",
        "following_url",
        "gists_url",
        "gravatar_id",
        "html_url",
        "id",
        "node_id",
        "login",
        "organizations_url",
        "received_events_url",
        "repos_url",
        "site_admin",
        "starred_url",
        "subscriptions_url",
        "type",
        "url"
      ]
    },
    "secret-scanning-alert-resolution": {
      "type": [
        "string",
        "null"
      ],
      "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.",
      "enum": [
        "false_positive",
        "wont_fix",
        "revoked",
        "used_in_tests"
      ]
    },
    "secret-scanning-alert-state": {
      "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
      "type": "string",
      "enum": [
        "open",
        "resolved"
      ]
    },
    "simple-repository": {
      "title": "Simple Repository",
      "description": "A GitHub repository.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "A unique identifier of the repository."
        },
        "node_id": {
          "type": "string",
          "description": "The GraphQL identifier of the repository."
        },
        "name": {
          "type": "string",
          "description": "The name of the repository."
        },
        "full_name": {
          "type": "string",
          "description": "The full, globally unique, name of the repository."
        },
        "owner": {
          "$ref": "#/$defs/simple-user"
        },
        "private": {
          "type": "boolean",
          "description": "Whether the repository is private."
        },
        "html_url": {
          "type": "string",
          "format": "uri",
          "description": "The URL to view the repository on GitHub.com."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The repository description."
        },
        "fork": {
          "type": "boolean",
          "description": "Whether the repository is a fork."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "The URL to get more information about the repository from the GitHub API."
        },
        "archive_url": {
          "type": "string",
          "description": "A template for the API URL to download the repository as an archive."
        },
        "assignees_url": {
          "type": "string",
          "description": "A template for the API URL to list the available assignees for issues in the repository."
        },
        "blobs_url": {
          "type": "string",
          "description": "A template for the API URL to create or retrieve a raw Git blob in the repository."
        },
        "branches_url": {
          "type": "string",
          "description": "A template for the API URL to get information about branches in the repository."
        },
        "collaborators_url": {
          "type": "string",
          "description": "A template for the API URL to get information about collaborators of the repository."
        },
        "comments_url": {
          "type": "string",
          "description": "A template for the API URL to get information about comments on the repository."
        },
        "commits_url": {
          "type": "string",
          "description": "A template for the API URL to get information about commits on the repository."
        },
        "compare_url": {
          "type": "string",
          "description": "A template for the API URL to compare two commits or refs."
        },
        "contents_url": {
          "type": "string",
          "description": "A template for the API URL to get the contents of the repository."
        },
        "contributors_url": {
          "type": "string",
          "format": "uri",
          "description": "A template for the API URL to list the contributors to the repository."
        },
        "deployments_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the deployments of the repository."
        },
        "downloads_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the downloads on the repository."
        },
        "events_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the events of the repository."
        },
        "forks_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the forks of the repository."
        },
        "git_commits_url": {
          "type": "string",
          "description": "A template for the API URL to get information about Git commits of the repository."
        },
        "git_refs_url": {
          "type": "string",
          "description": "A template for the API URL to get information about Git refs of the repository."
        },
        "git_tags_url": {
          "type": "string",
          "description": "A template for the API URL to get information about Git tags of the repository."
        },
        "issue_comment_url": {
          "type": "string",
          "description": "A template for the API URL to get information about issue comments on the repository."
        },
        "issue_events_url": {
          "type": "string",
          "description": "A template for the API URL to get information about issue events on the repository."
        },
        "issues_url": {
          "type": "string",
          "description": "A template for the API URL to get information about issues on the repository."
        },
        "keys_url": {
          "type": "string",
          "description": "A template for the API URL to get information about deploy keys on the repository."
        },
        "labels_url": {
          "type": "string",
          "description": "A template for the API URL to get information about labels of the repository."
        },
        "languages_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get information about the languages of the repository."
        },
        "merges_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to merge branches in the repository."
        },
        "milestones_url": {
          "type": "string",
          "description": "A template for the API URL to get information about milestones of the repository."
        },
        "notifications_url": {
          "type": "string",
          "description": "A template for the API URL to get information about notifications on the repository."
        },
        "pulls_url": {
          "type": "string",
          "description": "A template for the API URL to get information about pull requests on the repository."
        },
        "releases_url": {
          "type": "string",
          "description": "A template for the API URL to get information about releases on the repository."
        },
        "stargazers_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the stargazers on the repository."
        },
        "statuses_url": {
          "type": "string",
          "description": "A template for the API URL to get information about statuses of a commit."
        },
        "subscribers_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the subscribers on the repository."
        },
        "subscription_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to subscribe to notifications for this repository."
        },
        "tags_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get information about tags on the repository."
        },
        "teams_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the teams on the repository."
        },
        "trees_url": {
          "type": "string",
          "description": "A template for the API URL to create or retrieve a raw Git tree of the repository."
        },
        "hooks_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to list the hooks on the repository."
        }
      },
      "required": [
        "archive_url",
        "assignees_url",
        "blobs_url",
        "branches_url",
        "collaborators_url",
        "comments_url",
        "commits_url",
        "compare_url",
        "contents_url",
        "contributors_url",
        "deployments_url",
        "description",
        "downloads_url",
        "events_url",
        "fork",
        "forks_url",
        "full_name",
        "git_commits_url",
        "git_refs_url",
        "git_tags_url",
        "hooks_url",
        "html_url",
        "id",
        "node_id",
        "issue_comment_url",
        "issue_events_url",
        "issues_url",
        "keys_url",
        "labels_url",
        "languages_url",
        "merges_url",
        "milestones_url",
        "name",
        "notifications_url",
        "owner",
        "private",
        "pulls_url",
        "releases_url",
        "stargazers_url",
        "statuses_url",
        "subscribers_url",
        "subscription_url",
        "tags_url",
        "teams_url",
        "trees_url",
        "url"
      ]
    },
    "simple-user": {
      "title": "Simple User",
      "description": "A GitHub user.",
      "type": "object",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "login": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "node_id": {
          "type": "string"
        },
        "avatar_url": {
          "type": "string",
          "format": "uri"
        },
        "gravatar_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "followers_url": {
          "type": "string",
          "format": "uri"
        },
        "following_url": {
          "type": "string"
        },
        "gists_url": {
          "type": "string"
        },
        "starred_url": {
          "type": "string"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri"
        },
        "repos_url": {
          "type": "string",
          "format": "uri"
        },
        "events_url": {
          "type": "string"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri"
        },
        "type": {
          "type": "string"
        },
        "site_admin": {
          "type": "boolean"
        },
        "starred_at": {
          "type": "string"
        }
      },
      "required": [
        "avatar_url",
        "events_url",
        "followers_url",
        "following_url",
        "gists_url",
        "gravatar_id",
        "html_url",
        "id",
        "node_id",
        "login",
        "organizations_url",
        "received_events_url",
        "repos_url",
        "site_admin",
        "starred_url",
        "subscriptions_url",
        "type",
        "url"
      ]
    }
  }
}