Enterprise Security Analysis Settings

APIs.ioEngineeringPlatform

Properties

Name Type Description
advanced_security_enabled_for_new_repositories boolean Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to this enterprise.
dependabot_alerts_enabled_for_new_repositories boolean Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this enterprise.
secret_scanning_enabled_for_new_repositories boolean Whether secret scanning is automatically enabled for new repositories and repositories transferred to this enterprise.
secret_scanning_push_protection_enabled_for_new_repositories boolean Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this enterprise.
secret_scanning_push_protection_custom_link string An optional URL string to display to contributors who are blocked from pushing a secret.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-enterprise-security-analysis-settings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/enterprise-security-analysis-settings",
  "title": "Enterprise Security Analysis Settings",
  "type": "object",
  "properties": {
    "advanced_security_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise."
    },
    "dependabot_alerts_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this\nenterprise."
    },
    "secret_scanning_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\nenterprise."
    },
    "secret_scanning_push_protection_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this enterprise."
    },
    "secret_scanning_push_protection_custom_link": {
      "type": "string",
      "nullable": true,
      "example": "https://github.com/test-org/test-repo/blob/main/README.md",
      "description": "An optional URL string to display to contributors who are blocked from pushing a secret."
    }
  },
  "required": [
    "advanced_security_enabled_for_new_repositories",
    "dependabot_alerts_enabled_for_new_repositories",
    "secret_scanning_enabled_for_new_repositories",
    "secret_scanning_push_protection_enabled_for_new_repositories"
  ]
}