blueprints_api.json

{
  "components": {
    "parameters": {
      "X-Environment-Id": {
        "description": "The environment UUID identifier.",
        "in": "header",
        "name": "X-Environment-Id",
        "required": true,
        "schema": {
          "example": "e77c1408-10c8-4007-b177-abc9157fbcaa",
          "format": "uuid",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
          "type": "string"
        }
      }
    },
    "schemas": {
      "AcceptCookies": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "The policy Safari uses for managing cookies",
            "enum": [
              "Never",
              "CurrentWebsite",
              "VisitedWebsites",
              "Always"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "AllowDisablingFraudWarning": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "If false, the system forces fraud warnings on in Safari",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "AllowHistoryClearing": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "If false, the system disables clearing history in Safari",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "AllowJavaScript": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "If false, the system disables JavaScript in Safari",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "AllowPopups": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "If false, the system disables popups in Safari",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "AllowPrivateBrowsing": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "If false, the system disables private browsing in Safari",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "AllowSummary": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "If false, the system disables summarization of content in Safari",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "ApiError": {
        "properties": {
          "errors": {
            "$ref": "#/components/schemas/Error"
          },
          "httpStatus": {
            "description": "HTTP status of the response",
            "example": 400,
            "format": "int32",
            "maximum": 599,
            "minimum": 100,
            "type": "integer"
          },
          "traceId": {
            "description": "Trace ID",
            "example": "3e3819a63ae0f231",
            "type": "string"
          }
        },
        "required": [
          "errors",
          "traceId"
        ],
        "type": "object"
      },
      "AppSettingsAllowed": {
        "description": "Allow/deny lists for which apps and binaries can run.\n\n\u003e **Validation rule:** Each entry in `AllowedBinaries` requires either `CDHash` or\n\u003e `TeamID`. Each entry in `DeniedBinaries` requires `CDHash`, `TeamID`, or `SigningID`.\n",
        "properties": {
          "AllowedApps": {
            "description": "Bundle IDs the device may show or launch. Not supported on macOS.",
            "example": [
              "com.example.app"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "AllowedBinaries": {
            "description": "Binaries allowed to run. macOS only.",
            "items": {
              "$ref": "#/components/schemas/AppSettingsBinaryIdentifier"
            },
            "type": "array"
          },
          "AlwaysAllowManagedApps": {
            "default": false,
            "description": "If `true`, implicitly allows managed apps when `AllowedBinaries` is present. macOS only.",
            "type": "boolean"
          },
          "DeniedApps": {
            "description": "Bundle IDs the device may not show or launch. Not supported on macOS.",
            "example": [
              "com.example.app"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "DeniedBinaries": {
            "description": "Binaries denied from running. macOS only.",
            "items": {
              "$ref": "#/components/schemas/AppSettingsBinaryIdentifier"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "AppSettingsBinaryIdentifier": {
        "description": "Identifies a binary by code-signing attributes.",
        "properties": {
          "CDHash": {
            "description": "40-character code directory hash of the binary.",
            "example": "a1b2c3d4e5f60718293a4b5c6d7e8f9012345678",
            "maxLength": 40,
            "minLength": 40,
            "type": "string"
          },
          "PathPrefix": {
            "description": "File system path prefix to match binaries.",
            "example": "/Applications/Example.app",
            "type": "string"
          },
          "SigningID": {
            "description": "Code signature signing identifier of the binary.",
            "example": "com.example.app",
            "type": "string"
          },
          "SigningState": {
            "default": "All",
            "description": "Code signing state to match.",
            "enum": [
              "All",
              "TestFlight",
              "DeveloperID",
              "Enterprise",
              "AppStore",
              "Apple"
            ],
            "type": "string"
          },
          "TeamID": {
            "description": "Code signature team identifier. Use `*APPLE*` for Apple binaries with no team identifier.",
            "example": "ABCD1234",
            "type": "string"
          }
        },
        "type": "object"
      },
      "AppSettingsDeclaration": {
        "description": "Configures app allow/deny lists and app privacy permission defaults.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/AppSettingsDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.app.settings"
            ],
            "example": "com.apple.configuration.app.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "App Settings",
        "type": "object"
      },
      "AppSettingsDeclarationPayload": {
        "description": "Payload fields for the App Settings declaration.",
        "example": {
          "Privacy": {
            "PermissionDefaults": {
              "com.example.scanner": {
                "Camera": "Allow",
                "OrganizationJustification": "This app is used for scanning work documents."
              }
            }
          }
        },
        "properties": {
          "Allowed": {
            "$ref": "#/components/schemas/AppSettingsAllowed"
          },
          "Privacy": {
            "$ref": "#/components/schemas/AppSettingsPrivacy"
          }
        },
        "type": "object"
      },
      "AppSettingsPermissionDefaults": {
        "description": "App privacy permission defaults for one app identifier.",
        "properties": {
          "Accessibility": {
            "description": "Not supported on iOS.",
            "enum": [
              "None",
              "Allow"
            ],
            "example": "None",
            "type": "string"
          },
          "Bluetooth": {
            "enum": [
              "None",
              "Allow"
            ],
            "example": "None",
            "type": "string"
          },
          "Camera": {
            "enum": [
              "None",
              "Allow"
            ],
            "example": "None",
            "type": "string"
          },
          "Dictation": {
            "enum": [
              "None",
              "Allow"
            ],
            "example": "None",
            "type": "string"
          },
          "LocalNetwork": {
            "enum": [
              "None",
              "Allow"
            ],
            "example": "None",
            "type": "string"
          },
          "Location": {
            "enum": [
              "None",
              "WhileUsing",
              "Always"
            ],
            "example": "None",
            "type": "string"
          },
          "LocationAccuracy": {
            "description": "Not supported on macOS.",
            "enum": [
              "None",
              "Approximate",
              "Precise"
            ],
            "example": "None",
            "type": "string"
          },
          "Microphone": {
            "enum": [
              "None",
              "Allow"
            ],
            "example": "None",
            "type": "string"
          },
          "OrganizationJustification": {
            "description": "Text shown to the user explaining why the organization requires these defaults.",
            "example": "This app is used for scanning work documents.",
            "type": "string"
          }
        },
        "required": [
          "OrganizationJustification"
        ],
        "type": "object"
      },
      "AppSettingsPermissionDefaultsMap": {
        "additionalProperties": {
          "$ref": "#/components/schemas/AppSettingsPermissionDefaults"
        },
        "description": "Maps an app identifier (bundle ID on iOS; a composed `Bundle-ID\n{Designated-Requirement}` identifier on macOS) to a permission-defaults object.\n",
        "example": {
          "com.example.scanner": {
            "Camera": "Allow",
            "OrganizationJustification": "This app is used for scanning work documents."
          }
        },
        "type": "object"
      },
      "AppSettingsPrivacy": {
        "description": "App privacy permission defaults. Not supported on tvOS/visionOS/watchOS.",
        "properties": {
          "PermissionDefaults": {
            "$ref": "#/components/schemas/AppSettingsPermissionDefaultsMap"
          }
        },
        "type": "object"
      },
      "AudioAccessorySettingsComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/AudioAccessorySettingsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.audio-accessory-settings"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "AudioAccessorySettingsConfiguration": {
        "description": "Audio accessory settings configuration.\n\nConfigures audio accessory temporary pairing behavior.\n",
        "properties": {
          "TemporaryPairing": {
            "$ref": "#/components/schemas/TemporaryPairing"
          }
        },
        "type": "object"
      },
      "AutomaticAction": {
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "enum": [
              "Allowed",
              "AlwaysOn",
              "AlwaysOff"
            ],
            "type": "string"
          }
        },
        "required": [
          "Value"
        ],
        "type": "object"
      },
      "AutomaticActions": {
        "properties": {
          "Download": {
            "$ref": "#/components/schemas/AutomaticAction"
          },
          "InstallOSUpdates": {
            "$ref": "#/components/schemas/AutomaticAction"
          },
          "InstallSecurityUpdate": {
            "$ref": "#/components/schemas/AutomaticAction"
          }
        },
        "type": "object"
      },
      "BasicMode": {
        "properties": {
          "AddSquareRoot": {
            "description": "Add the square root button to the basic calculator by replacing the +/- button.",
            "type": "boolean"
          },
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          }
        },
        "required": [
          "AddSquareRoot"
        ],
        "type": "object"
      },
      "Beta": {
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "$ref": "#/components/schemas/BetaSettings"
          }
        },
        "type": "object"
      },
      "BetaProgram": {
        "properties": {
          "Description": {
            "maxLength": 1000,
            "minLength": 1,
            "type": "string"
          },
          "Token": {
            "maxLength": 1000,
            "minLength": 1,
            "type": "string"
          }
        },
        "type": "object"
      },
      "BetaSettings": {
        "properties": {
          "OfferPrograms": {
            "items": {
              "$ref": "#/components/schemas/BetaProgram"
            },
            "maxItems": 100,
            "type": "array"
          },
          "ProgramEnrollment": {
            "enum": [
              "Allowed",
              "AlwaysOn",
              "AlwaysOff"
            ],
            "type": "string"
          },
          "RequireProgram": {
            "$ref": "#/components/schemas/BetaProgram"
          }
        },
        "required": [
          "ProgramEnrollment"
        ],
        "type": "object"
      },
      "BlueprintDetail": {
        "properties": {
          "created": {
            "description": "Creation date",
            "example": "2025-04-01T12:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "deploymentState": {
            "$ref": "#/components/schemas/DeploymentState"
          },
          "description": {
            "description": "Description of the blueprint",
            "example": "Keep all eligible MacOS devices updated to the last major version",
            "maxLength": 2000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "ID of the blueprint",
            "example": "15812829-95c1-451c-9239-f1f61a3d3a94",
            "type": "string"
          },
          "name": {
            "description": "Name of the blueprint",
            "example": "Update software to latest version",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "scope": {
            "$ref": "#/components/schemas/BlueprintScope"
          },
          "steps": {
            "description": "Array of blueprint steps",
            "items": {
              "$ref": "#/components/schemas/BlueprintStep"
            },
            "maxItems": 100,
            "type": "array"
          },
          "updated": {
            "description": "Last modification date",
            "example": "2025-04-01T16:30:00Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created",
          "deploymentState",
          "id",
          "name",
          "steps",
          "updated"
        ],
        "type": "object"
      },
      "BlueprintOverview": {
        "description": "Array of result items",
        "properties": {
          "created": {
            "description": "Creation date",
            "example": "2025-04-01T12:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "deploymentState": {
            "$ref": "#/components/schemas/DeploymentState"
          },
          "description": {
            "description": "Description of the blueprint",
            "example": "Keep all eligible MacOS devices updated to the last major version",
            "maxLength": 2000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "ID of the blueprint",
            "example": "15812829-95c1-451c-9239-f1f61a3d3a94",
            "type": "string"
          },
          "name": {
            "description": "Name of the blueprint",
            "example": "Update software to latest version",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "updated": {
            "description": "Last modification date",
            "example": "2025-04-01T16:30:00Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created",
          "deploymentState",
          "id",
          "name",
          "updated"
        ],
        "type": "object"
      },
      "BlueprintScope": {
        "description": "Device groups",
        "properties": {
          "deviceGroups": {
            "description": "Device groups",
            "example": [
              "cda24521-f23b-4f27-a9ff-32c89fb6feeb"
            ],
            "items": {
              "description": "Device groups",
              "example": "[\"cda24521-f23b-4f27-a9ff-32c89fb6feeb\"]",
              "minLength": 1,
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "deviceGroups"
        ],
        "type": "object"
      },
      "BlueprintStatusDetail": {
        "properties": {
          "failed": {
            "description": "Number of devices in failed state",
            "example": 10,
            "format": "int32",
            "type": "integer"
          },
          "pending": {
            "description": "Number of devices in pending state",
            "example": 5,
            "format": "int32",
            "type": "integer"
          },
          "succeeded": {
            "description": "Number of devices in successful state",
            "example": 150,
            "format": "int32",
            "type": "integer"
          }
        },
        "required": [
          "failed",
          "pending",
          "succeeded"
        ],
        "type": "object"
      },
      "BlueprintStep": {
        "description": "Array of blueprint steps",
        "properties": {
          "activationPredicate": {
            "description": "Declarative activation predicate",
            "example": "@status(device.operating-system.family) == 'iPadOS'",
            "maxLength": 10000,
            "nullable": true,
            "type": "string"
          },
          "components": {
            "description": "Array of components included in the step",
            "items": {
              "$ref": "#/components/schemas/Component"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array"
          },
          "name": {
            "description": "Name of the step",
            "example": "Step 1",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "components"
        ],
        "type": "object"
      },
      "BookmarkGroup": {
        "properties": {
          "Bookmarks": {
            "description": "A list of bookmarks",
            "items": {
              "$ref": "#/components/schemas/BookmarkItem"
            },
            "type": "array"
          },
          "GroupIdentifier": {
            "description": "A string that specifies the unique identifier for this group of managed bookmarks",
            "minLength": 1,
            "type": "string"
          },
          "Title": {
            "description": "The name of the bookmarks folder",
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "Bookmarks",
          "GroupIdentifier",
          "Title"
        ],
        "type": "object"
      },
      "BookmarkItem": {
        "discriminator": {
          "mapping": {
            "BOOKMARK": "#/components/schemas/UrlBookmarkItem",
            "FOLDER": "#/components/schemas/FolderBookmarkItem"
          },
          "propertyName": "Type"
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/FolderBookmarkItem"
          },
          {
            "$ref": "#/components/schemas/UrlBookmarkItem"
          }
        ]
      },
      "Calculator": {
        "properties": {
          "BasicMode": {
            "$ref": "#/components/schemas/BasicMode",
            "description": "If present, configures the basic mode of the calculator. Basic mode is always enabled."
          },
          "InputModes": {
            "$ref": "#/components/schemas/InputModes",
            "description": "If present, controls global input options of the calculator. If not present, all input modes are enabled."
          },
          "MathNotesMode": {
            "$ref": "#/components/schemas/MathNotesMode",
            "description": "If present, configures the Math Notes mode of the calculator. If not present, math notes mode is enabled."
          },
          "ProgrammerMode": {
            "$ref": "#/components/schemas/ProgrammerMode",
            "description": "If present, configures the programmer mode of the calculator. If not present, programmer mode is enabled."
          },
          "ScientificMode": {
            "$ref": "#/components/schemas/ScientificMode",
            "description": "If present, configures the scientific mode of the calculator. If not present, scientific mode is enabled."
          }
        },
        "type": "object"
      },
      "ChangeAtNextAuth": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Change at next auth",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "Component": {
        "description": "A blueprint component",
        "discriminator": {
          "mapping": {
            "com.jamf.ddm-configuration-profile": "#/components/schemas/ConfigurationProfile",
            "com.jamf.ddm-strict": "#/components/schemas/DeclarationsComponent",
            "com.jamf.ddm.app-managed": "#/components/schemas/ManagedAppComponent",
            "com.jamf.ddm.audio-accessory-settings": "#/components/schemas/AudioAccessorySettingsComponent",
            "com.jamf.ddm.custom-declarations": "#/components/schemas/CustomDeclarationsComponent",
            "com.jamf.ddm.disk-management": "#/components/schemas/DiskManagementComponent",
            "com.jamf.ddm.math-settings": "#/components/schemas/MathSettingsComponent",
            "com.jamf.ddm.passcode-settings": "#/components/schemas/PasscodeSettingsComponent",
            "com.jamf.ddm.safari-bookmarks": "#/components/schemas/SafariBookmarksComponent",
            "com.jamf.ddm.safari-extensions": "#/components/schemas/SafariExtensionsComponent",
            "com.jamf.ddm.safari-settings": "#/components/schemas/SafariSettingsComponent",
            "com.jamf.ddm.software-update-settings": "#/components/schemas/SoftwareUpdateSettingsComponent",
            "com.jamf.ddm.sw-updates": "#/components/schemas/SwUpdateComponent"
          },
          "propertyName": "identifier"
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/ConfigurationProfile"
          },
          {
            "$ref": "#/components/schemas/CustomDeclarationsComponent"
          },
          {
            "$ref": "#/components/schemas/AudioAccessorySettingsComponent"
          },
          {
            "$ref": "#/components/schemas/DiskManagementComponent"
          },
          {
            "$ref": "#/components/schemas/MathSettingsComponent"
          },
          {
            "$ref": "#/components/schemas/PasscodeSettingsComponent"
          },
          {
            "$ref": "#/components/schemas/SafariBookmarksComponent"
          },
          {
            "$ref": "#/components/schemas/SafariExtensionsComponent"
          },
          {
            "$ref": "#/components/schemas/SafariSettingsComponent"
          },
          {
            "$ref": "#/components/schemas/SoftwareUpdateSettingsComponent"
          },
          {
            "$ref": "#/components/schemas/SwUpdateComponent"
          },
          {
            "$ref": "#/components/schemas/ManagedAppComponent"
          },
          {
            "$ref": "#/components/schemas/DeclarationsComponent"
          }
        ],
        "properties": {
          "configuration": {
            "type": "object"
          },
          "identifier": {
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "ComponentDescription": {
        "description": "Array of result items",
        "properties": {
          "description": {
            "description": "Description of the component",
            "example": "Enforce software updates for your devices",
            "nullable": true,
            "type": "string"
          },
          "identifier": {
            "description": "Blueprint component identifier",
            "example": "com.jamf.ddm.sw-updates",
            "type": "string"
          },
          "meta": {
            "$ref": "#/components/schemas/Meta"
          },
          "name": {
            "description": "Name of the component",
            "example": "Software updates",
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "meta",
          "name"
        ],
        "type": "object"
      },
      "ConfigurationProfile": {
        "description": "Component for sending any Apple MDM configuration profile payload as a blueprint component.",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/ConfigurationProfileConfiguration"
          },
          "identifier": {
            "description": "## Using Apple MDM profile payloads as blueprint components\n\nThe API accepts **any** Apple MDM configuration profile payload as a\nblueprint component — not only the ones explicitly listed in this\nspecification. Use the `com.jamf.ddm-configuration-profile` identifier with the\npattern described here to send one or more Apple payloads.\n\nApple publishes all payload definitions at\n[apple/device-management/mdm/profiles](https://github.com/apple/device-management/tree/release/mdm/profiles).\n\n### Step 1 — Choose the Apple payload(s)\n\nFind the payload YAML in the Apple repository. The `payloadtype` field\n(e.g., `com.apple.domains`, `com.apple.wifi.managed`,\n`com.apple.applicationaccess`) identifies each payload.\n\n\u003e **Unsupported payload types:** Blueprints with\n\u003e `com.apple.font` or `com.apple.webClip.managed` payloads\n\u003e cannot be created.\n\n### Step 2 — Build the `configuration` object\n\nThe `configuration` has two mandatory fields:\n\n| Field | Type | Description |\n|---|---|---|\n| `payloadDisplayName` | string | A human-readable name shown on the device (e.g., `\"Managed Domains\"`) |\n| `payloadContent` | array | An array of payload objects — each one represents a single Apple payload |\n\nEach entry in `payloadContent` **must** contain:\n\n| Field | Type | Description |\n|---|---|---|\n| `payloadType` | string | The Apple payload type identifier (e.g., `com.apple.domains`) |\n\nIn addition to `payloadType`, include the payload-specific keys from the\n`payloadkeys` section of the Apple payload YAML.\n\n### Apple type → JSON type mapping\n\n| Apple type | JSON value type | Example |\n|---|---|---|\n| `\u003cstring\u003e` | string | `\"example.com\"` |\n| `\u003cinteger\u003e` | number | `42` |\n| `\u003creal\u003e` | number | `3.14` |\n| `\u003cboolean\u003e` | boolean | `true` |\n| `\u003cdata\u003e` | string (Base64-encoded) | `\"SGVsbG8=\"` |\n| `\u003cdate\u003e` | string (ISO 8601) | `\"2026-01-15T00:00:00Z\"` |\n| `\u003carray\u003e` | array | `[\"a\", \"b\"]` |\n| `\u003cdictionary\u003e` | object | `{ \"key\": \"value\" }` |\n\nOnly include the keys you want to configure. Keys marked\n`presence: optional` in the Apple YAML can be omitted; keys marked\n`presence: required` must be present.\n\n### Reference\n\n- Apple payload definitions: https://github.com/apple/device-management/tree/release/mdm/profiles\n- Apple Configuration Profile reference: https://developer.apple.com/documentation/devicemanagement/profile-specific-payload-keys\n",
            "enum": [
              "com.jamf.ddm-configuration-profile"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "ConfigurationProfileConfiguration": {
        "description": "Configuration wrapper for one or more Apple MDM profile payloads.\n\n### Example — `com.apple.domains`\n\nUsing the payload defined in\n[com.apple.domains.yaml](https://github.com/apple/device-management/blob/release/mdm/profiles/com.apple.domains.yaml),\nits `payloadkeys` are `EmailDomains`, `WebDomains`,\n`SafariPasswordAutoFillDomains`, `CrossSiteTrackingPreventionRelaxedDomains`,\nand `CrossSiteTrackingPreventionRelaxedApps` — all optional arrays of strings.\n\n```json\n{\n  \"payloadDisplayName\": \"Managed Domains\",\n  \"payloadContent\": [\n    {\n      \"payloadType\": \"com.apple.domains\",\n      \"EmailDomains\": [\"example.com\", \"private.example.com\"],\n      \"WebDomains\": [\"*.example.com\"],\n      \"SafariPasswordAutoFillDomains\": [\"login.example.com\"]\n    }\n  ]\n}\n```\n\n### Example — `com.apple.wifi.managed`\n\nThe same pattern works for any payload. For\n[com.apple.wifi.managed](https://github.com/apple/device-management/blob/release/mdm/profiles/com.apple.wifi.managed.yaml),\nlook up its `payloadkeys` and send:\n\n```json\n{\n  \"payloadDisplayName\": \"Corporate Wi-Fi\",\n  \"payloadContent\": [\n    {\n      \"payloadType\": \"com.apple.wifi.managed\",\n      \"SSID_STR\": \"Corporate-WiFi\",\n      \"EncryptionType\": \"WPA2\",\n      \"AutoJoin\": true,\n      \"IsHotspot\": false\n    }\n  ]\n}\n```\n\n### Combining multiple Apple payloads in one component\n\nA single `com.jamf.ddm-configuration-profile` component can contain multiple\nApple payloads in the `payloadContent` array:\n\n```json\n{\n  \"payloadDisplayName\": \"Network \u0026 Domains\",\n  \"payloadContent\": [\n    {\n      \"payloadType\": \"com.apple.domains\",\n      \"WebDomains\": [\"*.corp.example.com\"],\n      \"EmailDomains\": [\"corp.example.com\"]\n    },\n    {\n      \"payloadType\": \"com.apple.wifi.managed\",\n      \"SSID_STR\": \"CorpNet\",\n      \"EncryptionType\": \"WPA3\"\n    }\n  ]\n}\n```\n\nYou can also place multiple `com.jamf.ddm-configuration-profile` components in the\nsame blueprint step alongside other component types.\n",
        "properties": {
          "payloadContent": {
            "description": "An array of Apple payload objects. Each entry represents a single\nApple MDM payload and **must** include a `payloadType` field set to\nthe Apple payload type identifier (e.g., `com.apple.domains`,\n`com.apple.wifi.managed`, `com.apple.applicationaccess`).\n\nIn addition to `payloadType`, include any payload-specific keys from\nthe `payloadkeys` section of the corresponding Apple payload YAML\ndefinition. Any additional properties beyond `payloadType` are\naccepted to accommodate any Apple payload schema.\n",
            "items": {
              "$ref": "#/components/schemas/ConfigurationProfileContentItem"
            },
            "minItems": 1,
            "type": "array"
          },
          "payloadDisplayName": {
            "description": "A human-readable name for this configuration profile, displayed on the device.",
            "example": "Managed Domains",
            "type": "string"
          }
        },
        "required": [
          "payloadDisplayName",
          "payloadContent"
        ],
        "type": "object"
      },
      "ConfigurationProfileContentItem": {
        "additionalProperties": true,
        "description": "A single Apple MDM payload entry. Must contain `payloadType` to\nidentify the Apple payload, plus any payload-specific keys.\n",
        "properties": {
          "payloadType": {
            "description": "The Apple payload type identifier (e.g., `com.apple.domains`,\n`com.apple.wifi.managed`, `com.apple.applicationaccess`).\n",
            "example": "com.apple.domains",
            "type": "string"
          }
        },
        "required": [
          "payloadType"
        ],
        "type": "object"
      },
      "ContentCachingDeclaration": {
        "description": "Configures the built-in Content Caching service. macOS only.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/ContentCachingDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.content-cache.settings"
            ],
            "example": "com.apple.configuration.content-cache.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Content Caching",
        "type": "object"
      },
      "ContentCachingDeclarationPayload": {
        "description": "Payload fields for the Content Caching declaration.",
        "example": {
          "AllowPersonalCaching": true,
          "AllowSharedCaching": true,
          "AutoActivation": true,
          "KeepAwake": true,
          "Port": 0
        },
        "properties": {
          "AllowCacheDelete": {
            "default": true,
            "description": "If `true`, the system may purge cached content when disk space is low.",
            "type": "boolean"
          },
          "AllowPersonalCaching": {
            "default": true,
            "description": "Caches the user's iCloud data. At least one of `AllowPersonalCaching`/`AllowSharedCaching` must be `true`.",
            "type": "boolean"
          },
          "AllowSharedCaching": {
            "default": true,
            "description": "Caches non-iCloud content such as apps and software updates.",
            "type": "boolean"
          },
          "AutoActivation": {
            "default": false,
            "description": "Automatically activates Content Caching when possible.",
            "type": "boolean"
          },
          "AutoEnableTetheredCaching": {
            "default": false,
            "description": "Automatically enables Internet connection sharing for tethered caching.",
            "type": "boolean"
          },
          "CacheLimit": {
            "default": 0,
            "description": "Maximum disk space in bytes for the cache. `0` is unlimited.",
            "type": "integer"
          },
          "DataPath": {
            "description": "Directory used to store cached content. Must end with `/Library/Application Support/Apple/AssetCache/Data`.",
            "example": "/Library/Application Support/Apple/AssetCache/Data",
            "type": "string"
          },
          "DeclarativeStatusInterval": {
            "default": 0,
            "description": "Reporting interval in seconds for the status item. `0` disables it; any other\nvalue must be between 300 and 86400.\n",
            "maximum": 86400,
            "minimum": 0,
            "type": "integer"
          },
          "DenyActivation": {
            "default": false,
            "description": "If `true`, disables Content Caching entirely.",
            "type": "boolean"
          },
          "DenyTetheredCaching": {
            "default": false,
            "description": "If `true`, disables tethered caching.",
            "type": "boolean"
          },
          "DisplayAlerts": {
            "default": false,
            "description": "Shows exceptional conditions as system notifications.",
            "type": "boolean"
          },
          "KeepAwake": {
            "default": false,
            "description": "Prevents sleep while Content Caching is on.",
            "type": "boolean"
          },
          "ListenRanges": {
            "description": "Client IP ranges to serve.",
            "items": {
              "$ref": "#/components/schemas/ContentCachingIpRange"
            },
            "type": "array"
          },
          "ListenRangesOnly": {
            "default": false,
            "description": "Restricts serving to `ListenRanges` only.",
            "type": "boolean"
          },
          "ListenWithPeersAndParents": {
            "default": true,
            "description": "Serves clients in the union of `ListenRanges`, `PeerListenRanges`, and `Parents`.",
            "type": "boolean"
          },
          "LocalSubnetsOnly": {
            "default": true,
            "description": "Restricts serving to the local subnet, ignoring `ListenRanges`.",
            "type": "boolean"
          },
          "LogClientIdentity": {
            "default": false,
            "description": "Logs client IP and port.",
            "type": "boolean"
          },
          "ManagementReportingInterval": {
            "default": 300,
            "description": "Reporting interval in seconds for management statistics.",
            "maximum": 86400,
            "minimum": 60,
            "type": "integer"
          },
          "ManagementSecurityConfig": {
            "default": "no-cert",
            "description": "How the `ManagementStatusTarget` HTTPS connection is secured.",
            "enum": [
              "no-cert",
              "signedByCACert",
              "specificServerCert"
            ],
            "type": "string"
          },
          "ManagementStatusCertificateReference": {
            "description": "Asset declaration identifier for the certificate used to verify `ManagementStatusTarget`.",
            "example": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
            "type": "string"
          },
          "ManagementStatusTarget": {
            "description": "URL the cache PUTs management statistics to.",
            "example": "https://example.com/status",
            "type": "string"
          },
          "ParentSelectionPolicy": {
            "default": "round-robin",
            "description": "Policy for choosing among multiple parents.",
            "enum": [
              "first-available",
              "url-path-hash",
              "random",
              "round-robin",
              "sticky-available"
            ],
            "type": "string"
          },
          "Parents": {
            "description": "IP addresses of upstream content caches to use instead of Apple directly.",
            "example": [
              "10.0.0.5"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "PeerFilterRanges": {
            "description": "Peer IP ranges this cache queries for content.",
            "items": {
              "$ref": "#/components/schemas/ContentCachingIpRange"
            },
            "type": "array"
          },
          "PeerListenRanges": {
            "description": "Peer IP ranges this cache responds to.",
            "items": {
              "$ref": "#/components/schemas/ContentCachingIpRange"
            },
            "type": "array"
          },
          "PeerLocalSubnetsOnly": {
            "default": true,
            "description": "Restricts peering to the local subnet.",
            "type": "boolean"
          },
          "PersonalCacheLimit": {
            "default": 0,
            "description": "Maximum disk space in bytes for personal (iCloud) content. `0` uses `CacheLimit`.",
            "type": "integer"
          },
          "Port": {
            "default": 0,
            "description": "TCP port for upload/download requests. `0` picks a random port.",
            "type": "integer"
          },
          "PublicRanges": {
            "description": "Public IP ranges cloud servers use to match clients to caches.",
            "items": {
              "$ref": "#/components/schemas/ContentCachingIpRange"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "ContentCachingIpRange": {
        "description": "A range of IP addresses.",
        "properties": {
          "first": {
            "description": "The first IP address in the range.",
            "example": "10.0.0.1",
            "minLength": 1,
            "type": "string"
          },
          "last": {
            "description": "The last IP address in the range.",
            "example": "10.0.0.254",
            "minLength": 1,
            "type": "string"
          },
          "type": {
            "default": "IPv4",
            "enum": [
              "IPv4",
              "IPv6"
            ],
            "type": "string"
          }
        },
        "required": [
          "first",
          "last"
        ],
        "type": "object"
      },
      "CreateBlueprintRequest": {
        "properties": {
          "description": {
            "description": "Description of the blueprint",
            "example": "Keep all eligible MacOS devices updated to the last major version",
            "maxLength": 2000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Name of the blueprint",
            "example": "Update software to latest version",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "scope": {
            "$ref": "#/components/schemas/CreateScope"
          },
          "steps": {
            "description": "Array of blueprint steps",
            "items": {
              "$ref": "#/components/schemas/BlueprintStep"
            },
            "maxItems": 10,
            "type": "array"
          }
        },
        "required": [
          "name",
          "scope",
          "steps"
        ],
        "type": "object"
      },
      "CreateResponse": {
        "properties": {
          "href": {
            "example": "https://us.api.jamfcloud.com/blueprints/v1/blueprints/15812829-95c1-451c-9239-f1f61a3d3a94",
            "format": "uri",
            "type": "string"
          },
          "id": {
            "example": "15812829-95c1-451c-9239-f1f61a3d3a94",
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "href",
          "id"
        ],
        "type": "object"
      },
      "CreateScope": {
        "description": "Scope of the blueprint",
        "properties": {
          "deviceGroups": {
            "description": "Device groups",
            "example": [
              "cda24521-f23b-4f27-a9ff-32c89fb6feeb"
            ],
            "items": {
              "description": "Device groups",
              "example": "[\"cda24521-f23b-4f27-a9ff-32c89fb6feeb\"]",
              "minLength": 1,
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "deviceGroups"
        ],
        "type": "object"
      },
      "CustomDeclaration": {
        "description": "A single Apple declarative device management declaration entry.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "$ref": "#/components/schemas/DeclarationKind"
          },
          "payload": {
            "additionalProperties": true,
            "description": "A JSON object containing the declaration-specific keys from the Apple\ndeclaration schema. Include the `payloadkeys` fields from the corresponding\nApple declaration YAML. Additional properties are accepted to accommodate\nany Apple declaration schema.\n",
            "type": "object"
          },
          "payloadKey": {
            "description": "An integer that identifies this declaration within the `declarations` list of\nthis request. Use this value to cross-reference declarations in other payload\nfields via the `$PAYLOAD_\u003cpayloadKey\u003e` placeholder, which is substituted at\ndeploy time with the generated declaration identifier. The value is local to\nthe current request. It does not need to be globally unique or consistent\nacross requests.\n",
            "example": 1,
            "format": "int32",
            "type": "integer"
          },
          "type": {
            "description": "The Apple declarative device management declaration type identifier\n(e.g., `com.apple.configuration.passcode.settings`,\n`com.apple.asset.useridentity`).\n",
            "example": "com.apple.configuration.passcode.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload",
          "payloadKey"
        ],
        "type": "object"
      },
      "CustomDeclarationsComponent": {
        "description": "Blueprint component that delivers any Apple declarative device management declarations to managed devices.",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/CustomDeclarationsConfiguration"
          },
          "identifier": {
            "description": "## Use Apple declarative device management declarations as blueprint components\n\nThe API accepts any Apple declarative device management configuration or asset declaration as a blueprint component, not\nonly the ones explicitly listed in this specification. Use the\n`com.jamf.ddm.custom-declarations` identifier with the pattern described here\nto send one or more Apple declarative device management declarations.\n\nApple publishes all declaration definitions at\n[apple/device-management/declarative/declarations](https://github.com/apple/device-management/tree/release/declarative/declarations).\n\n### Step 1 — Choose the Apple declaration type\n\nFind the declaration YAML in the Apple repository. The `declarationtype` field\n(e.g., `com.apple.configuration.passcode.settings`,\n`com.apple.asset.useridentity`)\nidentifies each declaration.\n\n### Step 2 — Set the `kind` field\n\nThe `kind` maps to the declaration group, derived from the Apple declaration\ntype prefix:\n\n| `kind` | Apple declaration type prefix |\n|---|---|\n| `CONFIGURATION` | `com.apple.configuration.` |\n| `ASSET` | `com.apple.asset.` |\n\n### Step 3 — Set the `channelType` field\n\n| `channelType` | Description |\n|---|---|\n| `SYSTEM` | Applies the declaration to the system (device) channel |\n| `USER` | Applies the declaration to the user channel |\n\n### Step 4 — Build the `payload` object\n\nThe `payload` is a JSON object containing the declaration-specific keys from\nthe `payloadkeys` section of the corresponding Apple declaration YAML.\n\nOnly include the keys you want to configure. Keys marked `presence: optional`\nin the Apple YAML can be omitted; keys marked `presence: required` must be\npresent.\n\n### Step 5 — Use `payloadKey` for cross-declaration references\n\nEach declaration in the array has an integer `payloadKey` that identifies it\nwithin the `declarations` list of this request. To reference another\ndeclaration's generated identifier in a payload field, use the placeholder\n`$PAYLOAD_\u003cpayloadKey\u003e`. This placeholder is substituted at deploy time with\nthe actual declaration identifier of the referenced declaration.\n\nThe `payloadKey` value is local to the declarations in this request — it does\nnot need to be globally unique or consistent across requests. This is useful\nwhen a configuration declaration must reference an asset declaration defined\nin the same component.\n",
            "enum": [
              "com.jamf.ddm.custom-declarations"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "CustomDeclarationsConfiguration": {
        "description": "Configuration object containing one or more Apple declarative device management declarations.\n\n### Example — single configuration declaration\n\n```json\n{\n  \"declarations\": [\n    {\n      \"type\": \"com.apple.configuration.passcode.settings\",\n      \"channelType\": \"SYSTEM\",\n      \"kind\": \"CONFIGURATION\",\n      \"payload\": {\n        \"RequirePasscode\": true,\n        \"MinimumLength\": 8,\n        \"MaximumFailedAttempts\": 10\n      },\n      \"payloadKey\": 1\n    }\n  ]\n}\n```\n\n### Example — configuration declaration referencing an asset\n\nA configuration declaration can reference an asset declaration defined in the\nsame `declarations` array using the `$PAYLOAD_\u003cpayloadKey\u003e` placeholder.\nThe `payloadKey` values are local to the declarations list in this request —\nthey do not need to be globally unique or consistent across requests:\n\n```json\n{\n  \"declarations\": [\n    {\n      \"type\": \"com.apple.asset.credential.userpassword\",\n      \"channelType\": \"SYSTEM\",\n      \"kind\": \"ASSET\",\n      \"payload\": {\n        \"Reference\": {\n          \"DataURL\": \"https://example.com/asset-data/credential.json\",\n          \"ContentType\": \"application/json\"\n        }\n      },\n      \"payloadKey\": 1\n    },\n    {\n      \"type\": \"com.apple.configuration.account.caldav\",\n      \"channelType\": \"SYSTEM\",\n      \"kind\": \"CONFIGURATION\",\n      \"payload\": {\n        \"HostName\": \"caldav.example.com\",\n        \"VisibleName\": \"Work Calendar\",\n        \"AuthenticationCredentialsAssetReference\": \"$PAYLOAD_1\"\n      },\n      \"payloadKey\": 2\n    }\n  ]\n}\n```\n",
        "properties": {
          "declarations": {
            "description": "An array of Apple declarative device management declaration objects to include in this component.",
            "items": {
              "$ref": "#/components/schemas/CustomDeclaration"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "declarations"
        ],
        "type": "object"
      },
      "CustomRegex": {
        "properties": {
          "Description": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "Map of OS language ID to a localized description. Use the special `default` key for languages that the dictionary doesn't contain.",
            "example": {
              "en-US": "Must be 16 digits long."
            },
            "type": "object"
          },
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Regex": {
            "description": "Regular expression",
            "example": "[0-9]{16}",
            "maxLength": 2048,
            "type": "string"
          }
        },
        "type": "object"
      },
      "DeclarationChannelType": {
        "description": "The channel to which the declaration applies:\n- `SYSTEM` — applies to the system (device) channel\n- `USER` — applies to the user channel\n",
        "enum": [
          "SYSTEM",
          "USER"
        ],
        "type": "string"
      },
      "DeclarationKind": {
        "description": "The declaration group, determined by the Apple declaration type prefix:\n- `CONFIGURATION` — for `com.apple.configuration.*` types\n- `ASSET` — for `com.apple.asset.*` types\n",
        "enum": [
          "CONFIGURATION",
          "ASSET"
        ],
        "type": "string"
      },
      "DeclarationsComponent": {
        "description": "Blueprint component for one or more supported Apple declarations.",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/DeclarationsComponentConfiguration"
          },
          "identifier": {
            "description": "## Supported declarations\n\n| Item | Type identifier | Supported OS |\n|---|---|---|\n| Managed App | `com.apple.configuration.app.managed` | macOS 26.0+ |\n| App Settings | `com.apple.configuration.app.settings` | iOS 27.0+, macOS 27.0+, tvOS 27.0+, visionOS 27.0+ |\n| Content Caching | `com.apple.configuration.content-cache.settings` | macOS 27.0+ |\n| External Intelligence Settings | `com.apple.configuration.external-intelligence.settings` | iOS 26.4+, macOS 26.4+, visionOS 26.4+ |\n| Intelligence Settings | `com.apple.configuration.intelligence.settings` | iOS 26.4+, macOS 26.4+, visionOS 26.4+ |\n| Keyboard Settings | `com.apple.configuration.keyboard.settings` | iOS 26.4+, macOS 26.4+ |\n| Package | `com.apple.configuration.package` | macOS 26.0+ |\n| Screen Sharing Connection | `com.apple.configuration.screensharing.connection` | macOS 14.0+ |\n| Screen Sharing Connection Group | `com.apple.configuration.screensharing.connection.group` | macOS 14.0+ |\n| Screen Sharing Host Settings | `com.apple.configuration.screensharing.host.settings` | macOS 14.0+ |\n| Siri Settings | `com.apple.configuration.siri.settings` | iOS 26.4+, macOS 26.4+, tvOS 27.0+, visionOS 26.4+, watchOS 26.4+ |\n\nA single component can contain multiple declarations, of different supported\ntypes, in its `declarations` array. Each array entry is one of the items above,\nidentified by its own `type` field.\n\nApple publishes the full specification for each of these at\n[apple/device-management/declarative/declarations/configurations](https://github.com/apple/device-management/tree/release/declarative/declarations/configurations).\n",
            "enum": [
              "com.jamf.ddm-strict"
            ],
            "example": "com.jamf.ddm-strict",
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "DeclarationsComponentConfiguration": {
        "description": "Configuration wrapper for one or more declarations.\n\n### Example\n\n```json\n{\n  \"identifier\": \"com.jamf.ddm-strict\",\n  \"configuration\": {\n    \"declarations\": [\n      {\n        \"type\": \"com.apple.configuration.app.managed\",\n        \"channelType\": \"SYSTEM\",\n        \"kind\": \"CONFIGURATION\",\n        \"payload\": {\n          \"AppStoreID\": \"361285480\",\n          \"InstallBehavior\": {\n            \"Install\": \"Required\",\n            \"License\": {\n              \"Assignment\": \"Device\"\n            }\n          }\n        }\n      }\n    ]\n  }\n}\n```\n",
        "properties": {
          "declarations": {
            "description": "An array of declaration items, each identified by its own `type`.",
            "example": [
              {
                "channelType": "SYSTEM",
                "kind": "CONFIGURATION",
                "payload": {
                  "AppStoreID": "361285480"
                },
                "type": "com.apple.configuration.app.managed"
              }
            ],
            "items": {
              "discriminator": {
                "mapping": {
                  "com.apple.configuration.app.managed": "#/components/schemas/ManagedAppDeclaration",
                  "com.apple.configuration.app.settings": "#/components/schemas/AppSettingsDeclaration",
                  "com.apple.configuration.content-cache.settings": "#/components/schemas/ContentCachingDeclaration",
                  "com.apple.configuration.external-intelligence.settings": "#/components/schemas/ExternalIntelligenceSettingsDeclaration",
                  "com.apple.configuration.intelligence.settings": "#/components/schemas/IntelligenceSettingsDeclaration",
                  "com.apple.configuration.keyboard.settings": "#/components/schemas/KeyboardSettingsDeclaration",
                  "com.apple.configuration.package": "#/components/schemas/PackageDeclaration",
                  "com.apple.configuration.screensharing.connection": "#/components/schemas/ScreenSharingConnectionDeclaration",
                  "com.apple.configuration.screensharing.connection.group": "#/components/schemas/ScreenSharingConnectionGroupDeclaration",
                  "com.apple.configuration.screensharing.host.settings": "#/components/schemas/ScreenSharingHostSettingsDeclaration",
                  "com.apple.configuration.siri.settings": "#/components/schemas/SiriSettingsDeclaration"
                },
                "propertyName": "type"
              },
              "oneOf": [
                {
                  "$ref": "#/components/schemas/ManagedAppDeclaration"
                },
                {
                  "$ref": "#/components/schemas/AppSettingsDeclaration"
                },
                {
                  "$ref": "#/components/schemas/ContentCachingDeclaration"
                },
                {
                  "$ref": "#/components/schemas/ExternalIntelligenceSettingsDeclaration"
                },
                {
                  "$ref": "#/components/schemas/IntelligenceSettingsDeclaration"
                },
                {
                  "$ref": "#/components/schemas/KeyboardSettingsDeclaration"
                },
                {
                  "$ref": "#/components/schemas/PackageDeclaration"
                },
                {
                  "$ref": "#/components/schemas/ScreenSharingConnectionDeclaration"
                },
                {
                  "$ref": "#/components/schemas/ScreenSharingConnectionGroupDeclaration"
                },
                {
                  "$ref": "#/components/schemas/ScreenSharingHostSettingsDeclaration"
                },
                {
                  "$ref": "#/components/schemas/SiriSettingsDeclaration"
                }
              ]
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "declarations"
        ],
        "type": "object"
      },
      "Deferrals": {
        "properties": {
          "CombinedPeriodInDays": {
            "$ref": "#/components/schemas/OptionalPeriodInDays"
          },
          "MajorPeriodInDays": {
            "$ref": "#/components/schemas/OptionalPeriodInDays"
          },
          "MinorPeriodInDays": {
            "$ref": "#/components/schemas/OptionalPeriodInDays"
          },
          "SystemPeriodInDays": {
            "$ref": "#/components/schemas/OptionalPeriodInDays"
          }
        },
        "type": "object"
      },
      "Deployment": {
        "description": "Information about last deployment job",
        "nullable": true,
        "properties": {
          "started": {
            "description": "Date when deployment job started",
            "example": "2025-04-01T16:35:00Z",
            "format": "date-time",
            "type": "string"
          },
          "state": {
            "description": "Deployment job state",
            "enum": [
              "PENDING",
              "DEPLOYING",
              "SUCCEEDED",
              "FAILED"
            ],
            "example": "SUCCEEDED",
            "type": "string"
          }
        },
        "required": [
          "started",
          "state"
        ],
        "type": "object"
      },
      "DeploymentState": {
        "description": "Blueprint deployment state",
        "properties": {
          "lastDeployment": {
            "$ref": "#/components/schemas/Deployment"
          },
          "state": {
            "description": "Blueprint state",
            "enum": [
              "NOT_DEPLOYED",
              "DEPLOYED",
              "OUT_OF_DATE"
            ],
            "example": "DEPLOYED",
            "type": "string"
          }
        },
        "required": [
          "state"
        ],
        "type": "object"
      },
      "DetailsUrl": {
        "description": "Optional URL with details about the enforced update",
        "properties": {
          "Included": {
            "default": false,
            "description": "Controls whether this setting should be used",
            "type": "boolean"
          },
          "Value": {
            "description": "URL of a web page with the details about the enforced update",
            "format": "uri",
            "type": "string"
          }
        },
        "type": "object"
      },
      "DiskManagementComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/DiskManagementSettingsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.disk-management"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "DiskManagementSettingsConfiguration": {
        "description": "Disk management settings configuration.\n\nConfigures restrictions for external and network storage access.\n",
        "properties": {
          "Restrictions": {
            "$ref": "#/components/schemas/Restrictions"
          },
          "version": {
            "description": "Configuration version",
            "enum": [
              2
            ],
            "format": "int32",
            "type": "integer"
          }
        },
        "required": [
          "version"
        ],
        "type": "object"
      },
      "Error": {
        "properties": {
          "code": {
            "description": "Error-specific code that can be used to identify localization string, etc.",
            "example": "INVALID_FIELD",
            "type": "string"
          },
          "description": {
            "description": "A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text.",
            "example": "Field name is required.",
            "type": "string"
          },
          "field": {
            "description": "Name of the field that caused the error.",
            "example": "name",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "id of object with error",
            "example": "2b7b22dc-a0d4-48d2-a02d-8fdd88e1397c",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "code",
          "description"
        ],
        "type": "object"
      },
      "ExternalIntelligenceSettingsDeclaration": {
        "description": "Configures External Intelligence Integrations settings.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/ExternalIntelligenceSettingsDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.external-intelligence.settings"
            ],
            "example": "com.apple.configuration.external-intelligence.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "External Intelligence Settings",
        "type": "object"
      },
      "ExternalIntelligenceSettingsDeclarationPayload": {
        "description": "Payload fields for the External Intelligence Settings declaration.",
        "example": {
          "AllowSignIn": false,
          "AllowedWorkspaceIDs": [
            "ABCDEFGH"
          ],
          "Enabled": false
        },
        "properties": {
          "AllowSignIn": {
            "default": true,
            "description": "If `false`, disables sign-in for external intelligence integrations.",
            "type": "boolean"
          },
          "AllowedWorkspaceIDs": {
            "description": "Restricts external intelligence to the given workspace ID (currently limited to one element).",
            "example": [
              "ABCDEFGH"
            ],
            "items": {
              "type": "string"
            },
            "maxItems": 1,
            "type": "array"
          },
          "Enabled": {
            "default": true,
            "description": "If `false`, disables external intelligence integrations.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "FailedAttemptsResetInMinutes": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Failed attempts reset in minutes",
            "example": 5,
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "FolderBookmarkItem": {
        "properties": {
          "Folder": {
            "description": "An array of bookmarks for each bookmark in the folder",
            "items": {
              "$ref": "#/components/schemas/UrlBookmarkItem"
            },
            "type": "array"
          },
          "Title": {
            "description": "The title of the folder shown in Safari",
            "minLength": 1,
            "type": "string"
          },
          "Type": {
            "enum": [
              "FOLDER"
            ],
            "type": "string"
          }
        },
        "required": [
          "Title",
          "Type"
        ],
        "type": "object"
      },
      "InputModes": {
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          },
          "RPN": {
            "description": "Configures whether RPN input is enabled.",
            "type": "boolean"
          },
          "UnitConversion": {
            "description": "Configures whether unit conversions are enabled.",
            "type": "boolean"
          }
        },
        "required": [
          "RPN",
          "UnitConversion"
        ],
        "type": "object"
      },
      "IntelligenceSettingsApps": {
        "description": "Per-app Intelligence feature toggles.",
        "properties": {
          "Calendar": {
            "$ref": "#/components/schemas/IntelligenceSettingsAppsCalendar"
          },
          "Mail": {
            "$ref": "#/components/schemas/IntelligenceSettingsAppsMail"
          },
          "Notes": {
            "$ref": "#/components/schemas/IntelligenceSettingsAppsNotes"
          },
          "Safari": {
            "$ref": "#/components/schemas/IntelligenceSettingsAppsSafari"
          }
        },
        "type": "object"
      },
      "IntelligenceSettingsAppsCalendar": {
        "description": "Calendar and Reminders Intelligence feature toggles. Requires iOS/macOS/visionOS 27.0+.",
        "properties": {
          "AllowNaturalLanguageEditing": {
            "default": true,
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "IntelligenceSettingsAppsMail": {
        "description": "Mail Intelligence feature toggles.",
        "properties": {
          "AllowSmartReplies": {
            "default": true,
            "type": "boolean"
          },
          "AllowSummary": {
            "default": true,
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "IntelligenceSettingsAppsNotes": {
        "description": "Not supported on visionOS.",
        "properties": {
          "AllowTranscription": {
            "default": true,
            "type": "boolean"
          },
          "AllowTranscriptionSummary": {
            "default": true,
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "IntelligenceSettingsAppsSafari": {
        "description": "Safari Intelligence feature toggles.",
        "properties": {
          "AllowSummary": {
            "default": true,
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "IntelligenceSettingsDeclaration": {
        "description": "Configures Apple Intelligence settings.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/IntelligenceSettingsDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.intelligence.settings"
            ],
            "example": "com.apple.configuration.intelligence.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Intelligence Settings",
        "type": "object"
      },
      "IntelligenceSettingsDeclarationPayload": {
        "description": "Payload fields for the Intelligence Settings declaration.",
        "example": {
          "AllowGenmoji": false,
          "AllowImagePlayground": false,
          "Apps": {
            "Mail": {
              "AllowSmartReplies": false,
              "AllowSummary": false
            },
            "Safari": {
              "AllowSummary": false
            }
          },
          "ForceOnDeviceOnlyDictation": true
        },
        "properties": {
          "AllowAppleIntelligenceReport": {
            "default": true,
            "type": "boolean"
          },
          "AllowGenmoji": {
            "default": true,
            "type": "boolean"
          },
          "AllowImagePlayground": {
            "default": true,
            "type": "boolean"
          },
          "AllowImageWand": {
            "default": true,
            "description": "Not supported on macOS.",
            "type": "boolean"
          },
          "AllowPersonalizedHandwritingResults": {
            "default": true,
            "description": "Not supported on macOS/visionOS.",
            "type": "boolean"
          },
          "AllowVisualIntelligence": {
            "default": true,
            "description": "Not supported on visionOS. Requires iOS/macOS 27.0+.",
            "type": "boolean"
          },
          "AllowVisualIntelligenceSummary": {
            "default": true,
            "description": "Not supported on macOS/visionOS. Deprecated on iOS 27.0+ in favor of\n`AllowVisualIntelligence`.\n",
            "type": "boolean"
          },
          "AllowWritingTools": {
            "default": true,
            "type": "boolean"
          },
          "Apps": {
            "$ref": "#/components/schemas/IntelligenceSettingsApps"
          },
          "ForceOnDeviceOnlyDictation": {
            "default": false,
            "description": "If `true`, forces on-device-only dictation.",
            "type": "boolean"
          },
          "ForceOnDeviceOnlyTranslation": {
            "default": false,
            "description": "Not supported on macOS/visionOS. If `true`, forces on-device-only translation.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "KeyboardSettingsDeclaration": {
        "description": "Configures keyboard settings.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/KeyboardSettingsDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.keyboard.settings"
            ],
            "example": "com.apple.configuration.keyboard.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Keyboard Settings",
        "type": "object"
      },
      "KeyboardSettingsDeclarationPayload": {
        "description": "Payload fields for the Keyboard Settings declaration.",
        "example": {
          "AllowAutoCorrection": false,
          "AllowDictation": false,
          "AllowSpellCheck": false
        },
        "properties": {
          "AllowAutoCorrection": {
            "default": true,
            "description": "Not supported on macOS.",
            "type": "boolean"
          },
          "AllowDefinitionLookup": {
            "default": true,
            "type": "boolean"
          },
          "AllowDictation": {
            "default": true,
            "type": "boolean"
          },
          "AllowMathKeyboardSuggestions": {
            "default": true,
            "description": "Also supported by `math.settings`.",
            "type": "boolean"
          },
          "AllowPredictiveText": {
            "default": true,
            "description": "Not supported on macOS.",
            "type": "boolean"
          },
          "AllowSlideToType": {
            "default": true,
            "description": "Not supported on macOS.",
            "type": "boolean"
          },
          "AllowSpellCheck": {
            "default": true,
            "description": "Not supported on macOS.",
            "type": "boolean"
          },
          "AllowTextReplacement": {
            "default": true,
            "description": "Not supported on macOS.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "ManagedAppAttributes": {
        "description": "Fine-grained app behavior settings. All fields are optional.\n\n**iOS 18.1+ note:** `Hideable` and `Lockable` require iOS 18.1 or later.\nWhen `Lockable` is `false`, `Hideable` is required and must also be `false`.\n",
        "properties": {
          "AssociatedDomains": {
            "description": "Associated domains for the app.",
            "example": [
              "corp.example.com"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "AssociatedDomainsEnableDirectDownloads": {
            "description": "Enable direct downloads for the app's associated domains.",
            "example": false,
            "type": "boolean"
          },
          "CellularSliceUUID": {
            "description": "UUID of the network slice to use for the app's cellular connection.",
            "example": "12345678-1234-1234-1234-123456789abc",
            "type": "string"
          },
          "DNSProxyUUID": {
            "description": "UUID of the DNS proxy configuration to apply to the app.",
            "example": "87654321-4321-4321-4321-cba987654321",
            "type": "string"
          },
          "Hideable": {
            "description": "Allow the user to hide the app from the home screen (requires iOS 18.1 or later). When `Lockable` is `false`, this must also be `false`.",
            "example": true,
            "type": "boolean"
          },
          "Lockable": {
            "description": "Allow the user to lock the app behind Face ID or Touch ID (requires iOS 18.1 or later).",
            "example": true,
            "type": "boolean"
          },
          "TapToPayScreenLock": {
            "description": "Require screen lock when the app uses Tap to Pay.",
            "example": false,
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "ManagedAppComponent": {
        "description": "Blueprint component that installs and manages volume purchasing apps on managed devices.",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/ManagedAppConfiguration"
          },
          "identifier": {
            "description": "## Using volume purchasing apps as blueprint components\n\nThe `com.jamf.ddm.app-managed` component installs and manages Apple volume purchasing apps on devices. Each component contains one or more app\nconfigurations in the `apps` array.\n\n### Prerequisites\n\nApps must be available in your Jamf organization's volume purchasing token. The `AssetId`\nand `AppAndBookTokenId` values come from your volume purchasing integration in Jamf —\nuse the [List available blueprint components](../listComponents) endpoint\n(`GET /v1/blueprint-components`) to discover apps available to your organization\nand retrieve their identifiers.\n\n### Required fields per app\n\n| Field | Type | Description |\n|---|---|---|\n| `AssetId` | string | volume purchasing asset identifier for the app |\n| `AppAndBookTokenId` | string | Identifier of the volume purchasing token that licenses the app |\n| `AppId` | string | App bundle identifier (e.g., `com.microsoft.Excel`) |\n\n### Optional management fields\n\n| Field | Type | Values | Description |\n|---|---|---|---|\n| `Install` | string | `Required`, `Optional` | Whether the app must be installed. Defaults to `Required`. |\n| `AllowDownloadsOverCellular` | string | `AlwaysOn`, `AlwaysOff`, `StoreSettings` | Controls cellular downloads. Defaults to `StoreSettings`. |\n| `AutomaticAppUpdates` | string | `AlwaysOn`, `AlwaysOff`, `StoreSettings` | Controls automatic updates. Defaults to `StoreSettings`. |\n| `IncludeInBackup` | boolean | `true`, `false` | Whether app data is included in device backups. |\n| `Attributes` | object | — | Fine-grained app behavior settings. See `Attributes` fields below. |\n\n### `Attributes` fields (all optional)\n\n| Field | Type | Description |\n|---|---|---|\n| `Hideable` | boolean | Allow the user to hide the app (requires iOS 18.1 or later). When `Lockable` is `false`, `Hideable` must also be `false`. |\n| `Lockable` | boolean | Allow the user to lock the app behind Face ID / Touch ID (requires iOS 18.1 or later). |\n| `TapToPayScreenLock` | boolean | Require screen lock when Tap to Pay is used. |\n| `AssociatedDomains` | array of strings | Associated domains for the app (e.g., `[\"example.com\"]`). |\n| `AssociatedDomainsEnableDirectDownloads` | boolean | Enable direct downloads for the associated domains. |\n| `CellularSliceUUID` | string (UUID) | Network slicing UUID for the app's cellular connection. |\n| `DNSProxyUUID` | string (UUID) | UUID of the DNS proxy configuration to apply to the app. |\n\n\u003e **Validation rule:** When `Lockable` is `false`, `Hideable` is required and must also be `false`.\n",
            "enum": [
              "com.jamf.ddm.app-managed"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "ManagedAppConfig": {
        "description": "App or extension config data and credentials. Requires macOS 27.0+.",
        "properties": {
          "Certificates": {
            "description": "Certificates to provide to the app or extension. Each entry pairs a certificate asset\nreference with an identifier the app uses to look the certificate up.\n",
            "items": {
              "$ref": "#/components/schemas/ManagedAppCredentialConfig"
            },
            "type": "array"
          },
          "DataAssetReference": {
            "description": "Identifier of an asset declaration containing a reference to the app or extension\nconfig data. The asset must be of type `com.apple.asset.data`, the referenced data\nmust be a property list file, and the asset's `ContentType` must match the data type.\n",
            "example": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
            "type": "string"
          },
          "Identities": {
            "description": "Identities to provide to the app or extension. Each entry pairs an identity asset\nreference with an identifier the app uses to look the identity up.\n",
            "items": {
              "$ref": "#/components/schemas/ManagedAppCredentialConfig"
            },
            "type": "array"
          },
          "Passwords": {
            "description": "Passwords to provide to the app or extension. Each entry pairs a password asset\nreference with an identifier the app uses to look the password up.\n",
            "items": {
              "$ref": "#/components/schemas/ManagedAppCredentialConfig"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "ManagedAppConfiguration": {
        "description": "Configuration for one or more volume purchasing apps.\n\n### Example — single required app\n\n```json\n{\n  \"apps\": [\n    {\n      \"AssetId\": \"019a8082-19ba-794c-91f4-2cd5a02b0c72\",\n      \"AppAndBookTokenId\": \"099a8082-ae9d-70be-b377-84e4ba7459c4\",\n      \"AppId\": \"com.microsoft.Excel\",\n      \"Install\": \"Required\",\n      \"AutomaticAppUpdates\": \"AlwaysOn\"\n    }\n  ]\n}\n```\n\n### Example — app with attributes (iOS 18.1+)\n\n```json\n{\n  \"apps\": [\n    {\n      \"AssetId\": \"019a8082-19ba-794c-91f4-2cd5a02b0c72\",\n      \"AppAndBookTokenId\": \"099a8082-ae9d-70be-b377-84e4ba7459c4\",\n      \"AppId\": \"com.microsoft.Excel\",\n      \"Install\": \"Required\",\n      \"AllowDownloadsOverCellular\": \"AlwaysOff\",\n      \"AutomaticAppUpdates\": \"AlwaysOn\",\n      \"IncludeInBackup\": true,\n      \"Attributes\": {\n        \"Hideable\": true,\n        \"Lockable\": true,\n        \"AssociatedDomains\": [\"corp.example.com\"],\n        \"AssociatedDomainsEnableDirectDownloads\": false\n      }\n    }\n  ]\n}\n```\n\n### Example — multiple apps in one component\n\n```json\n{\n  \"apps\": [\n    {\n      \"AssetId\": \"019a8082-19ba-794c-91f4-2cd5a02b0c72\",\n      \"AppAndBookTokenId\": \"099a8082-ae9d-70be-b377-84e4ba7459c4\",\n      \"AppId\": \"com.microsoft.Excel\",\n      \"Install\": \"Required\"\n    },\n    {\n      \"AssetId\": \"12345678-0000-0000-0000-000000000001\",\n      \"AppAndBookTokenId\": \"099a8082-ae9d-70be-b377-84e4ba7459c4\",\n      \"AppId\": \"com.microsoft.Word\",\n      \"Install\": \"Optional\",\n      \"AutomaticAppUpdates\": \"StoreSettings\"\n    }\n  ]\n}\n```\n",
        "properties": {
          "apps": {
            "description": "One or more volume purchasing app configurations to include in this component.",
            "items": {
              "$ref": "#/components/schemas/ManagedAppEntry"
            },
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "apps"
        ],
        "type": "object"
      },
      "ManagedAppCredentialConfig": {
        "description": "A credential asset reference and the identifier the app looks it up by.",
        "properties": {
          "AssetReference": {
            "description": "Identifier of the asset declaration containing the credential.",
            "example": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
            "type": "string"
          },
          "Identifier": {
            "description": "The identifier the app or extension uses to fetch this credential through the\n`ManagedApp` framework. App developers define these values.\n",
            "example": "app-identity",
            "type": "string"
          }
        },
        "required": [
          "Identifier",
          "AssetReference"
        ],
        "type": "object"
      },
      "ManagedAppDeclaration": {
        "description": "Manages an app installed by other means (App Store, a manifest URL, or a\npackage). For volume purchasing (VPP) apps, use the `com.jamf.ddm.app-managed`\ncomponent instead.\n",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/ManagedAppDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.app.managed"
            ],
            "example": "com.apple.configuration.app.managed",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Managed App",
        "type": "object"
      },
      "ManagedAppDeclarationPayload": {
        "description": "Payload fields for the Managed App declaration.\n\n\u003e **Validation rule:** One of `AppStoreID`, `BundleID`, or `AppComposedIdentifier` is required.\n",
        "example": {
          "AppStoreID": "361285480",
          "InstallBehavior": {
            "Install": "Required",
            "License": {
              "Assignment": "Device"
            }
          }
        },
        "properties": {
          "AppComposedIdentifier": {
            "description": "Identifies an existing app to take over management of, formatted `Bundle-ID` or `Bundle-ID (Team-ID)`.",
            "example": "com.example.app (ABCD1234)",
            "type": "string"
          },
          "AppConfig": {
            "$ref": "#/components/schemas/ManagedAppConfig"
          },
          "AppStoreID": {
            "description": "App Store ID of the app. One of `AppStoreID`, `BundleID`, or `AppComposedIdentifier` is required.",
            "example": "361285480",
            "pattern": "^[0-9]+$",
            "type": "string"
          },
          "BundleID": {
            "description": "Bundle ID of an App Store app.",
            "example": "com.example.app",
            "type": "string"
          },
          "ExtensionConfigs": {
            "$ref": "#/components/schemas/ManagedAppExtensionConfigs"
          },
          "InstallBehavior": {
            "$ref": "#/components/schemas/ManagedAppInstallBehavior"
          },
          "LegacyAppConfigAssetReference": {
            "description": "Identifier of an asset declaration providing app config data via the MDMv1 behavior. Requires macOS 27.0+.",
            "example": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
            "type": "string"
          },
          "UpdateBehavior": {
            "$ref": "#/components/schemas/ManagedAppUpdateBehavior"
          },
          "iOSApp": {
            "default": false,
            "description": "If `true`, installs an iOS/iPadOS App Store app on Apple silicon Macs.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "ManagedAppEntry": {
        "description": "Configuration for a single volume purchasing app.",
        "properties": {
          "AllowDownloadsOverCellular": {
            "description": "Controls whether the app can be downloaded over a cellular connection.",
            "enum": [
              "AlwaysOn",
              "AlwaysOff",
              "StoreSettings"
            ],
            "example": "StoreSettings",
            "type": "string"
          },
          "AppAndBookTokenId": {
            "description": "Identifier of the volume purchasing token that licenses this app.",
            "example": "099a8082-ae9d-70be-b377-84e4ba7459c4",
            "type": "string"
          },
          "AppId": {
            "description": "App bundle identifier.",
            "example": "com.microsoft.Excel",
            "type": "string"
          },
          "AssetId": {
            "description": "volume purchasing asset identifier for the app.",
            "example": "019a8082-19ba-794c-91f4-2cd5a02b0c72",
            "type": "string"
          },
          "Attributes": {
            "$ref": "#/components/schemas/ManagedAppAttributes"
          },
          "AutomaticAppUpdates": {
            "description": "Controls whether the app updates automatically.",
            "enum": [
              "AlwaysOn",
              "AlwaysOff",
              "StoreSettings"
            ],
            "example": "AlwaysOn",
            "type": "string"
          },
          "IncludeInBackup": {
            "description": "Whether the app's data is included in device backups.",
            "example": true,
            "type": "boolean"
          },
          "Install": {
            "description": "Whether the app must be installed on devices in scope.",
            "enum": [
              "Required",
              "Optional"
            ],
            "example": "Required",
            "type": "string"
          }
        },
        "required": [
          "AssetId",
          "AppAndBookTokenId",
          "AppId"
        ],
        "type": "object"
      },
      "ManagedAppExtensionConfigs": {
        "additionalProperties": {
          "$ref": "#/components/schemas/ManagedAppConfig"
        },
        "description": "Maps an extension composed identifier (`Bundle-ID` or `Bundle-ID (Team-ID)`) to its config.",
        "type": "object"
      },
      "ManagedAppInstallBehavior": {
        "description": "Describes how and when to install the app.",
        "properties": {
          "Install": {
            "default": "Optional",
            "description": "Whether the app remains on the device at all times.",
            "enum": [
              "Optional",
              "Required"
            ],
            "type": "string"
          },
          "License": {
            "$ref": "#/components/schemas/ManagedAppLicense"
          },
          "Version": {
            "description": "App Store external version identifier (EVID) to install.",
            "example": 834261235,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "ManagedAppLicense": {
        "description": "The app's license.",
        "properties": {
          "Assignment": {
            "description": "License type for an App Store app.",
            "enum": [
              "Device",
              "User"
            ],
            "example": "Device",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ManagedAppUpdateBehavior": {
        "description": "Specifies how the device updates the app.",
        "properties": {
          "AutomaticAppUpdates": {
            "description": "Whether the device automatically updates the app.",
            "enum": [
              "AlwaysOn",
              "AlwaysOff",
              "StoreSettings"
            ],
            "example": "StoreSettings",
            "type": "string"
          }
        },
        "required": [
          "AutomaticAppUpdates"
        ],
        "type": "object"
      },
      "ManagedExtension": {
        "properties": {
          "AllowedDomains": {
            "description": "Allowed domains",
            "items": {
              "$ref": "#/components/schemas/ManagedExtensionDomain"
            },
            "type": "array"
          },
          "DeniedDomains": {
            "description": "Denied domains",
            "items": {
              "$ref": "#/components/schemas/ManagedExtensionDomain"
            },
            "type": "array"
          },
          "PrivateBrowsing": {
            "description": "Private Browsing state",
            "enum": [
              "Allowed",
              "AlwaysOn",
              "AlwaysOff"
            ],
            "type": "string"
          },
          "State": {
            "description": "Extension state",
            "enum": [
              "Allowed",
              "AlwaysOn",
              "AlwaysOff"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "ManagedExtensionDomain": {
        "properties": {
          "Domain": {
            "description": "Domain",
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "Domain"
        ],
        "type": "object"
      },
      "MathNotesMode": {
        "properties": {
          "Enabled": {
            "description": "Controls whether the mode is enabled.",
            "type": "boolean"
          },
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          }
        },
        "required": [
          "Enabled"
        ],
        "type": "object"
      },
      "MathSettingsComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/MathSettingsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.math-settings"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "MathSettingsConfiguration": {
        "description": "Math settings configuration.\n\nConfigures Calculator app modes and system-wide math behavior including keyboard suggestions and Math Notes.\n",
        "properties": {
          "Calculator": {
            "$ref": "#/components/schemas/Calculator",
            "description": "If present, configures the built-in Calculator app."
          },
          "SystemBehavior": {
            "$ref": "#/components/schemas/SystemBehavior",
            "description": "If present, configures math behavior in the system."
          }
        },
        "type": "object"
      },
      "MaximumFailedAttempts": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "default": 11,
            "description": "Maximum failed attempts",
            "example": 10,
            "format": "int32",
            "maximum": 11,
            "minimum": 2,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "MaximumGracePeriodInMinutes": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Maximum grace period in minutes",
            "example": 2,
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "MaximumInactivityInMinutes": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Maximum inactivity in minutes",
            "example": 10,
            "format": "int32",
            "maximum": 15,
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "MaximumPasscodeAgeInDays": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Maximum passcode age in days",
            "example": 14,
            "format": "int32",
            "maximum": 730,
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "Meta": {
        "description": "Meta object containing additional information about component",
        "properties": {
          "supportedOs": {
            "additionalProperties": {
              "description": "Supported version of OS families",
              "example": {
                "iOS": [
                  {
                    "version": "13.0"
                  }
                ],
                "macOS": [
                  {
                    "version": "12.5"
                  }
                ]
              },
              "items": {
                "$ref": "#/components/schemas/SupportedOs"
              },
              "type": "array"
            },
            "description": "Supported version of OS families",
            "example": {
              "iOS": [
                {
                  "version": "13.0"
                }
              ],
              "macOS": [
                {
                  "version": "12.5"
                }
              ]
            },
            "type": "object"
          }
        },
        "required": [
          "supportedOs"
        ],
        "type": "object"
      },
      "MinimumComplexCharacters": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "default": 0,
            "description": "Minimum complex characters",
            "example": 1,
            "format": "int32",
            "maximum": 4,
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "MinimumLength": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "default": 0,
            "description": "Minimum length",
            "example": 8,
            "format": "int32",
            "maximum": 16,
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "NewTabStartPage": {
        "properties": {
          "ExtensionIdentifier": {
            "description": "The composed identifier of the extension that provides the start page",
            "example": "com.example.extension (ABC1234567)",
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*(?:\\.[a-zA-Z0-9\\-]+)+ \\([A-Z0-9]{10}\\)$",
            "type": "string"
          },
          "HomepageURL": {
            "description": "The URL of the homepage which needs to start with https:// or http://",
            "example": "https://example.com",
            "pattern": "^https?://.*$",
            "type": "string"
          },
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "PageType": {
            "description": "Sets the start page type in Safari",
            "enum": [
              "Start",
              "Home",
              "Extension"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "OptionalPeriodInDays": {
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "format": "int32",
            "maximum": 90,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "OptionallyEnabled": {
        "properties": {
          "Enabled": {
            "type": "boolean"
          },
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          }
        },
        "required": [
          "Enabled"
        ],
        "type": "object"
      },
      "PackageDeclaration": {
        "description": "Installs a package (apps, fonts, documents, or other items) on macOS. Apps a\npackage installs are not automatically managed; use the Managed App declaration\nfor that.\n",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/PackageDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.package"
            ],
            "example": "com.apple.configuration.package",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Package",
        "type": "object"
      },
      "PackageDeclarationPayload": {
        "description": "Payload fields for the Package declaration.",
        "example": {
          "InstallBehavior": {
            "Install": "Required"
          },
          "ManifestURL": "https://example.com/files/packages/TestPackage.plist"
        },
        "properties": {
          "InstallBehavior": {
            "$ref": "#/components/schemas/PackageInstallBehavior"
          },
          "ManifestURL": {
            "description": "URL of the manifest document for the package (`.pkg`) to install.",
            "example": "https://example.com/files/packages/TestPackage.plist",
            "type": "string"
          },
          "UninstallBehavior": {
            "$ref": "#/components/schemas/PackageUninstallBehavior"
          }
        },
        "required": [
          "ManifestURL"
        ],
        "type": "object"
      },
      "PackageInstallBehavior": {
        "description": "Describes how and when to install the package.",
        "properties": {
          "Install": {
            "default": "Optional",
            "enum": [
              "Optional",
              "Required"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "PackageUninstallBehavior": {
        "description": "macOS 27.0+.",
        "properties": {
          "Remove": {
            "default": false,
            "description": "If `true`, removes the files the package installed when the configuration is removed.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "PagedResponseBlueprintOverview": {
        "properties": {
          "results": {
            "description": "Array of result items",
            "items": {
              "$ref": "#/components/schemas/BlueprintOverview"
            },
            "type": "array"
          },
          "totalCount": {
            "description": "Total number of items matching the filter",
            "example": 100,
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "results"
        ],
        "type": "object"
      },
      "PagedResponseComponentDescription": {
        "properties": {
          "results": {
            "description": "Array of result items",
            "items": {
              "$ref": "#/components/schemas/ComponentDescription"
            },
            "type": "array"
          },
          "totalCount": {
            "description": "Total number of items matching the filter",
            "example": 100,
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "results"
        ],
        "type": "object"
      },
      "PasscodeReuseLimit": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Passcode reuse limit",
            "example": 10,
            "format": "int32",
            "maximum": 50,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "PasscodeSettingsComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/PasscodeSettingsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.passcode-settings"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "PasscodeSettingsConfiguration": {
        "description": "Passcode settings configuration.\n\nConfigures device passcode requirements including complexity, length, and expiration.\n",
        "properties": {
          "ChangeAtNextAuth": {
            "$ref": "#/components/schemas/ChangeAtNextAuth"
          },
          "CustomRegex": {
            "$ref": "#/components/schemas/CustomRegex"
          },
          "FailedAttemptsResetInMinutes": {
            "$ref": "#/components/schemas/FailedAttemptsResetInMinutes"
          },
          "MaximumFailedAttempts": {
            "$ref": "#/components/schemas/MaximumFailedAttempts"
          },
          "MaximumGracePeriodInMinutes": {
            "$ref": "#/components/schemas/MaximumGracePeriodInMinutes"
          },
          "MaximumInactivityInMinutes": {
            "$ref": "#/components/schemas/MaximumInactivityInMinutes"
          },
          "MaximumPasscodeAgeInDays": {
            "$ref": "#/components/schemas/MaximumPasscodeAgeInDays"
          },
          "MinimumComplexCharacters": {
            "$ref": "#/components/schemas/MinimumComplexCharacters"
          },
          "MinimumLength": {
            "$ref": "#/components/schemas/MinimumLength"
          },
          "PasscodeReuseLimit": {
            "$ref": "#/components/schemas/PasscodeReuseLimit"
          },
          "RequireAlphanumericPasscode": {
            "$ref": "#/components/schemas/RequireAlphanumericPasscode"
          },
          "RequireComplexPasscode": {
            "$ref": "#/components/schemas/RequireComplexPasscode"
          },
          "RequirePasscode": {
            "$ref": "#/components/schemas/RequirePasscode"
          },
          "version": {
            "description": "Configuration version",
            "enum": [
              2
            ],
            "format": "int32",
            "type": "integer"
          }
        },
        "required": [
          "version"
        ],
        "type": "object"
      },
      "ProgrammerMode": {
        "properties": {
          "Enabled": {
            "description": "Controls whether the mode is enabled.",
            "type": "boolean"
          },
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          }
        },
        "required": [
          "Enabled"
        ],
        "type": "object"
      },
      "RapidSecurityResponse": {
        "properties": {
          "Enable": {
            "$ref": "#/components/schemas/OptionallyEnabled"
          },
          "EnableRollback": {
            "$ref": "#/components/schemas/OptionallyEnabled"
          }
        },
        "type": "object"
      },
      "RecommendedCadence": {
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "enum": [
              "All",
              "Oldest",
              "Newest"
            ],
            "type": "string"
          }
        },
        "required": [
          "Value"
        ],
        "type": "object"
      },
      "RequireAlphanumericPasscode": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Require alphanumeric passcode",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "RequireComplexPasscode": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Require complex passcode",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "RequirePasscode": {
        "properties": {
          "Included": {
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Require passcode",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "Restrictions": {
        "description": "Storage restrictions configuration",
        "properties": {
          "ExternalStorage": {
            "$ref": "#/components/schemas/StorageMode"
          },
          "NetworkStorage": {
            "$ref": "#/components/schemas/StorageMode"
          }
        },
        "type": "object"
      },
      "SafariBookmarksComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SafariBookmarksConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.safari-bookmarks"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "SafariBookmarksConfiguration": {
        "description": "Safari bookmarks configuration.\n\nDefines managed bookmark groups and folders that appear in Safari across managed devices.\n",
        "properties": {
          "ManagedBookmarks": {
            "description": "A dictionary that specifies a set of managed bookmarks",
            "items": {
              "$ref": "#/components/schemas/BookmarkGroup"
            },
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "ManagedBookmarks"
        ],
        "type": "object"
      },
      "SafariExtensionsComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SafariExtensionsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.safari-extensions"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "SafariExtensionsConfiguration": {
        "description": "Safari extensions configuration.\n\nManages Safari browser extensions including allowed/denied domains and private browsing settings.\n",
        "properties": {
          "ManagedExtensions": {
            "additionalProperties": {
              "$ref": "#/components/schemas/ManagedExtension"
            },
            "type": "object"
          }
        },
        "required": [
          "ManagedExtensions"
        ],
        "type": "object"
      },
      "SafariSettingsComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SafariSettingsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.safari-settings"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "SafariSettingsConfiguration": {
        "description": "Safari settings configuration.\n\nConfigures Safari browser behavior including cookies, JavaScript, popups, private browsing, and start page settings.\n",
        "properties": {
          "AcceptCookies": {
            "$ref": "#/components/schemas/AcceptCookies",
            "description": "The policy Safari uses for managing cookies"
          },
          "AllowDisablingFraudWarning": {
            "$ref": "#/components/schemas/AllowDisablingFraudWarning",
            "description": "If false, the system forces fraud warnings on in Safari"
          },
          "AllowHistoryClearing": {
            "$ref": "#/components/schemas/AllowHistoryClearing",
            "description": "If false, the system disables clearing history in Safari"
          },
          "AllowJavaScript": {
            "$ref": "#/components/schemas/AllowJavaScript",
            "description": "If false, the system disables JavaScript in Safari"
          },
          "AllowPopups": {
            "$ref": "#/components/schemas/AllowPopups",
            "description": "If false, the system disables popups in Safari"
          },
          "AllowPrivateBrowsing": {
            "$ref": "#/components/schemas/AllowPrivateBrowsing",
            "description": "If false, the system disables private browsing in Safari"
          },
          "AllowSummary": {
            "$ref": "#/components/schemas/AllowSummary",
            "description": "If false, the system disables summarization of content in Safari"
          },
          "NewTabStartPage": {
            "$ref": "#/components/schemas/NewTabStartPage",
            "description": "Sets the start page for new tabs in Safari"
          }
        },
        "type": "object"
      },
      "ScientificMode": {
        "properties": {
          "Enabled": {
            "description": "Controls whether the mode is enabled.",
            "type": "boolean"
          },
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          }
        },
        "required": [
          "Enabled"
        ],
        "type": "object"
      },
      "ScreenSharingConnectionDeclaration": {
        "description": "Configures a connection to a screen-sharing host. macOS only.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/ScreenSharingConnectionDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.screensharing.connection"
            ],
            "example": "com.apple.configuration.screensharing.connection",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Screen Sharing Connection",
        "type": "object"
      },
      "ScreenSharingConnectionDeclarationPayload": {
        "description": "Payload fields for the Screen Sharing Connection declaration.",
        "example": {
          "ConnectionUUID": "FA80E209-B31B-4862-B880-399F79E8FC35",
          "DisplayConfiguration": {
            "DisplayType": "Virtual1"
          },
          "DisplayName": "Host1",
          "HostName": "example.com"
        },
        "properties": {
          "AuthenticationCredentialsAssetReference": {
            "description": "Asset declaration identifier of type `com.apple.asset.credential.userpassword` providing authentication credentials.",
            "example": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
            "type": "string"
          },
          "ConnectionUUID": {
            "description": "Unique identifier for this connection when it is a member of a connection group.",
            "example": "FA80E209-B31B-4862-B880-399F79E8FC35",
            "type": "string"
          },
          "DisplayConfiguration": {
            "$ref": "#/components/schemas/ScreenSharingDisplayConfiguration"
          },
          "DisplayName": {
            "description": "The name of the connection.",
            "example": "Host1",
            "type": "string"
          },
          "HostName": {
            "description": "Host name or IP address of the screen-sharing host.",
            "example": "example.com",
            "type": "string"
          },
          "Port": {
            "description": "TCP port to initiate the connection on.",
            "example": 5900,
            "type": "integer"
          }
        },
        "required": [
          "ConnectionUUID",
          "DisplayName",
          "HostName",
          "DisplayConfiguration"
        ],
        "type": "object"
      },
      "ScreenSharingConnectionGroupDeclaration": {
        "description": "Groups multiple Screen Sharing Connection declarations together. macOS only.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/ScreenSharingConnectionGroupDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.screensharing.connection.group"
            ],
            "example": "com.apple.configuration.screensharing.connection.group",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Screen Sharing Connection Group",
        "type": "object"
      },
      "ScreenSharingConnectionGroupDeclarationPayload": {
        "description": "Payload fields for the Screen Sharing Connection Group declaration.",
        "example": {
          "ConnectionGroupUUID": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
          "GroupName": "Lab Devices",
          "Members": [
            "7F8F28A5-C024-470B-8166-EC6669A12C3A",
            "EDF04C7F-F9B0-4204-A5EE-34AE094CA7BB"
          ]
        },
        "properties": {
          "ConnectionGroupUUID": {
            "description": "Unique identifier for this connection group.",
            "example": "4BF32552-6F85-4F67-999B-7B2494C4DD99",
            "type": "string"
          },
          "GroupName": {
            "description": "The name of the connection group.",
            "example": "Lab Devices",
            "type": "string"
          },
          "Members": {
            "description": "`ConnectionUUID` values of Screen Sharing Connection declarations that belong to this group.",
            "example": [
              "7F8F28A5-C024-470B-8166-EC6669A12C3A"
            ],
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "ConnectionGroupUUID",
          "GroupName",
          "Members"
        ],
        "type": "object"
      },
      "ScreenSharingDisplayConfiguration": {
        "description": "Display configuration for a screen-sharing connection.",
        "properties": {
          "DisplayType": {
            "description": "Number of virtual displays to create.",
            "enum": [
              "Virtual1",
              "Virtual2"
            ],
            "example": "Virtual1",
            "type": "string"
          }
        },
        "required": [
          "DisplayType"
        ],
        "type": "object"
      },
      "ScreenSharingHostSettingsDeclaration": {
        "description": "Restricts how a device behaves as a screen-sharing host. macOS only.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/ScreenSharingHostSettingsDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.screensharing.host.settings"
            ],
            "example": "com.apple.configuration.screensharing.host.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Screen Sharing Host Settings",
        "type": "object"
      },
      "ScreenSharingHostSettingsDeclarationPayload": {
        "description": "Payload fields for the Screen Sharing Host Settings declaration.",
        "example": {
          "MaximumVirtualDisplays": 1,
          "PortBase": 1100,
          "PreventCopyFilesFromHost": true,
          "PreventCopyFilesToHost": true,
          "PreventHighPerformanceConnections": true
        },
        "properties": {
          "MaximumVirtualDisplays": {
            "description": "Maximum virtual displays to make available to clients.",
            "example": 1,
            "maximum": 2,
            "minimum": 0,
            "type": "integer"
          },
          "PortBase": {
            "description": "Initial UDP port for the host connection. Screen sharing always establishes its first connection on TCP port 5900.",
            "example": 1100,
            "maximum": 65535,
            "minimum": 1024,
            "type": "integer"
          },
          "PreventCopyFilesFromHost": {
            "default": false,
            "type": "boolean"
          },
          "PreventCopyFilesToHost": {
            "default": false,
            "type": "boolean"
          },
          "PreventHighPerformanceConnections": {
            "default": false,
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "SiriSettingsDeclaration": {
        "description": "Configures Siri settings.",
        "properties": {
          "channelType": {
            "$ref": "#/components/schemas/DeclarationChannelType"
          },
          "kind": {
            "description": "All declarations in this component are `com.apple.configuration.*` types.",
            "enum": [
              "CONFIGURATION"
            ],
            "example": "CONFIGURATION",
            "type": "string"
          },
          "payload": {
            "$ref": "#/components/schemas/SiriSettingsDeclarationPayload"
          },
          "type": {
            "enum": [
              "com.apple.configuration.siri.settings"
            ],
            "example": "com.apple.configuration.siri.settings",
            "type": "string"
          }
        },
        "required": [
          "type",
          "channelType",
          "kind",
          "payload"
        ],
        "title": "Siri Settings",
        "type": "object"
      },
      "SiriSettingsDeclarationPayload": {
        "description": "Payload fields for the Siri Settings declaration.",
        "example": {
          "AllowSiriAI": false,
          "AllowWhileLocked": false,
          "Enabled": false,
          "ForceProfanityFilter": true
        },
        "properties": {
          "AllowSiriAI": {
            "default": true,
            "description": "Not supported on tvOS/watchOS. Requires iOS/macOS/visionOS 27.0+. If `false`, disables Siri AI features.",
            "type": "boolean"
          },
          "AllowUserGeneratedContent": {
            "default": true,
            "description": "Not supported on macOS/tvOS/visionOS.",
            "type": "boolean"
          },
          "AllowWhileLocked": {
            "default": true,
            "description": "Not supported on macOS/tvOS/visionOS.",
            "type": "boolean"
          },
          "Enabled": {
            "default": true,
            "description": "Not supported on watchOS. If `false`, disables Siri.",
            "type": "boolean"
          },
          "ForceProfanityFilter": {
            "default": false,
            "description": "Not supported on tvOS/visionOS/watchOS.",
            "type": "boolean"
          },
          "ForceReduceSensitiveContent": {
            "default": false,
            "description": "Not supported on tvOS/watchOS. Requires iOS/macOS/visionOS 27.0+.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "SoftwareUpdateSettingsComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SoftwareUpdateSettingsConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.software-update-settings"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "SoftwareUpdateSettingsConfiguration": {
        "description": "Software update settings configuration.\n\nConfigures OS update behavior including notifications, automatic actions, deferrals, and rapid security responses.\n",
        "properties": {
          "AllowStandardUserOSUpdates": {
            "$ref": "#/components/schemas/OptionallyEnabled"
          },
          "AutomaticActions": {
            "$ref": "#/components/schemas/AutomaticActions"
          },
          "Beta": {
            "$ref": "#/components/schemas/Beta"
          },
          "Deferrals": {
            "$ref": "#/components/schemas/Deferrals"
          },
          "Notifications": {
            "$ref": "#/components/schemas/OptionallyEnabled"
          },
          "RapidSecurityResponse": {
            "$ref": "#/components/schemas/RapidSecurityResponse"
          },
          "RecommendedCadence": {
            "$ref": "#/components/schemas/RecommendedCadence"
          }
        },
        "type": "object"
      },
      "StorageMode": {
        "description": "Storage access mode configuration",
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this setting should be used",
            "type": "boolean",
            "writeOnly": true
          },
          "Value": {
            "description": "Controls whether the mode is enabled.",
            "enum": [
              "Allowed",
              "Disallowed",
              "ReadOnly"
            ],
            "type": "string"
          }
        },
        "required": [
          "Value"
        ],
        "type": "object"
      },
      "SupportedOs": {
        "description": "Supported version of OS families",
        "example": {
          "iOS": [
            {
              "version": "13.0"
            }
          ],
          "macOS": [
            {
              "version": "12.5"
            }
          ]
        },
        "properties": {
          "version": {
            "description": "Version of the OS family",
            "example": "13.0",
            "type": "string"
          }
        },
        "required": [
          "version"
        ],
        "type": "object"
      },
      "SwUpdateAutomaticConfiguration": {
        "description": "Automatic software update enforcement configuration.\n\nAutomatically enforces updates based on strategy (LATEST or SEMANTIC).\n",
        "discriminator": {
          "mapping": {
            "LATEST": "#/components/schemas/SwUpdateLatestConfiguration",
            "SEMANTIC": "#/components/schemas/SwUpdateSemanticConfiguration"
          },
          "propertyName": "strategy"
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/SwUpdateLatestConfiguration"
          },
          {
            "$ref": "#/components/schemas/SwUpdateSemanticConfiguration"
          }
        ],
        "properties": {
          "strategy": {
            "description": "Strategy for enforcing automatic OS updates",
            "type": "string"
          }
        },
        "type": "object"
      },
      "SwUpdateComponent": {
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SwUpdateConfiguration"
          },
          "identifier": {
            "enum": [
              "com.jamf.ddm.sw-updates"
            ],
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "configuration"
        ],
        "type": "object"
      },
      "SwUpdateConfiguration": {
        "description": "Software update enforcement configuration.\n\nConfigures OS update enforcement using either manual (specific version by date) or automatic strategies.\n",
        "oneOf": [
          {
            "$ref": "#/components/schemas/SwUpdateManualConfiguration"
          },
          {
            "$ref": "#/components/schemas/SwUpdateAutomaticConfiguration"
          }
        ],
        "properties": {
          "enforcementType": {
            "description": "Type of software update enforcement strategy",
            "type": "string"
          }
        },
        "type": "object"
      },
      "SwUpdateLatestConfiguration": {
        "description": "Automatic software update with LATEST strategy.\nEnforces the newest available OS version a specified number of days after release.\n",
        "properties": {
          "deploymentTime": {
            "description": "The device local time (HH:MM) when the update should be installed",
            "example": "16:00",
            "type": "string"
          },
          "detailsURL": {
            "$ref": "#/components/schemas/DetailsUrl"
          },
          "enforceAfterDays": {
            "description": "The number of days after the OS update release",
            "example": 14,
            "format": "int32",
            "maximum": 30,
            "minimum": 0,
            "type": "integer"
          },
          "enforcementType": {
            "enum": [
              "AUTOMATIC"
            ],
            "type": "string"
          },
          "strategy": {
            "enum": [
              "LATEST"
            ],
            "type": "string"
          }
        },
        "required": [
          "enforcementType",
          "strategy",
          "enforceAfterDays",
          "deploymentTime"
        ],
        "type": "object"
      },
      "SwUpdateManualConfiguration": {
        "description": "Manual software update enforcement configuration.\n\nEnforces a specific OS version by a specific date/time.\n",
        "properties": {
          "detailsURL": {
            "$ref": "#/components/schemas/DetailsUrl"
          },
          "enforcementType": {
            "enum": [
              "MANUAL"
            ],
            "type": "string"
          },
          "targetLocalDateTime": {
            "description": "Local time of the device until which update must be performed",
            "example": "2025-07-10T10:45:06.809",
            "format": "date-time",
            "type": "string"
          },
          "targetOSVersion": {
            "description": "Target OS version in semantic versioning format",
            "example": "15.0.1",
            "pattern": "^[1-9]\\d?(?:\\.(?:\\d|[1-9]\\d)){1,2}$",
            "type": "string"
          }
        },
        "required": [
          "enforcementType",
          "targetOSVersion",
          "targetLocalDateTime"
        ],
        "type": "object"
      },
      "SwUpdateSemanticConfiguration": {
        "description": "Automatic software update with SEMANTIC strategy.\nApplies semantic versioning rules to determine update enforcement timing.\n",
        "properties": {
          "detailsURL": {
            "$ref": "#/components/schemas/DetailsUrl"
          },
          "enforcementType": {
            "enum": [
              "AUTOMATIC"
            ],
            "type": "string"
          },
          "rules": {
            "$ref": "#/components/schemas/UpdateRules"
          },
          "strategy": {
            "enum": [
              "SEMANTIC"
            ],
            "type": "string"
          }
        },
        "required": [
          "enforcementType",
          "strategy",
          "rules"
        ],
        "type": "object"
      },
      "SystemBehavior": {
        "properties": {
          "Included": {
            "default": true,
            "description": "Controls whether this control should be used.",
            "type": "boolean",
            "writeOnly": true
          },
          "KeyboardSuggestions": {
            "description": "Controls whether keyboard suggestions include math solutions.",
            "type": "boolean"
          },
          "MathNotes": {
            "description": "Controls whether Math Notes is allowed in other apps such as Notes.",
            "type": "boolean"
          }
        },
        "required": [
          "KeyboardSuggestions",
          "MathNotes"
        ],
        "type": "object"
      },
      "TemporaryPairing": {
        "description": "Temporary pairing configuration",
        "properties": {
          "Configuration": {
            "$ref": "#/components/schemas/TemporaryPairingConfig"
          },
          "Disabled": {
            "default": false,
            "description": "If true, temporary pairing of audio accessories is disabled",
            "type": "boolean"
          },
          "Included": {
            "default": true,
            "description": "Controls whether this setting should be used",
            "type": "boolean",
            "writeOnly": true
          }
        },
        "type": "object"
      },
      "TemporaryPairingConfig": {
        "description": "Temporary pairing configuration details",
        "properties": {
          "UnpairingTime": {
            "$ref": "#/components/schemas/UnpairingTime"
          }
        },
        "required": [
          "UnpairingTime"
        ],
        "type": "object"
      },
      "UnpairingTime": {
        "description": "Automatic unpairing time configuration",
        "properties": {
          "Hour": {
            "description": "Local time hour (24-hour clock) for automatic unpairing. Required when Policy is \"Hour\".",
            "format": "int32",
            "maximum": 23,
            "minimum": 0,
            "type": "integer"
          },
          "Policy": {
            "description": "A string that specifies the device's unpairing policy.",
            "enum": [
              "None",
              "Hour"
            ],
            "type": "string"
          }
        },
        "required": [
          "Policy"
        ],
        "type": "object"
      },
      "UpdateBlueprintRequest": {
        "properties": {
          "description": {
            "description": "Description of the blueprint",
            "example": "Keep all eligible MacOS devices updated to the last major version",
            "maxLength": 2000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Name of the blueprint",
            "example": "Update software to latest version",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "scope": {
            "$ref": "#/components/schemas/BlueprintScope"
          },
          "steps": {
            "description": "Array of blueprint steps",
            "items": {
              "$ref": "#/components/schemas/BlueprintStep"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "UpdateRule": {
        "description": "Configuration for a specific update type",
        "properties": {
          "deploymentTime": {
            "description": "The device local time (HH:MM) when the update should be installed",
            "example": "16:00",
            "type": "string"
          },
          "enforceAfterDays": {
            "description": "The number of days after the OS update release",
            "example": 14,
            "format": "int32",
            "maximum": 30,
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "enforceAfterDays",
          "deploymentTime"
        ],
        "type": "object"
      },
      "UpdateRules": {
        "description": "Rules for semantic update strategy",
        "properties": {
          "minor": {
            "$ref": "#/components/schemas/UpdateRule"
          }
        },
        "required": [
          "minor"
        ],
        "type": "object"
      },
      "UrlBookmarkItem": {
        "properties": {
          "Title": {
            "description": "The title of the bookmark shown in Safari",
            "minLength": 1,
            "type": "string"
          },
          "Type": {
            "enum": [
              "BOOKMARK"
            ],
            "type": "string"
          },
          "URL": {
            "description": "The URL for the bookmark item",
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "Type",
          "Title",
          "URL"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "oauth2": {
        "description": "Obtain an access token by calling the API Gateway's token endpoint using the OAuth2 client-credentials flow.",
        "flows": {
          "clientCredentials": {
            "scopes": {
              "blueprints:create": "",
              "blueprints:delete": "",
              "blueprints:deploy": "",
              "blueprints:read": "",
              "blueprints:update": ""
            },
            "tokenUrl": "https://{region}.api.jamfcloud.com/auth/token"
          }
        },
        "type": "oauth2"
      }
    }
  },
  "info": {
    "contact": {
      "name": "Jamf Developer",
      "url": "https://developer.jamf.com"
    },
    "description": "Blueprints simplify the creation of complex workflows by leveraging declarative device management to ensure devices meet a particular management state. You can use blueprints to scope management settings to devices using customizable components that include payloads and their configurable settings, all in one location.",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement/",
    "title": "Blueprints",
    "version": "v0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/blueprint-components": {
      "get": {
        "description": "Get list of available blueprint components\n\n**Required Permissions:** `blueprints:read`",
        "operationId": "listComponents",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Zero-based page index (0..N)",
            "in": "query",
            "name": "page",
            "schema": {
              "default": 0,
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            }
          },
          {
            "description": "The size of the page to be returned",
            "in": "query",
            "name": "page-size",
            "schema": {
              "default": 100,
              "format": "int32",
              "minimum": 1,
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResponseComponentDescription"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:read"
            ]
          }
        ],
        "summary": "List available blueprint components",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:read"
        ]
      }
    },
    "/v1/blueprint-components/{identifier}": {
      "get": {
        "description": "Get component by identifier\n\n**Required Permissions:** `blueprints:read`",
        "operationId": "getComponent",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Identifier of the component",
            "in": "path",
            "name": "identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ComponentDescription"
                }
              }
            },
            "description": "Blueprint component was found"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint component was not found"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:read"
            ]
          }
        ],
        "summary": "Get component",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:read"
        ]
      }
    },
    "/v1/blueprints": {
      "get": {
        "description": "Get list of blueprints\n\n**Required Permissions:** `blueprints:read`",
        "operationId": "listBlueprints",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Zero-based page index (0..N)",
            "in": "query",
            "name": "page",
            "schema": {
              "default": 0,
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            }
          },
          {
            "description": "The size of the page to be returned",
            "in": "query",
            "name": "page-size",
            "schema": {
              "default": 100,
              "format": "int32",
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "Sorting criteria in the format: `\u003cfield_name\u003e[:sort_direction][,\u003csecondary_sort_field_name\u003e[:sort_direction]]*`. Default sort direction is `asc` (Ascending). Use `desc` for Descending ordering. Additional sort parameters are supported and determine order of results that have equivalent values for previous sort parameters.",
            "in": "query",
            "name": "sort",
            "schema": {
              "default": "created:desc",
              "type": "string"
            }
          },
          {
            "description": "Search query to match against `name` and `description` properties.",
            "in": "query",
            "name": "search",
            "schema": {
              "description": "Search query to match against `name` and `description` properties.",
              "maxLength": 1000,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResponseBlueprintOverview"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:read"
            ]
          }
        ],
        "summary": "List blueprints",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:read"
        ]
      },
      "post": {
        "description": "Create a new blueprint\n\n**Required Permissions:** `blueprints:create`",
        "operationId": "createBlueprint",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateBlueprintRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateResponse"
                }
              }
            },
            "description": "Blueprint was successfully created",
            "headers": {
              "Location": {
                "description": "URL of the created blueprint",
                "schema": {
                  "format": "uri",
                  "type": "string"
                },
                "style": "simple"
              }
            }
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint is invalid"
          },
          "415": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Unsupported media type"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:create"
            ]
          }
        ],
        "summary": "Create a new blueprint",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:create"
        ]
      }
    },
    "/v1/blueprints/{blueprintId}": {
      "delete": {
        "description": "Delete a blueprint\n\n**Required Permissions:** `blueprints:delete`",
        "operationId": "deleteBlueprint",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Blueprint ID",
            "in": "path",
            "name": "blueprintId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Blueprint was successfully deleted"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint wasn't found"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:delete"
            ]
          }
        ],
        "summary": "Delete a blueprint",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:delete"
        ]
      },
      "get": {
        "description": "Get a blueprint\n\n**Required Permissions:** `blueprints:read`",
        "operationId": "getBlueprint",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Blueprint ID",
            "in": "path",
            "name": "blueprintId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BlueprintDetail"
                }
              }
            },
            "description": "Blueprint was fetched successfully"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint doesn't exist"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:read"
            ]
          }
        ],
        "summary": "Get a blueprint",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:read"
        ]
      },
      "patch": {
        "description": "Updates a blueprint configuration.\n\nDivision assignment is managed outside of this API. A `divisionId` field in the\nrequest body is rejected with a `400` and error code `DIVISION_ASSIGNMENT_NOT_ALLOWED`,\nwhether it carries a value or `null`. A blueprint that is already assigned to a division\ncannot be updated here at all, and any update to it is rejected with a `409` and error\ncode `DIVISION_PATCH_NOT_ALLOWED`.\n\n\n**Required Permissions:** `blueprints:update`",
        "operationId": "patchBlueprint",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Blueprint ID",
            "in": "path",
            "name": "blueprintId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBlueprintRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "Blueprint was successfully updated"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint update is not valid, or contains fields that cannot be set through this API, such as `divisionId`"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint wasn't found"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint is assigned to a division and cannot be updated through this API"
          },
          "415": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Unsupported media type"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:update"
            ]
          }
        ],
        "summary": "Updates a blueprint configuration",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:update"
        ]
      }
    },
    "/v1/blueprints/{blueprintId}/deploy": {
      "post": {
        "description": "Deploy blueprint\n\n**Required Permissions:** `blueprints:deploy`",
        "operationId": "deployBlueprint",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Blueprint ID",
            "in": "path",
            "name": "blueprintId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Blueprint deployment was started"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint doesn't exist"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint is not valid for deployment"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:deploy"
            ]
          }
        ],
        "summary": "Deploy blueprint",
        "tags": [
          "blueprints"
        ],
        "x-action": true,
        "x-required-privileges": [
          "blueprints:deploy"
        ]
      }
    },
    "/v1/blueprints/{blueprintId}/report": {
      "get": {
        "description": "Retrieve deployment status report for a specified blueprint.\n\n**Required Permissions:** `blueprints:read`",
        "operationId": "getBlueprintStatus",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Blueprint ID",
            "in": "path",
            "name": "blueprintId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BlueprintStatusDetail"
                }
              }
            },
            "description": "Blueprint status report was fetched successfully"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint status report doesn't exist"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "The reporting is overloaded, retry the request later"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:read"
            ]
          }
        ],
        "summary": "Get blueprint status report",
        "tags": [
          "blueprints"
        ],
        "x-required-privileges": [
          "blueprints:read"
        ]
      }
    },
    "/v1/blueprints/{blueprintId}/undeploy": {
      "post": {
        "description": "Undeploy blueprint\n\n**Required Permissions:** `blueprints:deploy`",
        "operationId": "undeployBlueprint",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "description": "Blueprint ID",
            "in": "path",
            "name": "blueprintId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Blueprint undeployment was started"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Blueprint doesn't exist"
          }
        },
        "security": [
          {
            "oauth2": [
              "blueprints:deploy"
            ]
          }
        ],
        "summary": "Undeploy blueprint",
        "tags": [
          "blueprints"
        ],
        "x-action": true,
        "x-required-privileges": [
          "blueprints:deploy"
        ]
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ],
  "servers": [
    {
      "description": "Jamf Beta API Gateway - prod",
      "url": "https://{region}.api.jamfcloud.com/blueprints",
      "variables": {
        "region": {
          "default": "us",
          "description": "Geographic deployment region",
          "enum": [
            "us",
            "eu",
            "apac"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "description": "Blueprint management",
      "name": "blueprints"
    }
  ],
  "x-scope-types": [
    "environment"
  ]
}