SwiftyJamfPro is a pure Swift client for the Jamf Pro API. The goal is to simplify the process of communicating with the Jamf Pro API by handling authentication and decoding, allowing you to focus on using the data, not retrieving it.
SwiftyJamfPro is not endorsed, sponsored, or affilitated with Jamf in any way. Swift and the Swift logo are trademarks of Apple Inc.
To include SwiftyJamfPro in a project, add it to the dependencies
attribute defined in your Package.swift
file. For example:
dependencies: [
.package(url: "https://github.com/dougonecent/SwiftyJamfPro.git")
]
Set environment variables for your base URL, username, and password. Then, in your code, fetch the environment variables and instantiate a client:
if let baseURL = ProcessInfo.processInfo.environment["BASE_URL"],
let username = ProcessInfo.processInfo.environment["JAMF_USERNAME"],
let password = ProcessInfo.processInfo.environment["JAMF_PASSWORD"] {
let client = SwiftyJamfPro(baseURL, username: username, password: password)
}
As a first pass, to meet some immediate needs, we only have one endpoint implemented: Mobile Device by ID.
if let device = try await client.classicDeviceForID(deviceID) {
// device
} else {
// no device found
}
If you have a feature or idea you would like to see added to SwiftyJamfPro, please create an issue explaining your idea with as much detail as possible.
If you come across a bug, please create an issue explaining the bug with as much detail as possible.
The Jamf Pro API provides access to a lot of information and, unfortunately, we don't have time to research and implement every endpoint. We've tried to make it as easy as possible for you to extend the library and contribute your changes. The basics for adding a new endpoint are:
- Fork this repository and clone it to your development machine.
- Create a new model based on the JSON response expected through the Jamf API. You can find this information on the Jamf API Reference site.
- Add a test to the
ModelTests.swift
file with an example of the JSON response to ensure the model is decoded properly. - Add a new function to the
SwiftyJamfProEndpoints.swift
file for your endpoint. You can simply copy one that is already there and change thepath
and the model type to match the expected response.
Please feel free to open a pull request with any additional endpoints you create. We would love to have as many of the endpoints covered as possible.
We strive to keep the code as clean as possible and follow standard Swift coding conventions, mainly the Swift API Design Guidelines and the raywenderlich.com Swift Style Guide. Please run any code changes through SwiftLint before submitting a pull request.
We provide the files needed to test your endpoints against a sandbox Jamf Pro server, but you'll have to do a little setup on your end.
- Duplicate the file
testing_parameters.sample.json
and name ittesting_parameters.json
. This is a JSON file to hold the values you will be testing against and is decoded when theEndpointTests
file is run. - Add the
testing_parameters.json
file to your Xcode project, including it in theSwiftyJamfProTests
target. - Modify the
TestingParameters.swift
model to included any additional parameters you would like to use in your tests. - Add any new testing functions to the
EndpointTests.swift
file.
SwiftyJamfPro is released under an MIT license. See LICENSE for more information.