gatewaysdk 0.3.2__py3-none-any.whl

gatewaysdk/environment/schema/connectors/kandji/world.json

@@ -0,0 +1,765 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:gateway:connector:kandji",
+  "$defs": {
+    "DeviceUser": {
+      "type": "object",
+      "properties": {
+        "email": {
+          "$ref": "base.json#/$defs/Email"
+        },
+        "name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "is_archived": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "email",
+        "name",
+        "id",
+        "is_archived"
+      ],
+      "additionalProperties": false
+    },
+    "Device": {
+      "type": "object",
+      "properties": {
+        "device_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "device_name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "serial_number": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "model": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "platform": {
+          "type": "string",
+          "enum": [
+            "Mac",
+            "iPhone",
+            "iPad",
+            "AppleTV",
+            "Windows",
+            "Android"
+          ]
+        },
+        "os_version": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "supplemental_build_version": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "supplemental_os_version_extra": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "blueprint_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "blueprint_name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "user": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/DeviceUser"
+            },
+            {
+              "type": "string",
+              "enum": [
+                ""
+              ]
+            }
+          ]
+        },
+        "last_check_in": {
+          "anyOf": [
+            {
+              "$ref": "base.json#/$defs/Timestamp"
+            },
+            {
+              "type": "string",
+              "enum": [
+                ""
+              ]
+            }
+          ]
+        },
+        "agent_installed": {
+          "type": "boolean"
+        },
+        "agent_version": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "mdm_enabled": {
+          "type": "boolean"
+        },
+        "is_missing": {
+          "type": "boolean"
+        },
+        "is_removed": {
+          "type": "boolean"
+        },
+        "asset_tag": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "first_enrollment": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "last_enrollment": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "lost_mode_status": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "$ref": "base.json#/$defs/Label"
+          }
+        }
+      },
+      "required": [
+        "device_id",
+        "device_name",
+        "serial_number",
+        "model",
+        "platform",
+        "os_version",
+        "supplemental_build_version",
+        "supplemental_os_version_extra",
+        "blueprint_id",
+        "blueprint_name",
+        "user",
+        "last_check_in",
+        "agent_installed",
+        "agent_version",
+        "mdm_enabled",
+        "is_missing",
+        "is_removed",
+        "asset_tag",
+        "first_enrollment",
+        "last_enrollment",
+        "tags"
+      ],
+      "additionalProperties": false
+    },
+    "Blueprint": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "icon": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "color": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "classic",
+            "map"
+          ]
+        },
+        "description": {
+          "$ref": "base.json#/$defs/Text"
+        },
+        "params": {
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        },
+        "computers_count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "enrollment_code": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "maxLength": 256
+            },
+            "is_active": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "code",
+            "is_active"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "icon",
+        "color",
+        "type",
+        "description",
+        "params",
+        "computers_count",
+        "enrollment_code"
+      ],
+      "additionalProperties": false
+    },
+    "LibraryItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "type": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "AVAILABLE",
+            "CACHED",
+            "CHANGE_PENDING",
+            "DOWNLOADING",
+            "ERROR",
+            "EXCLUDED",
+            "INCOMPATIBLE",
+            "INSTALLING",
+            "PASS",
+            "PENDING",
+            "failed",
+            "pending",
+            "success"
+          ]
+        },
+        "reported_at": {
+          "anyOf": [
+            {
+              "$ref": "base.json#/$defs/Timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "log": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "maxLength": 40000
+        },
+        "last_audit_run": {
+          "anyOf": [
+            {
+              "$ref": "base.json#/$defs/Timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "last_audit_log": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "maxLength": 40000
+        },
+        "control_log": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "maxLength": 40000
+        },
+        "control_reported_at": {
+          "anyOf": [
+            {
+              "$ref": "base.json#/$defs/Timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "rules_present": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "id",
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "BlueprintItem": {
+      "type": "object",
+      "properties": {
+        "blueprint_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "library_item_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "assignment_node_id": {
+          "$ref": "base.json#/$defs/Id"
+        }
+      },
+      "required": [
+        "blueprint_id",
+        "library_item_id"
+      ],
+      "additionalProperties": false
+    },
+    "User": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "email": {
+          "$ref": "base.json#/$defs/Email"
+        },
+        "name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "archived": {
+          "type": "boolean"
+        },
+        "created_at": {
+          "$ref": "base.json#/$defs/Timestamp"
+        },
+        "department": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "maxLength": 256
+        },
+        "deprecated_user_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "integration": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "integer"
+            },
+            "name": {
+              "$ref": "base.json#/$defs/Label"
+            },
+            "uuid": {
+              "$ref": "base.json#/$defs/Id"
+            },
+            "type": {
+              "$ref": "base.json#/$defs/Label"
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "uuid",
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        "job_title": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "maxLength": 256
+        },
+        "device_count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "updated_at": {
+          "$ref": "base.json#/$defs/Timestamp"
+        }
+      },
+      "required": [
+        "id",
+        "email",
+        "name",
+        "active",
+        "archived",
+        "created_at",
+        "department",
+        "deprecated_user_id",
+        "integration",
+        "job_title",
+        "device_count",
+        "updated_at"
+      ],
+      "additionalProperties": false
+    },
+    "Tag": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "name": {
+          "$ref": "base.json#/$defs/Label"
+        }
+      },
+      "required": [
+        "id",
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "DeviceTag": {
+      "type": "object",
+      "properties": {
+        "device_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "tag_id": {
+          "$ref": "base.json#/$defs/Id"
+        }
+      },
+      "required": [
+        "device_id",
+        "tag_id"
+      ],
+      "additionalProperties": false
+    },
+    "DeviceApp": {
+      "type": "object",
+      "properties": {
+        "device_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "bundle_id": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "app_id": {
+          "$ref": "base.json#/$defs/Id"
+        },
+        "app_name": {
+          "$ref": "base.json#/$defs/Label"
+        },
+        "version": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "bundle_size": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "app_store_vendable": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "device_based_vpp": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "source": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "process": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "signature": {
+          "$ref": "base.json#/$defs/Text"
+        },
+        "creation_date": {
+          "anyOf": [
+            {
+              "$ref": "base.json#/$defs/Timestamp"
+            },
+            {
+              "type": "string",
+              "enum": [
+                ""
+              ]
+            }
+          ]
+        },
+        "modification_date": {
+          "anyOf": [
+            {
+              "$ref": "base.json#/$defs/Timestamp"
+            },
+            {
+              "type": "string",
+              "enum": [
+                ""
+              ]
+            }
+          ]
+        },
+        "path": {
+          "type": "string",
+          "maxLength": 40000
+        }
+      },
+      "required": [
+        "device_id",
+        "bundle_id",
+        "app_id",
+        "app_name",
+        "version",
+        "bundle_size",
+        "app_store_vendable",
+        "device_based_vpp",
+        "source",
+        "process",
+        "signature",
+        "creation_date",
+        "modification_date",
+        "path"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "x-gateway": {
+    "version": 1,
+    "domain_version": "1.1.0",
+    "package": {
+      "id": "gateway-connector-kandji",
+      "version": "1.0.1"
+    },
+    "entities": {
+      "kandji_devices": {
+        "schema": {
+          "$ref": "#/$defs/Device"
+        },
+        "primary_key": [
+          "device_id"
+        ],
+        "unique": [],
+        "relationships": [
+          {
+            "fields": [
+              "blueprint_id"
+            ],
+            "target": "kandji_blueprints",
+            "on_delete": "restrict"
+          },
+          {
+            "fields": [
+              "/user/id"
+            ],
+            "target": "kandji_users",
+            "on_delete": "restrict"
+          }
+        ]
+      },
+      "kandji_blueprints": {
+        "schema": {
+          "$ref": "#/$defs/Blueprint"
+        },
+        "primary_key": [
+          "id"
+        ],
+        "unique": [
+          [
+            "name"
+          ]
+        ],
+        "relationships": []
+      },
+      "kandji_library_items": {
+        "schema": {
+          "$ref": "#/$defs/LibraryItem"
+        },
+        "primary_key": [
+          "id"
+        ],
+        "unique": [],
+        "relationships": []
+      },
+      "kandji_blueprint_items": {
+        "schema": {
+          "$ref": "#/$defs/BlueprintItem"
+        },
+        "primary_key": [
+          "blueprint_id",
+          "library_item_id"
+        ],
+        "unique": [],
+        "relationships": [
+          {
+            "fields": [
+              "blueprint_id"
+            ],
+            "target": "kandji_blueprints",
+            "on_delete": "restrict"
+          },
+          {
+            "fields": [
+              "library_item_id"
+            ],
+            "target": "kandji_library_items",
+            "on_delete": "restrict"
+          }
+        ]
+      },
+      "kandji_users": {
+        "schema": {
+          "$ref": "#/$defs/User"
+        },
+        "primary_key": [
+          "id"
+        ],
+        "unique": [],
+        "relationships": []
+      },
+      "kandji_tags": {
+        "schema": {
+          "$ref": "#/$defs/Tag"
+        },
+        "primary_key": [
+          "id"
+        ],
+        "unique": [],
+        "relationships": []
+      },
+      "kandji_device_tags": {
+        "schema": {
+          "$ref": "#/$defs/DeviceTag"
+        },
+        "primary_key": [
+          "device_id",
+          "tag_id"
+        ],
+        "unique": [],
+        "relationships": [
+          {
+            "fields": [
+              "device_id"
+            ],
+            "target": "kandji_devices",
+            "on_delete": "restrict"
+          },
+          {
+            "fields": [
+              "tag_id"
+            ],
+            "target": "kandji_tags",
+            "on_delete": "restrict"
+          }
+        ]
+      },
+      "kandji_device_apps": {
+        "schema": {
+          "$ref": "#/$defs/DeviceApp"
+        },
+        "primary_key": [
+          "device_id",
+          "bundle_id"
+        ],
+        "unique": [],
+        "relationships": [
+          {
+            "fields": [
+              "device_id"
+            ],
+            "target": "kandji_devices",
+            "on_delete": "restrict"
+          }
+        ]
+      }
+    },
+    "tools": {
+      "list_devices": {
+        "input": {
+          "type": "object",
+          "properties": {
+            "blueprint_id": {
+              "$ref": "base.json#/$defs/Id"
+            }
+          },
+          "required": [],
+          "additionalProperties": false
+        },
+        "output": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Device"
+          }
+        },
+        "description": "Devices in the tenant, optionally filtered to one blueprint."
+      },
+      "get_device": {
+        "input": {
+          "type": "object",
+          "properties": {
+            "device_id": {
+              "$ref": "base.json#/$defs/Id"
+            }
+          },
+          "required": [
+            "device_id"
+          ],
+          "additionalProperties": false
+        },
+        "output": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/Device"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "description": "One device by device_id, or null when absent."
+      },
+      "assign_blueprint": {
+        "input": {
+          "type": "object",
+          "properties": {
+            "device_id": {
+              "$ref": "base.json#/$defs/Id"
+            },
+            "blueprint_id": {
+              "$ref": "base.json#/$defs/Id"
+            }
+          },
+          "required": [
+            "device_id",
+            "blueprint_id"
+          ],
+          "additionalProperties": false
+        },
+        "output": {
+          "$ref": "#/$defs/Device"
+        },
+        "description": "Assign an existing blueprint to a device and return the device."
+      }
+    }
+  }
+}