Subscribe to Help Center RSS Feed
With the exceptions listed below, all API documentation has been moved to JumpCloud API Docs. Depending on the functionality desired, you may need to call either, or both endpoints in v1 and v2 of our API.
Supplemental scripts and precompiled binaries can be found on our public Github support repo.
Additional client code can be found in the following repos:
Directory Insights
Meet Directory Insights, JumpCloud's event logging and compliance feature! Directory Insights shines a light on audit trails leading up to critical events so you know the what, where, when, how, and who of your directory activities.
You can use our RESTful API, PowerShell Module, and Administrator Portal to access event logs, see activity happening in your directory, and monitor user authentications to the User Portal, SAML SSO applications, RADIUS, and LDAP. See Directory Insights to learn more.
You can also view any old API keys being used so you can quickly and easily replace them if needed, see Directory Insights API to learn more.
Alternate Access Points
JumpCloud Go SDK (BETA)
The JumpCloud Go SDK can be used to access several of the JumpCloud REST APIs quickly and easily and is based on the Go language. Within the examples folder, the JumpCloud team has also created several pieces of example code for different export options (Systems, etc.).
Accessing Your API Key
Considerations
- API access will be disabled for admins by default.
- Only Admins with Billing role can enable API access. If you need to access your API key, contact your Admin with Billing to enable this for you.
To leverage any of JumpCloud's available API options, an API key is required during the configuration.
- Log in to JumpCloud as an Administrator or Command Runner.
- In the Admin Portal, click your account initials displayed in the top-right and select My API Key from the drop down menu.
- If you haven’t generated an API key yet, you will have the option to Generate New API Key.
API Keys are only displayed at the time they’re created. Make sure to store it in a secure place, like JumpCloud’s Password Manager so you can access it when you need it.
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.
- Log in to JumpCloud as an Administrator or Command Runner.
- In the Admin Portal, click your account initials displayed in the top-right and select My API Key from the drop-down.
- Click Generate New API Key to have a new API key generated and displayed.
Warning: Generating a new API key will revoke access to the current API key. This will render all calls using the previous API key inaccessible. You will have to update any existing integrations that use an API key with the newly generated value.
This will impact any of the following integrations:
- AD Import
- HRIS integrations
- Custom API Integrations
- JumpCloud Powershell Module
- Jumpcloud-Slack-App
- Directory Insights Serverless App
- ADMU
- 3rd party MDM Zero-touch packages
- Command Triggers
- Okta SCIM integration
- Entra ID SCIM integration
- Integrations built to create/update users and/or devices using 3rd party tools like Workato, Aquera, Tray,io, etc.
- Automations and custom applications, and any other use cases that involve an Administrators JumpCloud API key.
FAQ
This is only available one admin at a time.
Yes, the ability to enable/disable access is also available via the API.
If you forget your API key and need that for downstream integrations, you are required to regenerate a new one. In this case, the old key will be expired and no longer valid.
In this Article
Learn More