{
  "version": 1,
  "generated_at": "2026-04-16",
  "generated_from": "api/openapi.yaml",
  "management_scopes": [
    "admin",
    "device:write",
    "event:read",
    "license:read",
    "license:write",
    "ops:read",
    "product:read",
    "product:write",
    "report:export",
    "report:read",
    "webhook:write"
  ],
  "scopes": {
    "admin": [
      "createAPIKey",
      "createCustomer",
      "deleteCustomer",
      "getCustomer",
      "listAPIKeys",
      "listCustomerCustomFieldValues",
      "listCustomers",
      "updateCustomer",
      "upsertCustomerCustomFieldValue"
    ],
    "device:write": [
      "blacklistLicenseDevice",
      "resetLicenseDevice"
    ],
    "event:read": [
      "listEvents"
    ],
    "license:read": [
      "getLicense",
      "getLicenseDevice",
      "listLicenseCustomFieldValues",
      "listLicenseDevices",
      "listLicenseFeatures",
      "listLicenses"
    ],
    "license:write": [
      "assignLicenseFeature",
      "createLicense",
      "reinstateLicense",
      "removeLicenseFeature",
      "renewLicense",
      "resetLicenseUsage",
      "revokeLicense",
      "suspendLicense",
      "transferLicense",
      "upsertLicenseCustomFieldValue"
    ],
    "ops:read": [
      "getOpsSummary",
      "getWebhookHealth",
      "listRuntimeErrorGroups"
    ],
    "product:read": [
      "getFeature",
      "getOrder",
      "getPolicy",
      "getProduct",
      "getProductCustomFieldDefinition",
      "getSubscription",
      "listFeaturesByProduct",
      "listPoliciesByProduct",
      "listProductCustomFieldDefinitions",
      "listProductOrders",
      "listProductSubscriptions",
      "listProductVersions",
      "listProducts"
    ],
    "product:write": [
      "createFeature",
      "createOrder",
      "createPolicy",
      "createProduct",
      "createProductCustomFieldDefinition",
      "createProductVersion",
      "createSubscription",
      "deletePolicy",
      "deleteProduct",
      "deleteProductCustomFieldDefinition",
      "updateOrder",
      "updatePolicy",
      "updateProduct",
      "updateProductCustomFieldDefinition",
      "updateSubscription"
    ],
    "report:export": [
      "createReportExport",
      "downloadReportExport",
      "getReportExport"
    ],
    "report:read": [
      "getCustomerSummary",
      "getLicenseAuditReport",
      "getSubscriptionSettlement",
      "getUsageSummary",
      "listActivities",
      "listUsageLedger"
    ],
    "webhook:write": [
      "createWebhookEndpoint",
      "deleteWebhookEndpoint",
      "getWebhookEndpoint",
      "listWebhookEndpoints",
      "updateWebhookEndpoint"
    ]
  },
  "operations": {
    "activateLicense": {
      "method": "POST",
      "path": "/api/v1/license/activate",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "assignLicenseFeature": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/features",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "blacklistLicenseDevice": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/devices/{device_id}/blacklist",
      "auth": "management",
      "required_scopes": [
        "device:write"
      ]
    },
    "checkLicense": {
      "method": "POST",
      "path": "/api/v1/license/check",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "checkinFloatingLicense": {
      "method": "POST",
      "path": "/api/v1/license/floating/checkin",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "checkoutFloatingLicense": {
      "method": "POST",
      "path": "/api/v1/license/floating/checkout",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "consumeLicense": {
      "method": "POST",
      "path": "/api/v1/license/consume",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "createAPIKey": {
      "method": "POST",
      "path": "/api/v1/api-keys",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "createCustomer": {
      "method": "POST",
      "path": "/api/v1/customers",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "createFeature": {
      "method": "POST",
      "path": "/api/v1/products/{id}/features",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createLicense": {
      "method": "POST",
      "path": "/api/v1/licenses",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "createOrder": {
      "method": "POST",
      "path": "/api/v1/products/{id}/orders",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createPolicy": {
      "method": "POST",
      "path": "/api/v1/products/{id}/policies",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createProduct": {
      "method": "POST",
      "path": "/api/v1/products",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createProductCustomFieldDefinition": {
      "method": "POST",
      "path": "/api/v1/products/{id}/custom-fields",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createProductVersion": {
      "method": "POST",
      "path": "/api/v1/products/{id}/versions",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createReportExport": {
      "method": "POST",
      "path": "/api/v1/reports/exports",
      "auth": "management",
      "required_scopes": [
        "report:export"
      ]
    },
    "createSubscription": {
      "method": "POST",
      "path": "/api/v1/products/{id}/subscriptions",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "createWebhookEndpoint": {
      "method": "POST",
      "path": "/api/v1/webhooks",
      "auth": "management",
      "required_scopes": [
        "webhook:write"
      ]
    },
    "deactivateLicense": {
      "method": "POST",
      "path": "/api/v1/license/deactivate",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "deleteCustomer": {
      "method": "DELETE",
      "path": "/api/v1/customers/{id}",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "deletePolicy": {
      "method": "DELETE",
      "path": "/api/v1/policies/{id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "deleteProduct": {
      "method": "DELETE",
      "path": "/api/v1/products/{id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "deleteProductCustomFieldDefinition": {
      "method": "DELETE",
      "path": "/api/v1/products/{id}/custom-fields/{field_id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "deleteWebhookEndpoint": {
      "method": "DELETE",
      "path": "/api/v1/webhooks/{id}",
      "auth": "management",
      "required_scopes": [
        "webhook:write"
      ]
    },
    "downloadReportExport": {
      "method": "GET",
      "path": "/api/v1/reports/exports/{id}/download",
      "auth": "management",
      "required_scopes": [
        "report:export"
      ]
    },
    "getCustomer": {
      "method": "GET",
      "path": "/api/v1/customers/{id}",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "getCustomerSummary": {
      "method": "GET",
      "path": "/api/v1/reports/customer-summary",
      "auth": "management",
      "required_scopes": [
        "report:read"
      ]
    },
    "getFeature": {
      "method": "GET",
      "path": "/api/v1/features/{id}",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "getLicense": {
      "method": "GET",
      "path": "/api/v1/licenses/{id}",
      "auth": "management",
      "required_scopes": [
        "license:read"
      ]
    },
    "getLicenseAuditReport": {
      "method": "GET",
      "path": "/api/v1/reports/license-audit",
      "auth": "management",
      "required_scopes": [
        "report:read"
      ]
    },
    "getLicenseDevice": {
      "method": "GET",
      "path": "/api/v1/licenses/{id}/devices/{device_id}",
      "auth": "management",
      "required_scopes": [
        "license:read"
      ]
    },
    "getMetrics": {
      "method": "GET",
      "path": "/metrics",
      "auth": "system",
      "required_scopes": [

      ]
    },
    "getOpsSummary": {
      "method": "GET",
      "path": "/api/v1/ops/summary",
      "auth": "management",
      "required_scopes": [
        "ops:read"
      ]
    },
    "getOrder": {
      "method": "GET",
      "path": "/api/v1/orders/{id}",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "getPolicy": {
      "method": "GET",
      "path": "/api/v1/policies/{id}",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "getProduct": {
      "method": "GET",
      "path": "/api/v1/products/{id}",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "getProductCustomFieldDefinition": {
      "method": "GET",
      "path": "/api/v1/products/{id}/custom-fields/{field_id}",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "getReportExport": {
      "method": "GET",
      "path": "/api/v1/reports/exports/{id}",
      "auth": "management",
      "required_scopes": [
        "report:export"
      ]
    },
    "getSubscription": {
      "method": "GET",
      "path": "/api/v1/subscriptions/{id}",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "getSubscriptionSettlement": {
      "method": "GET",
      "path": "/api/v1/reports/subscription-settlement",
      "auth": "management",
      "required_scopes": [
        "report:read"
      ]
    },
    "getUsageSummary": {
      "method": "GET",
      "path": "/api/v1/reports/usage-summary",
      "auth": "management",
      "required_scopes": [
        "report:read"
      ]
    },
    "getWebhookEndpoint": {
      "method": "GET",
      "path": "/api/v1/webhooks/{id}",
      "auth": "management",
      "required_scopes": [
        "webhook:write"
      ]
    },
    "getWebhookHealth": {
      "method": "GET",
      "path": "/api/v1/ops/webhook-health",
      "auth": "management",
      "required_scopes": [
        "ops:read"
      ]
    },
    "health": {
      "method": "GET",
      "path": "/health",
      "auth": "system",
      "required_scopes": [

      ]
    },
    "healthz": {
      "method": "GET",
      "path": "/healthz",
      "auth": "system",
      "required_scopes": [

      ]
    },
    "heartbeatFloatingLicense": {
      "method": "POST",
      "path": "/api/v1/license/floating/heartbeat",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "issueOfflineLicense": {
      "method": "POST",
      "path": "/api/v1/license/offline",
      "auth": "runtime",
      "required_scopes": [

      ]
    },
    "listAPIKeys": {
      "method": "GET",
      "path": "/api/v1/api-keys",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "listActivities": {
      "method": "GET",
      "path": "/api/v1/activities",
      "auth": "management",
      "required_scopes": [
        "report:read"
      ]
    },
    "listCustomerCustomFieldValues": {
      "method": "GET",
      "path": "/api/v1/customers/{id}/custom-fields",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "listCustomers": {
      "method": "GET",
      "path": "/api/v1/customers",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "listEvents": {
      "method": "GET",
      "path": "/api/v1/events",
      "auth": "management",
      "required_scopes": [
        "event:read"
      ]
    },
    "listFeaturesByProduct": {
      "method": "GET",
      "path": "/api/v1/products/{id}/features",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listLicenseCustomFieldValues": {
      "method": "GET",
      "path": "/api/v1/licenses/{id}/custom-fields",
      "auth": "management",
      "required_scopes": [
        "license:read"
      ]
    },
    "listLicenseDevices": {
      "method": "GET",
      "path": "/api/v1/licenses/{id}/devices",
      "auth": "management",
      "required_scopes": [
        "license:read"
      ]
    },
    "listLicenseFeatures": {
      "method": "GET",
      "path": "/api/v1/licenses/{id}/features",
      "auth": "management",
      "required_scopes": [
        "license:read"
      ]
    },
    "listLicenses": {
      "method": "GET",
      "path": "/api/v1/licenses",
      "auth": "management",
      "required_scopes": [
        "license:read"
      ]
    },
    "listPoliciesByProduct": {
      "method": "GET",
      "path": "/api/v1/products/{id}/policies",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listProductCustomFieldDefinitions": {
      "method": "GET",
      "path": "/api/v1/products/{id}/custom-fields",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listProductOrders": {
      "method": "GET",
      "path": "/api/v1/products/{id}/orders",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listProductSubscriptions": {
      "method": "GET",
      "path": "/api/v1/products/{id}/subscriptions",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listProductVersions": {
      "method": "GET",
      "path": "/api/v1/products/{id}/versions",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listProducts": {
      "method": "GET",
      "path": "/api/v1/products",
      "auth": "management",
      "required_scopes": [
        "product:read"
      ]
    },
    "listPublicKeys": {
      "method": "GET",
      "path": "/api/v1/system/public-keys",
      "auth": "system",
      "required_scopes": [

      ]
    },
    "listRuntimeErrorGroups": {
      "method": "GET",
      "path": "/api/v1/ops/runtime-errors",
      "auth": "management",
      "required_scopes": [
        "ops:read"
      ]
    },
    "listUsageLedger": {
      "method": "GET",
      "path": "/api/v1/reports/usage-ledger",
      "auth": "management",
      "required_scopes": [
        "report:read"
      ]
    },
    "listWebhookEndpoints": {
      "method": "GET",
      "path": "/api/v1/webhooks",
      "auth": "management",
      "required_scopes": [
        "webhook:write"
      ]
    },
    "readyz": {
      "method": "GET",
      "path": "/readyz",
      "auth": "system",
      "required_scopes": [

      ]
    },
    "reinstateLicense": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/reinstate",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "removeLicenseFeature": {
      "method": "DELETE",
      "path": "/api/v1/licenses/{id}/features/{feature_id}",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "renewLicense": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/renew",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "resetLicenseDevice": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/devices/{device_id}/reset",
      "auth": "management",
      "required_scopes": [
        "device:write"
      ]
    },
    "resetLicenseUsage": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/usage/reset",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "revokeLicense": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/revoke",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "suspendLicense": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/suspend",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "transferLicense": {
      "method": "POST",
      "path": "/api/v1/licenses/{id}/transfer",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "updateCustomer": {
      "method": "PATCH",
      "path": "/api/v1/customers/{id}",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "updateOrder": {
      "method": "PATCH",
      "path": "/api/v1/orders/{id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "updatePolicy": {
      "method": "PATCH",
      "path": "/api/v1/policies/{id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "updateProduct": {
      "method": "PATCH",
      "path": "/api/v1/products/{id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "updateProductCustomFieldDefinition": {
      "method": "PATCH",
      "path": "/api/v1/products/{id}/custom-fields/{field_id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "updateSubscription": {
      "method": "PATCH",
      "path": "/api/v1/subscriptions/{id}",
      "auth": "management",
      "required_scopes": [
        "product:write"
      ]
    },
    "updateWebhookEndpoint": {
      "method": "PATCH",
      "path": "/api/v1/webhooks/{id}",
      "auth": "management",
      "required_scopes": [
        "webhook:write"
      ]
    },
    "upsertCustomerCustomFieldValue": {
      "method": "PUT",
      "path": "/api/v1/customers/{id}/custom-fields/{field_id}",
      "auth": "management",
      "required_scopes": [
        "admin"
      ]
    },
    "upsertLicenseCustomFieldValue": {
      "method": "PUT",
      "path": "/api/v1/licenses/{id}/custom-fields/{field_id}",
      "auth": "management",
      "required_scopes": [
        "license:write"
      ]
    },
    "validateLicense": {
      "method": "POST",
      "path": "/api/v1/license/validate",
      "auth": "runtime",
      "required_scopes": [

      ]
    }
  },
  "unscoped_operations": [
    "activateLicense",
    "checkLicense",
    "checkinFloatingLicense",
    "checkoutFloatingLicense",
    "consumeLicense",
    "deactivateLicense",
    "getMetrics",
    "health",
    "healthz",
    "heartbeatFloatingLicense",
    "issueOfflineLicense",
    "listPublicKeys",
    "readyz",
    "validateLicense"
  ]
}