# JumpCloud

> Manage your JumpCloud directory: find, create, update, suspend and delete users, keep user groups and their members in step, and manage device groups.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/jumpcloud

## Actions

### Activate user

Activate a staged user so they can sign in. JumpCloud emails them a welcome message, or a link to choose a password if they have none.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.
- Send the welcome email (`send_email`, true/false): Leave on for JumpCloud to email the user. Turn off if you'll tell them yourself. Default: `true`.

**Outputs**

- `action` (text): What was done
- `done` (true/false): Always true once done
- `user_id` (text): The user changed

**Example output**

```json
{
  "action": "activated",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Add user to group

Add a user to a user group.

**Inputs**

- User group (`group_id`, text, required): The user group. Pick one, or give its id from an earlier step.
- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `done` (true/false): Always true once done
- `group_id` (text): The group changed
- `user_id` (text): The user added or removed

**Example output**

```json
{
  "done": true,
  "group_id": "5f3d7b8e9c1a2b0087654321",
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Create device group

Create an empty device group.

**Inputs**

- Name (`name`, text, required): The group's name.
- Description (`description`, text): What the group is for.

**Outputs**

- `group` (object): The device group

**Example output**

```json
{
  "group": {
    "description": "Company laptops",
    "id": "5f3d7b8e9c1a2b0011112222",
    "membershipMethod": "STATIC",
    "name": "Laptops",
    "type": "system_group"
  }
}
```

### Create user

Add a user to your directory. Staged users are not active until activated, so no email is sent; Activated users are live at once.

**Inputs**

- Username (`username`, text, required): The sign-in name. Letters, digits, '.', '_' and '-'.
- Email (`email`, text, required): The user's email address.
- State (`state`, text): Staged keeps the user inactive; Activated makes them live. One of: `STAGED` (Staged (no activation email yet)), `ACTIVATED`.
- Password (`password`, text): An initial password. Leave empty to let them set one.
- First name (`firstname`, text): The user's first name.
- Last name (`lastname`, text): The user's last name.
- Department (`department`, text): The user's department.
- Job title (`job_title`, text): The user's job title.
- Company (`company`, text): The company the user works for.
- Location (`location`, text): Where the user is based.
- Description (`description`, text): A note about the user.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "_id": "5f3d7b8e9c1a2b0012345678",
    "account_locked": false,
    "activated": false,
    "company": "Example Inc",
    "created": "2026-10-15T09:00:00Z",
    "department": "Engineering",
    "description": "Joined in October",
    "displayname": "Jo Bloggs",
    "email": "jo@example.com",
    "firstname": "Jo",
    "jobTitle": "Engineer",
    "lastname": "Bloggs",
    "location": "London",
    "password_expired": false,
    "state": "STAGED",
    "suspended": false,
    "totp_enabled": false,
    "username": "jo.bloggs"
  }
}
```

### Create user group

Create an empty user group.

**Inputs**

- Name (`name`, text, required): The group's name.
- Description (`description`, text): What the group is for.

**Outputs**

- `group` (object): The user group

**Example output**

```json
{
  "group": {
    "description": "Everyone in engineering",
    "id": "5f3d7b8e9c1a2b0087654321",
    "membershipMethod": "STATIC",
    "name": "Engineering",
    "type": "user_group"
  }
}
```

### Delete device group

Delete a device group. The devices in it are not deleted.

**Inputs**

- Device group (`group_id`, text, required): The device group. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `group_id` (text): The group deleted

**Example output**

```json
{
  "deleted": true,
  "group_id": "5f3d7b8e9c1a2b0011112222"
}
```

### Delete user

Delete a user for good, including their group memberships.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `user` (object): The user as they were
- `user_id` (text): The user deleted

**Example output**

```json
{
  "deleted": true,
  "user": {
    "_id": "5f3d7b8e9c1a2b0012345678",
    "account_locked": false,
    "activated": false,
    "company": "Example Inc",
    "created": "2026-10-15T09:00:00Z",
    "department": "Engineering",
    "description": "Joined in October",
    "displayname": "Jo Bloggs",
    "email": "jo@example.com",
    "firstname": "Jo",
    "jobTitle": "Engineer",
    "lastname": "Bloggs",
    "location": "London",
    "password_expired": false,
    "state": "STAGED",
    "suspended": false,
    "totp_enabled": false,
    "username": "jo.bloggs"
  },
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Delete user group

Delete a user group. The users in it are not deleted.

**Inputs**

- User group (`group_id`, text, required): The user group. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `group_id` (text): The group deleted

**Example output**

```json
{
  "deleted": true,
  "group_id": "5f3d7b8e9c1a2b0087654321"
}
```

### Expire user password

Expire a user's password so they must choose a new one at next sign-in.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `action` (text): What was done
- `done` (true/false): Always true once done
- `user_id` (text): The user changed

**Example output**

```json
{
  "action": "password expired",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Get device group

Get one device group with its description and membership method.

**Inputs**

- Device group (`group_id`, text, required): The device group. Pick one, or give its id from an earlier step.

**Outputs**

- `group` (object): The device group

**Example output**

```json
{
  "group": {
    "description": "Company laptops",
    "id": "5f3d7b8e9c1a2b0011112222",
    "membershipMethod": "STATIC",
    "name": "Laptops",
    "type": "system_group"
  }
}
```

### Get user

Get one user with their profile, state and lock or password status.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "_id": "5f3d7b8e9c1a2b0012345678",
    "account_locked": false,
    "activated": false,
    "company": "Example Inc",
    "created": "2026-10-15T09:00:00Z",
    "department": "Engineering",
    "description": "Joined in October",
    "displayname": "Jo Bloggs",
    "email": "jo@example.com",
    "firstname": "Jo",
    "jobTitle": "Engineer",
    "lastname": "Bloggs",
    "location": "London",
    "password_expired": false,
    "state": "STAGED",
    "suspended": false,
    "totp_enabled": false,
    "username": "jo.bloggs"
  }
}
```

### Get user group

Get one user group with its description and membership method.

**Inputs**

- User group (`group_id`, text, required): The user group. Pick one, or give its id from an earlier step.

**Outputs**

- `group` (object): The user group

**Example output**

```json
{
  "group": {
    "description": "Everyone in engineering",
    "id": "5f3d7b8e9c1a2b0087654321",
    "membershipMethod": "STATIC",
    "name": "Engineering",
    "type": "user_group"
  }
}
```

### List device groups

List the device groups, optionally those whose name contains some text.

**Inputs**

- Name contains (`name`, text): Only groups whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100. From 1 to 100.
- Skip (`skip`, number): How many to skip, to get a later page. Use 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `groups` (list): The device groups
- `has_more` (true/false): True if there are more after this page
- `next_skip` (number): The 'skip' that gets the next page, empty on the last page

**Example output**

```json
{
  "count": 1,
  "groups": [
    {
      "description": "Company laptops",
      "id": "5f3d7b8e9c1a2b0011112222",
      "membershipMethod": "STATIC",
      "name": "Laptops",
      "type": "system_group"
    }
  ],
  "has_more": false,
  "next_skip": null
}
```

### List devices

List the computers enrolled in JumpCloud with their system, version and when they were last seen.

**Inputs**

- Order (`sort`, text): How to order the devices. Defaults to name. One of: `displayName` (Name, A to Z (default)), `-displayName` (Name, Z to A), `-lastContact` (Most recently seen first), `-created` (Newest first).
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100. From 1 to 100.
- Skip (`skip`, number): How many to skip, to get a later page. Use 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `has_more` (true/false): True if there are more after this page
- `next_skip` (number): The 'skip' that gets the next page, empty on the last page
- `systems` (list): The devices
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_skip": null,
  "systems": [
    {
      "_id": "5f3d7b8e9c1a2b0033334444",
      "active": true,
      "created": "2026-09-01T09:00:00Z",
      "displayName": "jo-macbook",
      "hostname": "jo-macbook.local",
      "lastContact": "2026-10-20T14:00:00Z",
      "os": "macOS",
      "osFamily": "darwin",
      "version": "14.5"
    }
  ],
  "total_count": 1
}
```

### List organizations

List the organizations the API key can see.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `organizations` (list): The organizations

**Example output**

```json
{
  "count": 1,
  "organizations": [
    {
      "_id": "5f3d7b8e9c1a2b0055556666",
      "created": "2026-10-01T09:00:00Z",
      "displayName": "Example Inc"
    }
  ]
}
```

### List user group members

List the users in a user group, as ids. Use 'Get user' for details.

**Inputs**

- User group (`group_id`, text, required): The user group. Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100. From 1 to 100.
- Skip (`skip`, number): How many to skip, to get a later page. Use 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `has_more` (true/false): True if there are more after this page
- `members` (list): The users in the group
- `next_skip` (number): The 'skip' that gets the next page, empty on the last page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "members": [
    {
      "id": "5f3d7b8e9c1a2b0012345678",
      "type": "user"
    }
  ],
  "next_skip": null
}
```

### List user groups

List the user groups, optionally those whose name contains some text.

**Inputs**

- Name contains (`name`, text): Only groups whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100. From 1 to 100.
- Skip (`skip`, number): How many to skip, to get a later page. Use 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `groups` (list): The user groups
- `has_more` (true/false): True if there are more after this page
- `next_skip` (number): The 'skip' that gets the next page, empty on the last page

**Example output**

```json
{
  "count": 1,
  "groups": [
    {
      "description": "Everyone in engineering",
      "id": "5f3d7b8e9c1a2b0087654321",
      "membershipMethod": "STATIC",
      "name": "Engineering",
      "type": "user_group"
    }
  ],
  "has_more": false,
  "next_skip": null
}
```

### List users

List the users in your directory, optionally only one state or department, newest or in name order.

**Inputs**

- State (`state`, text): Only users in this state. Defaults to any. One of: `all` (Any state (default)), `ACTIVATED`, `STAGED` (Staged (not yet activated)), `SUSPENDED`.
- Department (`department`, text): Only users in this department (exact match).
- Order (`sort`, text): How to order the users. Defaults to username. One of: `username` (Username, A to Z (default)), `-username` (Username, Z to A), `-created` (Newest first), `created` (Oldest first), `email` (Email, A to Z), `lastname` (Last name, A to Z).
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100. From 1 to 100.
- Skip (`skip`, number): How many to skip, to get a later page. Use 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `has_more` (true/false): True if there are more after this page
- `next_skip` (number): The 'skip' that gets the next page, empty on the last page
- `total_count` (number): How many there are in all
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_skip": null,
  "total_count": 1,
  "users": [
    {
      "_id": "5f3d7b8e9c1a2b0012345678",
      "account_locked": false,
      "activated": false,
      "company": "Example Inc",
      "created": "2026-10-15T09:00:00Z",
      "department": "Engineering",
      "description": "Joined in October",
      "displayname": "Jo Bloggs",
      "email": "jo@example.com",
      "firstname": "Jo",
      "jobTitle": "Engineer",
      "lastname": "Bloggs",
      "location": "London",
      "password_expired": false,
      "state": "STAGED",
      "suspended": false,
      "totp_enabled": false,
      "username": "jo.bloggs"
    }
  ]
}
```

### Remove user from group

Remove a user from a user group. The user is not deleted.

**Inputs**

- User group (`group_id`, text, required): The user group. Pick one, or give its id from an earlier step.
- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `done` (true/false): Always true once done
- `group_id` (text): The group changed
- `user_id` (text): The user added or removed

**Example output**

```json
{
  "done": true,
  "group_id": "5f3d7b8e9c1a2b0087654321",
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Search users

Find users whose username, email or name contains some text.

**Inputs**

- Search for (`search_term`, text, required): Text to look for in usernames, emails and names.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100. From 1 to 100.
- Skip (`skip`, number): How many to skip, to get a later page. Use 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `has_more` (true/false): True if there are more after this page
- `next_skip` (number): The 'skip' that gets the next page, empty on the last page
- `total_count` (number): How many there are in all
- `users` (list): The users found

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_skip": null,
  "total_count": 1,
  "users": [
    {
      "_id": "5f3d7b8e9c1a2b0012345678",
      "account_locked": false,
      "activated": false,
      "company": "Example Inc",
      "created": "2026-10-15T09:00:00Z",
      "department": "Engineering",
      "description": "Joined in October",
      "displayname": "Jo Bloggs",
      "email": "jo@example.com",
      "firstname": "Jo",
      "jobTitle": "Engineer",
      "lastname": "Bloggs",
      "location": "London",
      "password_expired": false,
      "state": "STAGED",
      "suspended": false,
      "totp_enabled": false,
      "username": "jo.bloggs"
    }
  ]
}
```

### Suspend user

Suspend a user so they can no longer sign in. Their data is kept.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `action` (text): What was done
- `done` (true/false): Always true once done
- `user_id` (text): The user changed

**Example output**

```json
{
  "action": "suspended",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Unsuspend user

Let a suspended user sign in again. If they aren't suspended, the step stops and changes nothing.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.

**Outputs**

- `action` (text): What was done
- `done` (true/false): Always true once done
- `user_id` (text): The user changed

**Example output**

```json
{
  "action": "unsuspended",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}
```

### Update device group

Rename a device group or change its description.

**Inputs**

- Device group (`group_id`, text, required): The device group. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name for the group. Leave empty to keep it.
- Description (`description`, text): A new description. Leave empty to keep it.

**Outputs**

- `group` (object): The device group

**Example output**

```json
{
  "group": {
    "description": "Company laptops",
    "id": "5f3d7b8e9c1a2b0011112222",
    "membershipMethod": "STATIC",
    "name": "Servers",
    "type": "system_group"
  }
}
```

### Update user

Change a user's email or profile. Fields left empty keep their value.

**Inputs**

- User (`jumpcloud_user_id`, text, required): The user. Pick one, or give their id from an earlier step.
- Email (`email`, text): A new email address. Leave empty to keep it.
- First name (`firstname`, text): The user's first name.
- Last name (`lastname`, text): The user's last name.
- Department (`department`, text): The user's department.
- Job title (`job_title`, text): The user's job title.
- Company (`company`, text): The company the user works for.
- Location (`location`, text): Where the user is based.
- Description (`description`, text): A note about the user.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "_id": "5f3d7b8e9c1a2b0012345678",
    "account_locked": false,
    "activated": false,
    "company": "Example Inc",
    "created": "2026-10-15T09:00:00Z",
    "department": "Support",
    "description": "Joined in October",
    "displayname": "Jo Bloggs",
    "email": "jo@example.com",
    "firstname": "Jo",
    "jobTitle": "Engineer",
    "lastname": "Bloggs",
    "location": "London",
    "password_expired": false,
    "state": "STAGED",
    "suspended": false,
    "totp_enabled": false,
    "username": "jo.bloggs"
  }
}
```

### Update user group

Rename a user group or change its description.

**Inputs**

- User group (`group_id`, text, required): The user group. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name for the group. Leave empty to keep it.
- Description (`description`, text): A new description. Leave empty to keep it.

**Outputs**

- `group` (object): The user group

**Example output**

```json
{
  "group": {
    "description": "Everyone in engineering",
    "id": "5f3d7b8e9c1a2b0087654321",
    "membershipMethod": "STATIC",
    "name": "Platform",
    "type": "user_group"
  }
}
```
