> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/jumpcloud.md).

# JumpCloud

Manage identities in JumpCloud: create users, control lifecycle state, reset MFA, and manage group membership through the Admin API.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| JumpCloud | Credentials    |

#### JumpCloud

Connect to the JumpCloud Admin API with an API Service Account to manage users, groups, and MFA.

**Set up in JumpCloud**

1. Prepare the JumpCloud account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** Client ID of an API Service Account, created in the JumpCloud Admin Portal under Settings > API Service Accounts.
3. **Client Secret:** Client secret of the same API Service Account. Shown once when the secret is created; rotate it from the service account's secret slots.
4. **Organization ID (Optional):** Only needed for multi-tenant (MSP) admin accounts, to pick which organization API calls are routed to. Single-organization accounts can leave this empty. Found in Settings > Organization Profile.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **JumpCloud**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field              | Required                 | What to enter                                                                                                                                                                                                                                                                  |
| -------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Client ID                  | Yes                      | Client ID of an API Service Account, created in the JumpCloud Admin Portal under Settings > API Service Accounts. [Provider instructions](https://console.jumpcloud.com/#/settings/api-services-accounts).                                                                     |
| Client Secret              | Yes                      | Client secret of the same API Service Account. Shown once when the secret is created; rotate it from the service account's secret slots. [Provider instructions](https://console.jumpcloud.com/#/settings/api-services-accounts).                                              |
| Organization ID (Optional) | Optional / as applicable | Only needed for multi-tenant (MSP) admin accounts, to pick which organization API calls are routed to. Single-organization accounts can leave this empty. Found in Settings > Organization Profile. [Provider instructions](https://console.jumpcloud.com/#/settings/general). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **JumpCloud** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create User

Create a new system user in JumpCloud.

**Inputs**

| Field       | Type   | Required | Description                                                  |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| Username    | string | Yes      | Unique login name of the user to create.                     |
| Email       | string | Yes      | Email address of the user to create.                         |
| First Name  | string | No       | First name of the user.                                      |
| Last Name   | string | No       | Last name of the user.                                       |
| Password    | secret | No       | Initial password (leave empty to create the user as STAGED). |
| Description | string | No       | Free-form description stored on the user.                    |

**Outputs**

| Field          | Type   | Description                          |
| -------------- | ------ | ------------------------------------ |
| User           | object | The created JumpCloud user.          |
| User ID        | string | Unique ID of the created user.       |
| Username       | string | Username of the created user.        |
| Email          | string | Email of the created user.           |
| State          | string | Lifecycle state of the created user. |
| Result Message | string | Human-readable result summary.       |

#### List System Users

List system users in JumpCloud.

**Inputs**

| Field  | Type    | Required | Description                                              |
| ------ | ------- | -------- | -------------------------------------------------------- |
| Limit  | integer | No       | Maximum number of users to return. Default: 50.          |
| Skip   | integer | No       | Number of users to skip (pagination offset). Default: 0. |
| Filter | string  | No       | Optional JumpCloud filter expression.                    |

**Outputs**

| Field          | Type          | Description                                      |
| -------------- | ------------- | ------------------------------------------------ |
| Users          | object\_array | The JumpCloud system users on this page.         |
| User IDs       | array         | IDs of the returned users, for downstream nodes. |
| Total Count    | integer       | Total number of users matching the filter.       |
| Has More       | boolean       | Whether more users exist on later pages.         |
| Result Message | string        | Human-readable result summary.                   |

#### Suspend User

Suspend or unsuspend a JumpCloud user.

**Inputs**

| Field     | Type            | Required | Description                                                                             |
| --------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| User      | select (string) | Yes      | Select the user, or type a user ID manually. Options load from the selected connection. |
| Suspended | boolean         | No       | True suspends the user; false reactivates them. Default: true.                          |

**Outputs**

| Field          | Type   | Description                                   |
| -------------- | ------ | --------------------------------------------- |
| User           | object | The updated JumpCloud user.                   |
| User ID        | string | ID of the updated user.                       |
| State          | string | Lifecycle state of the user after the update. |
| Result Message | string | Human-readable result summary.                |

#### Reset User MFA

Reset a JumpCloud user's MFA enrollment.

**Inputs**

| Field | Type            | Required | Description                                                                             |
| ----- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| User  | select (string) | Yes      | Select the user, or type a user ID manually. Options load from the selected connection. |

**Outputs**

| Field          | Type   | Description                         |
| -------------- | ------ | ----------------------------------- |
| User ID        | string | ID of the user whose MFA was reset. |
| Result Message | string | Human-readable result summary.      |

#### Bind User to Group

Add or remove a JumpCloud user in a user group.

**Inputs**

| Field      | Type            | Required | Description                                                                                         |
| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Operation  | select (string) | No       | Whether to add or remove the user. Available values: Add to group, Remove from group. Default: add. |
| User Group | select (string) | Yes      | Select the user group, or type a group ID manually. Options load from the selected connection.      |
| User       | select (string) | Yes      | Select the user, or type a user ID manually. Options load from the selected connection.             |

**Outputs**

| Field          | Type   | Description                                  |
| -------------- | ------ | -------------------------------------------- |
| Group ID       | string | ID of the user group.                        |
| User ID        | string | ID of the user.                              |
| Operation      | string | The membership operation that was performed. |
| Result Message | string | Human-readable result summary.               |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/jumpcloud.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
