NOTE: This repository was forked from mapbox/node-jamf, which has since been archived. This repository will continue to live here and be maintained by @trevorspecht
A lightweight Node.js wrapper for Jamf Pro's JSS REST API.
Currently this module only supports GET
requests for the JSS REST API. Support for other methods such as PUT
, POST
, and DELETE
will be added later.
Support for the JSS Universal API may also be added later.
npm install jamf
The following code sets up the module and configures the API client with values from your local environment:
var JamfApiClient = require('jamf');
var config = {
user: process.env.JAMF_API_USER,
password: process.env.JAMF_API_PASSWORD,
jamfUrl: process.env.JAMF_URL,
format: 'json'
}
var jamf = new JamfApiClient(config);
jamf.get('/accounts', function (err, res){
if (err) console.log(err)
console.log(res)
});
Each Jamf API client method requires a path (e.g. /accounts
) and a callback (function(err, res)
) function.
For example, if you wanted to get the General and Location subsets of information about a computer with an id of 50:
jamf.get('/computers/id/50/subset/General&Location', function (err, res){
if (err) console.log(err)
console.log(res)
});
You can find more examples in the examples
directory of this project.
You need to configure the Jamf API client before it can make any API calls. You'll need the following for configuration:
user
: username for the JSS user accessing the Jamf APIpassword
: password for the above accountjamfUrl
: the URL of your JSS instance, whether on premise or in the cloud (https://yourdomain.jamfcloud.com
)format
: the format of the returned data, must be eitherxml
(Jamf API default) orjson
We recommend you create a new dedicated, least privilege API user for these scripts. The user must have the necessary privileges (create, read, update, or delete) on the JSS objects
Here's an example configuration for obtaining XML data:
var config = {
user: 'readonlyapiuser',
password: 'fakepassword',
jamfUrl: 'https://fakefakefakefake.jamfcloud.com',
format: 'xml'
}
var jamf = new JamfApiClient(config);
To run the tests for this project:
npm test
The tests use eslint for linting and tape for tests.
Are we missing something in this module? Did you find a bug?
Please look through the list of issues (both open and closed) and see if an issue already exists for what you want to propose or report.
Don't see anything in the issues? Please create a new one!
Contributors are welcome! If you want to contribute, please fork this repo then submit a pull request (PR).
All of your tests should pass both locally and in Travis before we'll accept your PR. We also request that you add additional test coverage and documentation updates in your PR where applicable.
- You can see all available Jamf API calls by accessing
/api
on your JSS instance. For example, visithttps://yourdomain.jamfcloud.com/api
. This page also contains an API playground where you can test out requests. - The Unofficial Jamf API Docs