Struct SecretScanningAlert

Source

pub struct SecretScanningAlert {Show 17 fields
    pub created_at: DateTime<Utc>,
    pub html_url: String,
    pub locations_url: Option<String>,
    pub number: i64,
    pub push_protection_bypassed: Option<bool>,
    pub push_protection_bypassed_at: Option<DateTime<Utc>>,
    pub push_protection_bypassed_by: Option<User>,
    pub resolution: Option<SecretScanningAlertResolution>,
    pub resolution_comment: Option<String>,
    pub resolved_at: Option<DateTime<Utc>>,
    pub resolved_by: Option<User>,
    pub secret: Option<String>,
    pub secret_type: String,
    pub secret_type_display_name: Option<String>,
    pub state: SecretScanningAlertState,
    pub updated_at: Option<DateTime<Utc>>,
    pub url: String,
}

Expand description

SecretScanningAlert

JSON schema

{
 "title": "Secret scanning alert",
 "type": "object",
 "required": [
   "created_at",
   "html_url",
   "number",
   "resolution",
   "resolved_at",
   "resolved_by",
   "secret_type",
   "state",
   "updated_at",
   "url"
 ],
 "properties": {
   "created_at": {
     "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
     "readOnly": true,
     "type": "string",
     "format": "date-time"
   },
   "html_url": {
     "description": "The GitHub URL of the alert resource.",
     "readOnly": true,
     "type": "string",
     "format": "uri"
   },
   "locations_url": {
     "description": "The REST API URL of the code locations for this alert.",
     "type": "string",
     "format": "uri"
   },
   "number": {
     "description": "The security alert number.",
     "readOnly": true,
     "type": "integer"
   },
   "push_protection_bypassed": {
     "description": "Whether push protection was bypassed for the detected secret.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "push_protection_bypassed_at": {
     "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "push_protection_bypassed_by": {
     "oneOf": [
       {
         "$ref": "#/definitions/user"
       },
       {
         "type": "null"
       }
     ]
   },
   "resolution": {
     "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.",
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "false_positive",
       "wont_fix",
       "revoked",
       "used_in_tests",
       null
     ]
   },
   "resolution_comment": {
     "description": "An optional comment to resolve an alert.",
     "type": [
       "string",
       "null"
     ]
   },
   "resolved_at": {
     "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "resolved_by": {
     "oneOf": [
       {
         "$ref": "#/definitions/user"
       },
       {
         "type": "null"
       }
     ]
   },
   "secret": {
     "description": "The secret that was detected.",
     "type": "string"
   },
   "secret_type": {
     "description": "The type of secret that secret scanning detected.",
     "type": "string"
   },
   "secret_type_display_name": {
     "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/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"",
     "type": "string"
   },
   "state": {
     "type": "string",
     "enum": [
       "open",
       "resolved"
     ]
   },
   "updated_at": {
     "oneOf": [
       {
         "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
         "readOnly": true,
         "type": "string",
         "format": "date-time"
       },
       {
         "type": "null"
       }
     ]
   },
   "url": {
     "description": "The REST API URL of the alert resource.",
     "readOnly": true,
     "type": "string",
     "format": "uri"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}