> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# JumpCloud

> How to set up the JumpCloud connector, plus the actions and events that are available.

![JumpCloud](https://stackone-logos.com/api/jumpcloud/filled/svg)

v1.4.6[See changelog](https://docs.stackone.com/connectors/jumpcloud/changelog.md)

[78 actions](#actions) · [1 event](#events) · 2 auth methods

IAM
Device Management

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Service Account) · Connector Profile](https://docs.stackone.com/connectors/jumpcloud/guides/connector-profile/oauth-2-0-service-account.md)
>
> Uses client credentials with role-based access. Supports two client secrets for zero-downtime rotation.

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/jumpcloud/guides/connector-profile/api-key.md)
>
> Inherits permissions of the generating admin. Can expire after 30, 60, or 90 days, a custom period, or never expire; rot...

Optionally, configure receiving Events for JumpCloud into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/jumpcloud/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Service Account) · Link Account](https://docs.stackone.com/connectors/jumpcloud/guides/link-account/oauth-2-0-service-account.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/jumpcloud/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0 (Service Account)

No auth methods found

Scopes

Select all
|
Clear

applications.create

applications.delete

applications.readonly

applications.update

authn

authn.readonly

commands

commands.readonly

directories

directories.readonly

organizations

organizations.readonly

roles.readonly

systems

systems.readonly

No scopes found

78 actions

ActionDescriptionRequired scopes

List System Users`jumpcloud_list_system_users`

Retrieve a paginated list of all system users (end users) in the organization via GET /systemusers

`systems.readonly`

Get System User`jumpcloud_get_system_user`

Retrieve full profile details for a specific system user by their unique ID via GET /systemusers/\{id}

`systems.readonly`

Create System User`jumpcloud_create_system_user`

Create a new system user with profile details and access settings via POST /systemusers

`systems`

Update System User`jumpcloud_update_system_user`

Update an existing system user's profile and access settings via PUT /systemusers/\{id}

`systems`

Delete System User`jumpcloud_delete_system_user`

Permanently delete a system user and revoke all their access via DELETE /systemusers/\{id}

`systems`

List User Groups`jumpcloud_list_user_groups`

Retrieve a paginated list of all user groups in the organization via GET /v2/usergroups

`systems.readonly`

Get User Group`jumpcloud_get_user_group`

Retrieve full details for a specific user group by its unique ID via GET /v2/usergroups/\{id}

`systems.readonly`

Create User Group`jumpcloud_create_user_group`

Create a new user group for organizing users and managing bulk access via POST /v2/usergroups

`systems`

Update User Group`jumpcloud_update_user_group`

Partially update an existing user group's attributes via PATCH /v2/usergroups/\{id}

`systems`

Delete User Group`jumpcloud_delete_user_group`

Permanently delete a user group and remove all its memberships and associations via DELETE /v2/usergroups/\{id}

`systems`

Manage User Group Members`jumpcloud_manage_user_group_members`

Add or remove members from a user group via POST /v2/usergroups/\{id}/members

`systems`

List Policies`jumpcloud_list_policies`

Retrieve a paginated list of all device policies configured in the organization via GET /v2/policies

`systems.readonly`

List Policy Templates`jumpcloud_list_policy_templates`

Retrieve the catalog of JumpCloud policy templates via GET /v2/policytemplates

`systems.readonly`

Get Policy`jumpcloud_get_policy`

Retrieve full details for a specific device policy by its ObjectID via GET /v2/policies/\{id}

`systems.readonly`

Create Policy`jumpcloud_create_policy`

Create a new device policy from a template with configuration values via POST /v2/policies

`systems`

Update Policy`jumpcloud_update_policy`

Fully replace an existing device policy's name, notes, and configuration values via PUT /v2/policies/\{id}

`systems`

Delete Policy`jumpcloud_delete_policy`

Permanently delete a device policy and unbind it from all associated systems via DELETE /v2/policies/\{id}

`systems`

List LDAP Servers`jumpcloud_list_ldap_servers`

Retrieve a paginated list of all Cloud LDAP server configurations in the organization via GET /v2/ldapservers

`directories.readonly`

Get LDAP Server`jumpcloud_get_ldap_server`

Retrieve full details for a specific Cloud LDAP server by its unique ID via GET /v2/ldapservers/\{id}

`directories.readonly`

Update LDAP Server`jumpcloud_update_ldap_server`

Partially update a Cloud LDAP server's user action settings via PATCH /v2/ldapservers/\{id}

`directories`

List IP Lists`jumpcloud_list_ip_lists`

Retrieve a paginated list of all IP address lists configured for conditional access via GET /v2/iplists

`authn.readonly`

Get IP List`jumpcloud_get_ip_list`

Retrieve full details for a specific IP address list by its unique ID via GET /v2/iplists/\{id}

`authn.readonly`

Create IP List`jumpcloud_create_ip_list`

Create a new IP address list for use in conditional access policies via POST /v2/iplists

`authn`

Update IP List`jumpcloud_update_ip_list`

Partially update an existing IP address list's name, description, or IP entries via PATCH /v2/iplists/\{id}

`authn`

Delete IP List`jumpcloud_delete_ip_list`

Permanently delete an IP address list and affect any referencing conditional access policies via DELETE /v2/iplists/\{id}

`authn`

List Software Apps`jumpcloud_list_software_apps`

Retrieve a paginated list of all managed software applications in the organization via GET /v2/softwareapps

`systems.readonly`

Get Software App`jumpcloud_get_software_app`

Retrieve full details for a specific managed software application by its unique ID via GET /v2/softwareapps/\{id}

`systems.readonly`

Create Software App`jumpcloud_create_software_app`

Create a new managed software application configuration for deployment via POST /v2/softwareapps

`systems`

Update Software App`jumpcloud_update_software_app`

Fully replace a software application's display name and settings via PUT /v2/softwareapps/\{id}

`systems`

Delete Software App`jumpcloud_delete_software_app`

Permanently delete a software application configuration and unmanage it on all systems via DELETE /v2/softwareapps/\{id}

`systems`

List Systems`jumpcloud_list_systems`

Retrieve a paginated list of all managed systems (devices) in the organization via GET /systems

`systems.readonly`

Get System`jumpcloud_get_system`

Retrieve full details for a specific managed system by its unique ID via GET /systems/\{id}

`systems.readonly`

Update System`jumpcloud_update_system`

Update a system's display name, SSH settings, MFA configuration, and tags via PUT /systems/\{id}

`systems`

Delete System`jumpcloud_delete_system`

Remove a system from JumpCloud management and trigger agent uninstall via DELETE /systems/\{id}

`systems`

Erase System`jumpcloud_erase_system`

Run the erase command on a system to wipe its data via POST /systems/\{system\_id}/command/builtin/erase

`systems`

Lock System`jumpcloud_lock_system`

Run the lock command on a system to lock its screen via POST /systems/\{system\_id}/command/builtin/lock

`systems`

Restart System`jumpcloud_restart_system`

Run the restart command on a system via POST /systems/\{system\_id}/command/builtin/restart

`systems`

Shutdown System`jumpcloud_shutdown_system`

Run the shutdown command on a system via POST /systems/\{system\_id}/command/builtin/shutdown

`systems`

List System Groups`jumpcloud_list_system_groups`

Retrieve a paginated list of all system (device) groups in the organization via GET /v2/systemgroups

`systems.readonly`

Get System Group`jumpcloud_get_system_group`

Retrieve full details for a specific system group by its unique ID via GET /v2/systemgroups/\{id}

`systems.readonly`

Create System Group`jumpcloud_create_system_group`

Create a new system group for organizing devices and managing bulk configurations via POST /v2/systemgroups

`systems`

Update System Group`jumpcloud_update_system_group`

Fully replace a system group's configuration via PUT /v2/systemgroups/\{id}

`systems`

Delete System Group`jumpcloud_delete_system_group`

Permanently delete a system group and remove all its memberships and associations via DELETE /v2/systemgroups/\{id}

`systems`

Manage System Group Members`jumpcloud_manage_system_group_members`

Add or remove members from a system group via POST /v2/systemgroups/\{id}/members

`systems`

List Applications`jumpcloud_list_applications`

Retrieve a paginated list of all SSO/SAML applications configured in the organization via GET /applications

`applications.readonly`

Get Application`jumpcloud_get_application`

Retrieve full details for a specific SSO/SAML application by its unique ID via GET /applications/\{id}

`applications.readonly`

Create Application`jumpcloud_create_application`

Create a new SSO/SAML application with SAML configuration via POST /applications

`applications.create`

Update Application`jumpcloud_update_application`

Fully replace an existing SSO/SAML application's configuration via PUT /applications/\{id}

`applications.update`

Delete Application`jumpcloud_delete_application`

Permanently delete an SSO/SAML application and remove all user access via DELETE /applications/\{id}

`applications.delete`

List Application Templates`jumpcloud_list_application_templates`

Retrieve a paginated list of available SSO application templates via GET /application-templates

`applications.readonly`

Get Application Template`jumpcloud_get_application_template`

Retrieve full details for a specific application template by its ID via GET /application-templates/\{id}

`applications.readonly`

List Commands`jumpcloud_list_commands`

Retrieve a paginated list of all commands configured in the organization via GET /commands

`commands.readonly`

Get Command`jumpcloud_get_command`

Retrieve full details for a specific command by its unique ID via GET /commands/\{id}

`commands.readonly`

Create Command`jumpcloud_create_command`

Create a new command with script content and execution settings via POST /commands

`commands`

Update Command`jumpcloud_update_command`

Fully replace an existing command's configuration via PUT /commands/\{id}

`commands`

Delete Command`jumpcloud_delete_command`

Permanently delete a command and cancel all its scheduled executions via DELETE /commands/\{id}

`commands`

List Command Results`jumpcloud_list_command_results`

Retrieve a paginated list of all command execution results across all commands via GET /commandresults

`commands.readonly`

Get Command Results`jumpcloud_get_command_results`

Retrieve paginated execution results for a specific command via GET /commands/\{id}/results

`commands.readonly`

Delete Command Result`jumpcloud_delete_command_result`

Delete a specific command execution result by its ID via DELETE /commandresults/\{id}

`commands`

Get Command Files`jumpcloud_get_command_files`

Retrieve uploaded files attached to a command via GET /files/command/\{id}

`commands.readonly`

Run Command`jumpcloud_run_command`

Run a command on specified or all bound systems by command ID via POST /runCommand

`commands`

Trigger Command`jumpcloud_trigger_command`

Trigger execution of a command by its trigger name via POST /command/trigger/\{triggername}

`commands`

Directory Insights Alert`jumpcloud_webhook_insights_alert`

Fires when a JumpCloud Insights Rule attached to a Webhook Channel matches a directory event. JumpCloud delivers a singl...

List Organizations`jumpcloud_list_organizations`

Retrieve a paginated list of all organizations accessible to the current API key via GET /organizations

`organizations.readonly`

Get Organization`jumpcloud_get_organization`

Retrieve full details for a specific organization by its unique ID via GET /organizations/\{id}

`organizations.readonly`

Update Organization`jumpcloud_update_organization`

Update an organization's settings, policies, and feature configuration via PUT /organizations/\{id}

`organizations`

List Active Directories`jumpcloud_list_active_directories`

Retrieve a paginated list of all Active Directory integrations configured for user and group synchronization via GET /v2...

`directories.readonly`

Get Unified Credentials`jumpcloud_unified_get_me`

Return the authenticated identity for the current JumpCloud connection. Maps to the StackOne IAM unified credentials sch...

`organizations.readonly`

List Unified Groups`jumpcloud_unified_list_groups`

List all user groups in the connected JumpCloud organization via GET /v2/usergroups, mapped to the StackOne IAM unified...

`systems.readonly`

Get Unified Group`jumpcloud_unified_get_group`

Retrieve a single JumpCloud user group by its group ID via GET /v2/usergroups/\{id}, mapped to the StackOne IAM unified g...

`systems.readonly`

List Unified Organizations`jumpcloud_unified_list_organizations`

List the JumpCloud organizations accessible to the current connection via GET /organizations, mapped to the StackOne IAM...

`organizations.readonly`

Get Unified Organization`jumpcloud_unified_get_organization`

Retrieve a single JumpCloud organization by its organization ID via GET /organizations/\{id}, mapped to the StackOne IAM...

`organizations.readonly`

List Unified Resource Types`jumpcloud_unified_list_resource_types`

Enumerate the resource\_type values accepted by unified\_list\_resource\_users on this connector. On JumpCloud the supported...

`systems.readonly`

List Unified Resource Users`jumpcloud_unified_list_resource_users`

List the users bound to a JumpCloud user group, SSO application, or system, mapped to the IAM unified user schema with a...

List Unified Roles`jumpcloud_unified_list_roles`

List unified roles configured in JumpCloud via the Roles API.

`roles.readonly`

Get Unified Role`jumpcloud_unified_get_role`

Retrieve a single JumpCloud role by its role ID via the Roles API.

`roles.readonly`

List Unified Users`jumpcloud_unified_list_users`

List all system users in the connected JumpCloud organization via GET /systemusers, mapped to the StackOne IAM unified u...

`systems.readonly`

Get Unified User`jumpcloud_unified_get_user`

Retrieve a single JumpCloud system user by their JumpCloud user ID, mapped to the StackOne IAM unified user schema. Opti...

`systems.readonly`

## Events

Tags

Select all
|
Clear

Webhooks

No tags found

1 event

EventDescriptionTags

Directory Insights Alert`jumpcloud_webhook_insights_alert`

Fires when a JumpCloud Insights Rule attached to a Webhook Channel matches a directory event. JumpCloud delivers a singl...

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.