Skip to main content
JumpCloud
JumpCloud
65 actions · 2 auth methods
PreviewIAM

Authentication

OAuth 2.0 (Service Account)

Uses client credentials with role-based access. Supports two client secrets for zero-downtime rotation.Guides: Connector Profile, Link Account

API Key

Inherits permissions of the generating admin. Expires after 30, 60, or 90 days.Guides: Connector Profile, Link Account
Actions
|
65 actions
Action
Description
Required scopes
List System Users
Retrieve a paginated list of all system users (end users) in the organization via GET /systemusers
Get System User
Retrieve full profile details for a specific system user by their unique ID via GET /systemusers/{id}
Create System User
Create a new system user with profile details and access settings via POST /systemusers
Update System User
Update an existing system user’s profile and access settings via PUT /systemusers/{id}
Delete System User
Permanently delete a system user and revoke all their access via DELETE /systemusers/{id}
List User Groups
Retrieve a paginated list of all user groups in the organization via GET /v2/usergroups
Get User Group
Retrieve full details for a specific user group by its unique ID via GET /v2/usergroups/{id}
Create User Group
Create a new user group for organizing users and managing bulk access via POST /v2/usergroups
Update User Group
Partially update an existing user group’s attributes via PATCH /v2/usergroups/{id}
Delete User Group
Permanently delete a user group and remove all its memberships and associations via DELETE /v2/usergroups/{id}
Manage User Group Members
Add or remove members from a user group via POST /v2/usergroups/{id}/members
List Policies
Retrieve a paginated list of all device policies configured in the organization via GET /v2/policies
Get Policy
Retrieve full details for a specific device policy by its ObjectID via GET /v2/policies/{id}
Create Policy
Create a new device policy from a template with configuration values via POST /v2/policies
Update Policy
Fully replace an existing device policy’s name, notes, and configuration values via PUT /v2/policies/{id}
Delete Policy
Permanently delete a device policy and unbind it from all associated systems via DELETE /v2/policies/{id}
List LDAP Servers
Retrieve a paginated list of all Cloud LDAP server configurations in the organization via GET /v2/ldapservers
Get LDAP Server
Retrieve full details for a specific Cloud LDAP server by its unique ID via GET /v2/ldapservers/{id}
Update LDAP Server
Partially update a Cloud LDAP server’s user action settings via PATCH /v2/ldapservers/{id}
List IP Lists
Retrieve a paginated list of all IP address lists configured for conditional access via GET /v2/iplists
Get IP List
Retrieve full details for a specific IP address list by its unique ID via GET /v2/iplists/{id}
Create IP List
Create a new IP address list for use in conditional access policies via POST /v2/iplists
Update IP List
Partially update an existing IP address list’s name, description, or IP entries via PATCH /v2/iplists/{id}
Delete IP List
Permanently delete an IP address list and affect any referencing conditional access policies via DELETE /v2/iplists/{id}
List Software Apps
Retrieve a paginated list of all managed software applications in the organization via GET /v2/softwareapps
Get Software App
Retrieve full details for a specific managed software application by its unique ID via GET /v2/softwareapps/{id}
Create Software App
Create a new managed software application configuration for deployment via POST /v2/softwareapps
Update Software App
Fully replace a software application’s display name and settings via PUT /v2/softwareapps/{id}
Delete Software App
Permanently delete a software application configuration and unmanage it on all systems via DELETE /v2/softwareapps/{id}
List Systems
Retrieve a paginated list of all managed systems (devices) in the organization via GET /systems
Get System
Retrieve full details for a specific managed system by its unique ID via GET /systems/{id}
Update System
Update a system’s display name, SSH settings, MFA configuration, and tags via PUT /systems/{id}
Delete System
Remove a system from JumpCloud management and trigger agent uninstall via DELETE /systems/{id}
Erase System
Run the erase command on a system to wipe its data via POST /systems/{system_id}/command/builtin/erase
Lock System
Run the lock command on a system to lock its screen via POST /systems/{system_id}/command/builtin/lock
Restart System
Run the restart command on a system via POST /systems/{system_id}/command/builtin/restart
Shutdown System
Run the shutdown command on a system via POST /systems/{system_id}/command/builtin/shutdown
List System Groups
Retrieve a paginated list of all system (device) groups in the organization via GET /v2/systemgroups
Get System Group
Retrieve full details for a specific system group by its unique ID via GET /v2/systemgroups/{id}
Create System Group
Create a new system group for organizing devices and managing bulk configurations via POST /v2/systemgroups
Update System Group
Fully replace a system group’s configuration via PUT /v2/systemgroups/{id}
Delete System Group
Permanently delete a system group and remove all its memberships and associations via DELETE /v2/systemgroups/{id}
Manage System Group Members
Add or remove members from a system group via POST /v2/systemgroups/{id}/members
List Applications
Retrieve a paginated list of all SSO/SAML applications configured in the organization via GET /applications
Get Application
Retrieve full details for a specific SSO/SAML application by its unique ID via GET /applications/{id}
Create Application
Create a new SSO/SAML application with SAML configuration via POST /applications
Update Application
Fully replace an existing SSO/SAML application’s configuration via PUT /applications/{id}
Delete Application
Permanently delete an SSO/SAML application and remove all user access via DELETE /applications/{id}
List Application Templates
Retrieve a paginated list of available SSO application templates via GET /application-templates
Get Application Template
Retrieve full details for a specific application template by its ID via GET /application-templates/{id}
List Commands
Retrieve a paginated list of all commands configured in the organization via GET /commands
Get Command
Retrieve full details for a specific command by its unique ID via GET /commands/{id}
Create Command
Create a new command with script content and execution settings via POST /commands
Update Command
Fully replace an existing command’s configuration via PUT /commands/{id}
Delete Command
Permanently delete a command and cancel all its scheduled executions via DELETE /commands/{id}
List Command Results
Retrieve a paginated list of all command execution results across all commands via GET /commandresults
Get Command Results
Retrieve paginated execution results for a specific command via GET /commands/{id}/results
Delete Command Result
Delete a specific command execution result by its ID via DELETE /commandresults/{id}
Get Command Files
Retrieve uploaded files attached to a command via GET /files/command/{id}
Run Command
Run a command on specified or all bound systems by command ID via POST /runCommand
Trigger Command
Trigger execution of a command by its trigger name via POST /command/trigger/{triggername}
List Organizations
Retrieve a paginated list of all organizations accessible to the current API key via GET /organizations
Get Organization
Retrieve full details for a specific organization by its unique ID via GET /organizations/{id}
Update Organization
Update an organization’s settings, policies, and feature configuration via PUT /organizations/{id}
List Active Directories
Retrieve a paginated list of all Active Directory integrations configured for user and group synchronization via GET /v2…

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/jumpcloud/filled/png

Connector Profile

JumpCloud - OAuth 2.0 (Service Account)
https://stackone-logos.com/api/jumpcloud/filled/png

Connector Profile

JumpCloud - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/jumpcloud/filled/png

Link Account

JumpCloud - OAuth 2.0 (Service Account)
https://stackone-logos.com/api/jumpcloud/filled/png

Link Account

JumpCloud - API Key
4

Use Actions

Invoke actions using one of the methods below: