Retirement Announcement

At this point in time, we've decided to retire the jumpcloud-node project and place it into maintenance mode, and Trueaccord will no longer be managing and maintaining this project.

We'd like to extend a huge thanks and our gratitude to all of the contributors to this project that have helped us to get this project to where it is today and for accompanying us on this journey!

If you run into any issues with this project that you believe require attention or wish to enhance it, feel free to fork this repository however we may decide to delete this repository at a future point in time.

Original README

jumpcloud-node

A JumpCloud REST API client.

About

This project is still in its very earliest stages. However the goal is to provide a useable nodeJS helper to operate against the JumpCloud API for administration. Note there is a separate Authentication and Authorization API which is not covered by this repo.

Install

$ npm install jumpcloud

Quickstart

Grab an API token from the admin console (your username in the top right > API settings).

var JumpCloud = require('jumpcloud');
var jc = new JumpCloud("XXXapikeyXXX");

jc.getAllUsers(function(x){
  for(a=0;a<x.results.length;a++){
    console.log("Username/ID: " + x.results[a].username + " / " +  x.results[a]._id);
  }
});

Documentation & Examples

See FUNCTIONS file for documentation of all functions

Examples coming soon

Testing

$ env APIKEY=XXXXapikeyXXXX npm run test

Contributors

Authored by @ShakataGaNai

License

See LICENSE file.