JumpCloud

App · 25 actions

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

Actions

ActionWhat it does
Activate userActivate a staged user so they can sign in.
Add user to groupAdd a user to a user group.
Create device groupCreate an empty device group.
Create userAdd a user to your directory.
Create user groupCreate an empty user group.
Delete device groupDelete a device group.
Delete userDelete a user for good, including their group memberships.
Delete user groupDelete a user group.
Expire user passwordExpire a user's password so they must choose a new one at next sign-in.
Get device groupGet one device group with its description and membership method.
Get userGet one user with their profile, state and lock or password status.
Get user groupGet one user group with its description and membership method.
List device groupsList the device groups, optionally those whose name contains some text.
List devicesList the computers enrolled in JumpCloud with their system, version and when they were last seen.
List organizationsList the organizations the API key can see.
List user group membersList the users in a user group, as ids.
List user groupsList the user groups, optionally those whose name contains some text.
List usersList the users in your directory, optionally only one state or department, newest or in name order.
Remove user from groupRemove a user from a user group.
Search usersFind users whose username, email or name contains some text.
Suspend userSuspend a user so they can no longer sign in.
Unsuspend userLet a suspended user sign in again.
Update device groupRename a device group or change its description.
Update userChange a user's email or profile.
Update user groupRename a user group or change its description.

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

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.
Send the welcome emailsend_emailtrue/false
Leave on for JumpCloud to email the user. Turn off if you'll tell them yourself.Default: true.

Outputs

actiontext
What was done
donetrue/false
Always true once done
user_idtext
The user changed
Example output
{
  "action": "activated",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}

Add user to group

Add a user to a user group.

Inputs

User groupgroup_idtextRequired
The user group. Pick one, or give its id from an earlier step.
Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

donetrue/false
Always true once done
group_idtext
The group changed
user_idtext
The user added or removed
Example output
{
  "done": true,
  "group_id": "5f3d7b8e9c1a2b0087654321",
  "user_id": "5f3d7b8e9c1a2b0012345678"
}

Create device group

Create an empty device group.

Inputs

NamenametextRequired
The group's name.
Descriptiondescriptiontext
What the group is for.

Outputs

groupobject
The device group
Example output
{
  "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

UsernameusernametextRequired
The sign-in name. Letters, digits, '.', '_' and '-'.
EmailemailtextRequired
The user's email address.
Statestatetext
Staged keeps the user inactive; Activated makes them live.One of: STAGED (Staged (no activation email yet)), ACTIVATED.
Passwordpasswordtext
An initial password. Leave empty to let them set one.
First namefirstnametext
The user's first name.
Last namelastnametext
The user's last name.
Departmentdepartmenttext
The user's department.
Job titlejob_titletext
The user's job title.
Companycompanytext
The company the user works for.
Locationlocationtext
Where the user is based.
Descriptiondescriptiontext
A note about the user.

Outputs

userobject
The user
Example output
{
  "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

NamenametextRequired
The group's name.
Descriptiondescriptiontext
What the group is for.

Outputs

groupobject
The user group
Example output
{
  "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 groupgroup_idtextRequired
The device group. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
group_idtext
The group deleted
Example output
{
  "deleted": true,
  "group_id": "5f3d7b8e9c1a2b0011112222"
}

Delete user

Delete a user for good, including their group memberships.

Inputs

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
userobject
The user as they were
user_idtext
The user deleted
Example output
{
  "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 groupgroup_idtextRequired
The user group. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
group_idtext
The group deleted
Example output
{
  "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

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

actiontext
What was done
donetrue/false
Always true once done
user_idtext
The user changed
Example output
{
  "action": "password expired",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}

Get device group

Get one device group with its description and membership method.

Inputs

Device groupgroup_idtextRequired
The device group. Pick one, or give its id from an earlier step.

Outputs

groupobject
The device group
Example output
{
  "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

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

userobject
The user
Example output
{
  "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 groupgroup_idtextRequired
The user group. Pick one, or give its id from an earlier step.

Outputs

groupobject
The user group
Example output
{
  "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 containsnametext
Only groups whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the last page.At least 0.

Outputs

countnumber
How many are in this page
groupslist
The device groups
has_moretrue/false
True if there are more after this page
next_skipnumber
The 'skip' that gets the next page, empty on the last page
Example output
{
  "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

Ordersorttext
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 sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the last page.At least 0.

Outputs

countnumber
How many are in this page
has_moretrue/false
True if there are more after this page
next_skipnumber
The 'skip' that gets the next page, empty on the last page
systemslist
The devices
total_countnumber
How many there are in all
Example output
{
  "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

countnumber
How many
organizationslist
The organizations
Example output
{
  "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 groupgroup_idtextRequired
The user group. Pick one, or give its id from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the last page.At least 0.

Outputs

countnumber
How many are in this page
has_moretrue/false
True if there are more after this page
memberslist
The users in the group
next_skipnumber
The 'skip' that gets the next page, empty on the last page
Example output
{
  "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 containsnametext
Only groups whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the last page.At least 0.

Outputs

countnumber
How many are in this page
groupslist
The user groups
has_moretrue/false
True if there are more after this page
next_skipnumber
The 'skip' that gets the next page, empty on the last page
Example output
{
  "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

Statestatetext
Only users in this state. Defaults to any.One of: all (Any state (default)), ACTIVATED, STAGED (Staged (not yet activated)), SUSPENDED.
Departmentdepartmenttext
Only users in this department (exact match).
Ordersorttext
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 sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the last page.At least 0.

Outputs

countnumber
How many are in this page
has_moretrue/false
True if there are more after this page
next_skipnumber
The 'skip' that gets the next page, empty on the last page
total_countnumber
How many there are in all
userslist
The users
Example output
{
  "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 groupgroup_idtextRequired
The user group. Pick one, or give its id from an earlier step.
Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

donetrue/false
Always true once done
group_idtext
The group changed
user_idtext
The user added or removed
Example output
{
  "done": true,
  "group_id": "5f3d7b8e9c1a2b0087654321",
  "user_id": "5f3d7b8e9c1a2b0012345678"
}

Search users

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

Inputs

Search forsearch_termtextRequired
Text to look for in usernames, emails and names.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the last page.At least 0.

Outputs

countnumber
How many are in this page
has_moretrue/false
True if there are more after this page
next_skipnumber
The 'skip' that gets the next page, empty on the last page
total_countnumber
How many there are in all
userslist
The users found
Example output
{
  "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

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

actiontext
What was done
donetrue/false
Always true once done
user_idtext
The user changed
Example output
{
  "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

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.

Outputs

actiontext
What was done
donetrue/false
Always true once done
user_idtext
The user changed
Example output
{
  "action": "unsuspended",
  "done": true,
  "user_id": "5f3d7b8e9c1a2b0012345678"
}

Update device group

Rename a device group or change its description.

Inputs

Device groupgroup_idtextRequired
The device group. Pick one, or give its id from an earlier step.
Namenametext
A new name for the group. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.

Outputs

groupobject
The device group
Example output
{
  "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

Userjumpcloud_user_idtextRequired
The user. Pick one, or give their id from an earlier step.
Emailemailtext
A new email address. Leave empty to keep it.
First namefirstnametext
The user's first name.
Last namelastnametext
The user's last name.
Departmentdepartmenttext
The user's department.
Job titlejob_titletext
The user's job title.
Companycompanytext
The company the user works for.
Locationlocationtext
Where the user is based.
Descriptiondescriptiontext
A note about the user.

Outputs

userobject
The user
Example output
{
  "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 groupgroup_idtextRequired
The user group. Pick one, or give its id from an earlier step.
Namenametext
A new name for the group. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.

Outputs

groupobject
The user group
Example output
{
  "group": {
    "description": "Everyone in engineering",
    "id": "5f3d7b8e9c1a2b0087654321",
    "membershipMethod": "STATIC",
    "name": "Platform",
    "type": "user_group"
  }
}

On this page