{"id":1922,"url":"https://github.com/damien-rivet/JamfKit","last_synced_at":"2025-08-02T05:33:10.883Z","repository":{"id":56915634,"uuid":"108268015","full_name":"damien-rivet/JamfKit","owner":"damien-rivet","description":"A Jamf Classic communication framework written in Swift","archived":false,"fork":false,"pushed_at":"2019-06-10T19:05:56.000Z","size":1320,"stargazers_count":40,"open_issues_count":2,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-04T12:16:18.575Z","etag":null,"topics":["apple","carthage","cocoapods","framework","ios","jamf","jamf-pro","jss","macos","swift","tvos"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/damien-rivet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-25T12:38:31.000Z","updated_at":"2025-01-28T01:50:43.000Z","dependencies_parsed_at":"2022-08-20T21:20:11.671Z","dependency_job_id":null,"html_url":"https://github.com/damien-rivet/JamfKit","commit_stats":null,"previous_names":["ethenyl/jamfkit"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/damien-rivet/JamfKit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damien-rivet%2FJamfKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damien-rivet%2FJamfKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damien-rivet%2FJamfKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damien-rivet%2FJamfKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/damien-rivet","download_url":"https://codeload.github.com/damien-rivet/JamfKit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damien-rivet%2FJamfKit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268339405,"owners_count":24234544,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apple","carthage","cocoapods","framework","ios","jamf","jamf-pro","jss","macos","swift","tvos"],"created_at":"2024-01-05T20:15:59.061Z","updated_at":"2025-08-02T05:33:10.026Z","avatar_url":"https://github.com/damien-rivet.png","language":"Swift","funding_links":[],"categories":["SDK"],"sub_categories":["Unofficial"],"readme":"# JamfKit\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"Assets/JamfKit_256.png\" alt=\"JamfKit\"\u003e\u003c/p\u003e\n\n![Swift](https://img.shields.io/badge/Swift-5.0+-f05138.svg?style=flat-square)\n![iOS](https://img.shields.io/badge/iOS-9+-lightgrey.svg?style=flat-square)\n![macOS](https://img.shields.io/badge/macOS-10.10+-lightgrey.svg?style=flat-square)\n![tvOS](https://img.shields.io/badge/tvOS-9.0+-lightgrey.svg?style=flat-square)\n\n[![Travis branch](https://img.shields.io/travis/Ethenyl/JamfKit/master.svg?style=flat-square)](https://travis-ci.org/Ethenyl/JamfKit)\n[![Codecov](https://img.shields.io/codecov/c/github/Ethenyl/JamfKit.svg?style=flat-square)](https://codecov.io/gh/Ethenyl/JamfKit)\n[![Codacy grade](https://img.shields.io/codacy/grade/9f7907afc4884c2c9acbf1dc9412519d.svg?style=flat-square)]()\n[![Carthage compatible](https://img.shields.io/badge/carthage-compatible-4BC51D.svg?style=flat-square)](https://github.com/Carthage/Carthage)\n[![CocoaPods](https://img.shields.io/cocoapods/v/JAMFKit.svg?style=flat-square)](https://cocoapods.org/pods/JamfKit)\n\n`JamfKit` is an iOS / macOS / tvOS framework to communicate with the JSS API offered by any Jamf host.\n\n## Summary\n\n- [Features](#features)\n- [Installation](#installation)\n  - [Carthage](#carthage)\n  - [CocoaPods](#cocoapods)\n- [Architecture](#architecture)\n  - [Protocols](#protocols)\n  - [Classes](#classes)\n- [Usage](#usage)\n  - [Getting started](#getting-started)\n- [Contributing](#contributing)\n- [Code of conduct](#code-of-conduct)\n- [FAQ](#faq)\n- [Credits](#credits)\n- [License](#license)\n\n## Features\n\n- [x] Includes JSON encoding / decoding support for most of the JSS objects\n- [x] Includes Objective-C support\n- [x] Includes Swift 5+ support\n- [x] Includes ready-for-consumption CRUD `URLRequest` for JSS endpoints\n- [x] Includes demonstration playgrounds for class handling or request generation\n\n## Installation\n\n### Carthage\n\nTo integrate `JamfKit` into your project, add the following line in your `Cartfile`:\n\n```ogdl\ngithub \"Ethenyl/JamfKit\"\n```\n\nThen run the following command:\n\n`$ carthage update`\n\n### Cocoapods\n\nTo integrate `JamfKit` into your project, add the following line in your `Podfile`:\n\n```ruby\nsource 'https://github.com/CocoaPods/Specs.git'\nplatform :ios, '10.0'\nuse_frameworks!\n\ntarget '\u003cYour Target Name\u003e' do\n    pod 'JAMFKit'\nend\n```\n\nThen run the following command:\n\n`$ pod install`\n\n## Architecture\n\n### Protocols\n\n|Protocol|Description|\n|-----|-----|\n|`Endpoint`|Represents any JSS object that is matched by a JSS endpoint.|\n|`Identifiable`|Represents any JSS object that can be identified (either by ID or by name).|\n|`Requestable`|Represents an object that can be used to perform requests with any JSS endpoint.|\n|`Subset`|Represents any JSS object that contains a general object that can identify it.|\n\n#### Requestable conformance\n\n The class that conform to `Requestable` exposes the following elements:\n\n- An failable initializer that takes a JSON payload and return the instantiated object\n- A function to return the JSON payload that represents the instance of the object\n\n### Classes\n\n|Class|Desscription|\n|-----|-----|\n|`BaseObject`|Represents the common denominator between most of the JSS objects which must contains at least an `identifier` and a `name` properties.|\n|`Building`|Represents a physical building.|\n|`Computer`|Represents a computer managed by Jamf, contains the general / location / purchasing information about the hardware.|\n|`ComputerCommand`|Represents a logical command that can be executed on any hardware element manageg by Jamf.|\n|`ComputerConfigurationProfile`|Represents a logical configuration profile that can be applied to any computer managed by Jamf.|\n|`ComputerGroup`|Represents a group of computers managed by Jamf, contains grouping information.|\n|`Department`|Represents a physical department.|\n|`DirectoryBinding`|Represents a logical binding between a computer and an active directory user.|\n|`MobileDeviceConfigurationProfile`|Represents a logical configuration profile that can be applied to any mobile device managed by Jamf.|\n|`MobileDevice`|Represents a mobile device managed by Jamf, contains the general information about the device.|\n|`MobileDeviceGroup`|Represents a group of mobile devices managed by Jamf, contains grouping information.|\n|`NetbootServer`|Represents a physical netboot server, contains information about the server and it's configuration.|\n|`NetworkSegment`|Represents a physical network segment, contains information about the segment and it's configuration.|\n|`Package`|Represents a logical application package, contains information about the application requirements and capabilities.|\n|`Partition`|Represents a logical partition for an hard drive installed inside an hardware element managed by Jamf.|\n|`Policy`|Reprents as logical policy that can be applied to any hardware element managed by Jamf.|\n|`PreciseDate`|Represents a logical date within JSS api, contains 3 properties, the date itself, an epoch variant of the date and an UTC version of the date.|\n|`Printer`|Represents a physical printer, contains information about the printer and it's configuration.|\n|`Script`|Represents a logical script that can be executed on one (or more) machine managed by Jamf.|\n|`Site`|Represents a physical location (building, office, etc.).|\n|`SMTPServer`|Represents the physical SMTP server configuration.|\n|`User`|Represents a Jamf user and contains the identification properties that are required to contact the actual user and identify the hardware devices assigned to him / her.|\n\n## Usage\n\n### Getting started\n\n#### Playgrounds\n\nTo get a quick look on how you can use `JamfKit` in your `Jamf` related features, you can check the `Playgrounds` included within the workspace.\n\nAlso check the unit tests, they should cover most of your needs.\n\n#### Models\n\nMost of the classes can be initialized with the bare minimul values, all the properties are then available for modification.\n\n#### Requests\n\nBy adhering to the different CRUD protocols (`Creatable`, `Readable`, `Updatable` \u0026 `Deletable`), most of the JSS objects listed above are capable of supplying varying `URLRequest` that should fit any needs.\n\nYou'll find below the basic functions to get `URLRequest`:\n\n|Function|Type|HTTP Method|Example|Output|\n|-----|:-----:|:-----:|-----|------|\n|`createRequest()`|`instance`|`POST`|`building.createRequest()`|`http://jss.host/jss/objects/1`|\n|`readAllRequest()`|`static`|`GET`|`Building.readAllRequest()`|`http://jamf.com/jss/objects`|\n|`readRequest(identifier:)`|`static`|`GET`|`Building.readRequest(identifier: \"12345\")`|`http://jamf.com/jss/objects/1`|\n|`readRequest()`|`instance`|`GET`|`building.readRequest()`|`http://jamf.com/jss/objects/1`|\n|`updateRequest()`|`instance`|`PUT`|`building.updateRequest()`|`http://jamf.com/jss/objects/1`|\n|`deleteRequest(identifier:)`|`static`|`DELETE`|`Building.deleteRequest(identifier: \"12345\")`|`http://jamf.com/jss/objects/1`|\n|`deleteRequest()`|`instance`|`DELETE`|`building.deleteRequest()`|`http://jamf.com/jss/objects/1`|\n\nSome objects will offer variants of those requests, like `MobileDevice` with `readRequestWithName()` or `deleteRequestWithSerialNumber()` (with both `static` and `instance` variants).\n\n## Contributing\n\nSo, you want to help improve `JamfKit`? That's great! Any useful contribution is welcome!\n\nCheck [CONTRIBUTING](https://github.com/Ethenyl/JamfKit/blob/master/CONTRIBUTING.md) for more details on how you can contribute to `JamfKit`.\n\n## Code of conduct\n\nAny contributions (issues, pull requests, comments, etc.) to `JamfKit` are more than welcome.\n\nBut before making any contribution, please make sure that you follow the [CODE OF CONDUCT](https://github.com/Ethenyl/JamfKit/blob/master/CODE_OF_CONDUCT.md).\n\nOtherwise, there's a great chance that your contribution will be removed / blocked / hidden.\n\n## FAQ\n\nNone for the moment.\n\n## Credits\n\n`JamfKit` is owned and maintained by [Ethenyl](https://github.com/Ethenyl).\n\nYou can join the list by contributing to the repository.\n\n## License\n\n`JamfKit` is released under the MIT license. See [LICENSE](https://github.com/Ethenyl/JamfKit/blob/master/LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamien-rivet%2FJamfKit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdamien-rivet%2FJamfKit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamien-rivet%2FJamfKit/lists"}