Support Center

JumpCloud APIs

Summary


If your organization was created after Tuesday, April 11 2017, Tags are no longer applicable. Any reference to Tags in the below APIs will not function as described.  See https://docs.jumpcloud.com/ for API v2 documentation.

JumpCloud’s Directory-as-a-Service™ RESTful APIs provides access to the product’s core functionality beyond its SaaS-based user interface. This is provided via the product’s REST APIs. These are APIs that are available for “headless” operation of a number of core functions of the directory and its sub functions. These are listed below and also include  resources to get going quickly.


JumpCloud API Options


System Context API


https://github.com/TheJumpCloud/SystemContextAPI

The System Context API is designed to be used from your managed servers and takes advantage of the strong two-way SSL authenticated encryption built by our agent. The JumpCloud System Context API is a REST API for manipulating the system on which a JumpCloud Agent is installed. Once the JumpCloud Agent is installed, the JumpCloud-enabled system can now use the REST API within its own context.

This API provides you the following capabilities:
  • Setting a display name for your system
  • Assigning a system to tag(s)
  • Modifying security authentication attributes of the system
  • Deleting the system from JumpCloud automatically

General Access API


The General Access API uses a different, but still strong, authentication mechanism for access.  The JumpCloud API is a REST API for retrieving and manipulating the systems, system users, and tags managed by JumpCloud similar to the System Context API.

This API provides you the following capabilities:
  • Complete all the tasks listed above in the "system context" API
  • Add and remove users from JumpCloud
  • Add and remove users from tags
  • Create and delete tags


Authentication API


https://support.jumpcloud.com/customer/en/portal/articles/2475857-rest-based-authentication-and-authorization-api-

The Authentication API will allow you to perform authentications using a very simple REST interface.  The REST-based authentication API authenticates users managed within JumpCloud’s directory, and specifically from the JumpCloud “Users” tab only (not JumpCloud Administrators). Also, the API does not distinguish between tag membership, so it checks only that the user has an active user account in JumpCloud, and that the password to that account is correct.

 

Events API


https://support.jumpcloud.com/customer/en/portal/articles/2439622-jumpcloud-events-api

JumpCloud's Events API enables administrators to access and download data specific to events e.g., changes to your JumpCloud account, such as additions, deletions, modifications to objects or execution of operations under the control of JumpCloud. The primary use case for the Events API is to gain simple and efficient access to data logs which provide historical information utilized for compliance and auditing needs, as well as for forensics and analysis of security problems. 


Having trouble with the JumpCloud API(s)? Please see our troubleshooting guide.



Alternate Access Points

 

JumpCloud Go SDK (BETA)


https://github.com/TheJumpCloud/jcapi

The JumpCloud Go SDK can be used to access several of the JumpCloud REST APIs quickly and easily and is based upon the Go language.  Within the examples folder the JumpCloud team has also created several pieces of example code for different export options (Systems, Tags, etc.).


Configuration


Obtaining Your API Key


To interface with any of JumpCloud's available API options, a requirement is that your API key is provided during the transactions.  The below workflow will help you to identify you instance's current API key information.
 
  1. As an Administrator or Command Runner, login to JumpCloud
  2. From any tab inside of the Administrator Console, click your account email address displayed at the top-right and select API Settings... from the drop-down
  3. Your API key will be displayed in the resulting dialogue 

Generating a New API Key


It is very important to exercise strong security posture when handling your API key, as it gives unfiltered access to your JumpCloud instance through API calls.  If you believe for any reason that your API key may have been shared or compromised, we suggest generating a new API key.
  1. As an Administrator or Command Runner, login to JumpCloud
  2. From any tab inside of the Administrator Console, click your account email address displayed at the top-right and select API Settings... from the drop-down
  3. Your current API key will be displayed in the resulting dialogue
  4. Click the Generate New API Key button to have a new API key generated and displayed
 

Last Updated: Apr 13, 2017 01:49PM MDT

Related Articles
31b11a79e2c94470a66430cfe6d3eecd@jumpcloud.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete