shared.License

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-shared-license-schema.json",
  "title": "shared.License",
  "description": "License represent the customer license",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-settings-api-openapi.yml#/components/schemas/shared.License",
  "properties": {
    "access_token": {
      "description": "AccessToken is the customer access token.\n",
      "type": "string"
    },
    "contract_id": {
      "description": "ContractID is the customer contract ID.\n",
      "type": "string"
    },
    "contract_type": {
      "$ref": "#/$defs/shared.LicenseContractType"
    },
    "credits": {
      "description": "Credits the total amount of credits purchased by the customer.\n",
      "type": "integer"
    },
    "customer_id": {
      "description": "CustomerID is the customer ID.\n",
      "type": "string"
    },
    "defender_details": {
      "description": "DefenderDetails represents the defenders license details.\n",
      "items": {
        "$ref": "#/$defs/shared.DefenderLicenseDetails"
      },
      "type": "array"
    },
    "defenders": {
      "description": "Deprecated: Defenders is the maximum number of defender allowed in this license. Use DefenderDetails field instead.\n",
      "type": "integer"
    },
    "expiration_date": {
      "description": "ExpirationDate is the license expiration date.\n",
      "format": "date-time",
      "type": "string"
    },
    "issue_date": {
      "description": "IssueDate is the license issue date.\n",
      "format": "date-time",
      "type": "string"
    },
    "type": {
      "$ref": "#/$defs/shared.LicenseTier"
    },
    "workloads": {
      "description": "Deprecated: Workloads is the number of workloads per license kept for backward compatibility. Use Credits instead.\n",
      "type": "integer"
    }
  },
  "type": "object",
  "$defs": {
    "defender.Category": {
      "description": "Category represents the defender target category",
      "enum": [
        [
          "container",
          "host",
          "serverless",
          "appEmbedded",
          "hostAgentless",
          "containerAgentless",
          "cloudSecurityAgent"
        ]
      ],
      "type": "string"
    },
    "shared.DefenderLicenseDetails": {
      "description": "DefenderLicenseDetails represents a single defender license details",
      "properties": {
        "category": {
          "$ref": "#/$defs/defender.Category"
        },
        "count": {
          "description": "Count is the amount of licensed defenders.\n",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "shared.LicenseContractType": {
      "description": "LicenseContractType is the license contract type",
      "enum": [
        [
          "",
          "host",
          "avg",
          "burndown"
        ]
      ],
      "type": "string"
    },
    "shared.LicenseTier": {
      "description": "LicenseTier represents the license tier of the customer",
      "enum": [
        [
          "",
          "developer",
          "enterprise",
          "evaluation",
          "oem"
        ]
      ],
      "type": "string"
    }
  }
}