> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# JumpCloud

> JumpCloud is a cloud-based directory platform that provides secure identity, access, and device management solutions for organizations.

![JumpCloud logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/jumpcloud.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=602bc0a592bafa11f4a9833204b23166)

* **Category:** security & identity tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 2
* **Triggers:** 0
* **Slug:** `JUMPCLOUD`
* **Version:** 20261101\_00

## Tools

> [accordion] Create System
>
> **Slug:** `JUMPCLOUD_CREATE_SYSTEM`
>
> Checks API access and provides guidance for enrolling systems in JumpCloud. It does not create a system; it directs users to install the JumpCloud Agent and provides documentation links for agent installation and Connect keys.
>
> #### Input Parameters
>
> **x-org-id** `string`
>
> Organization ID for multi-tenant admin accounts. Only required if managing multiple organizations. Sends as 'x-org-id' header to scope the request to a specific organization.
>
> **message\_template** `string`
>
> Custom text to append to the enrollment guidance message. Use this to add organization-specific instructions or contact information. Supports unicode characters and emojis.
>
> **preflight\_resource** `string`
>
> JumpCloud resource type to query for credential validation. Use 'systems' for v1 API validation or 'systemgroups' for v2 API validation. Defaults to 'systems' if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Role
>
> **Slug:** `JUMPCLOUD_DELETE_ROLE`
>
> Deletes a specific custom role from JumpCloud by its ID. This action permanently removes a custom role. Built-in system roles (Administrator, Read Only, Manager, etc.) cannot be deleted. Before deleting a role, ensure it is not currently assigned to any administrators. The operation is idempotent - attempting to delete a non-existent role returns success (404 treated as successful deletion).
>
> #### Input Parameters
>
> **role\_id** `string` *required*
>
> The unique identifier (UUID) of the role to delete. Only custom roles can be deleted; built-in system roles cannot be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Directory Users
>
> **Slug:** `JUMPCLOUD_LIST_DIRECTORY_USERS`
>
> Lists directory users with filtering, field projection, and pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip.
>
> **sort** `string`
>
> Space-separated fields to sort by. Prefix a field with '-' for descending order.
>
> **limit** `integer`
>
> Maximum records to return (1-100).
>
> **fields** `string`
>
> Space-separated fields to include.
>
> **filter** `string`
>
> V1 filter expression in field:\$operator:value form. Keep the '\$' prefix, for example username:\$eq:example.user.
>
> **search** `string`
>
> JSON string with shape \{"searchTerm":"text","fields":\["email","username"]}.
>
> **x\_org\_id** `string`
>
> Organization ID for multi-organization access.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Software App Associations
>
> **Slug:** `JUMPCLOUD_LIST_SOFTWARE_APP_ASSOCIATIONS`
>
> Lists systems or system groups directly associated with a software app.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip.
>
> **limit** `integer`
>
> Maximum records to return (1-100).
>
> **targets** `string ("system" | "system_group")` *required*
>
> Associated target type to retrieve.
>
> **software\_app\_id** `string` *required*
>
> Object ID of the software application.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Software App Statuses
>
> **Slug:** `JUMPCLOUD_LIST_SOFTWARE_APP_STATUSES`
>
> List deployment or installation statuses for a JumpCloud software app.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of status records to skip.
>
> **sort** `array`
>
> Fields to sort by; prefix a field with '-' for descending order.
>
> **limit** `integer`
>
> Maximum status records to return (1-100).
>
> **filter** `array`
>
> Filters in field:operator:value form.
>
> **x\_org\_id** `string`
>
> Organization ID for multi-organization access.
>
> **software\_app\_id** `string` *required*
>
> Object ID of the software application.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Software Inventory
>
> **Slug:** `JUMPCLOUD_LIST_SOFTWARE_INVENTORY`
>
> Lists installed applications or programs reported by System Insights.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip.
>
> **limit** `integer`
>
> Maximum number of records to return (0-100).
>
> **filter** `array`
>
> Equality filters in field:eq:value form.
>
> **x\_org\_id** `string`
>
> Organization ID for multi-organization access, sent in the x-org-id header.
>
> **inventory\_type** `string ("apps" | "programs")` *required*
>
> Inventory family to retrieve: apps or programs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List System Group Members
>
> **Slug:** `JUMPCLOUD_LIST_SYSTEM_GROUP_MEMBERS`
>
> Lists managed systems that are direct members of a system group.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip.
>
> **limit** `integer`
>
> Maximum records to return (1-100).
>
> **group\_id** `string` *required*
>
> Object ID of the system group.
>
> **x\_org\_id** `string`
>
> Organization ID for multi-organization access, sent as x-org-id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Systems
>
> **Slug:** `JUMPCLOUD_LIST_SYSTEMS`
>
> Lists JumpCloud managed systems with projection and offset pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip.
>
> **sort** `string`
>
> Space-separated fields to sort by. Prefix a field with '-' for descending order.
>
> **limit** `integer`
>
> Maximum records to return (1-100).
>
> **fields** `string`
>
> Space-separated fields to include.
>
> **filter** `string`
>
> V1 filter expression to apply to the query.
>
> **search** `string`
>
> JSON string with shape \{"searchTerm":"text","fields":\["hostname","displayName"]}.
>
> **x\_org\_id** `string`
>
> Organization ID for multi-organization access.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Systems
>
> **Slug:** `JUMPCLOUD_LIST_USER_SYSTEMS`
>
> Lists managed systems bound directly or indirectly to a directory user.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip.
>
> **limit** `integer`
>
> Maximum records to return (1-100).
>
> **filter** `array`
>
> JumpCloud V2 filters in field:operator:value form.
>
> **user\_id** `string` *required*
>
> Object ID of the directory user.
>
> **x\_org\_id** `string`
>
> Organization ID for multi-organization access.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
