Skip to main content

JumpCloud

JumpCloud cloud directory platform — manage directory users, systems/devices, user/system/policy groups, commands and command results, SSO applications, policies, RADIUS servers and organizations.

Categories: IT & Security, Identity & Access Management, Device Management

Set up​

JumpCloud connects with credentials from your JumpCloud account. Have these values ready:

  • API key
  1. Go to Organization > Connectors and find JumpCloud.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

JumpCloud offers 67 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (29)​

View and search information without changing it.

ToolWhat it does
get_applicationGet a JumpCloud SSO application by ID.
get_commandGet a JumpCloud command by ID.
get_command_resultGet a JumpCloud command result by ID.
get_organizationGet a JumpCloud organization by ID.
get_policyGet a JumpCloud policy by ID.
get_policy_groupGet a JumpCloud policy group by ID.
get_radius_serverGet a JumpCloud RADIUS server by ID.
get_systemGet a JumpCloud system/device by ID.
get_system_groupGet a JumpCloud system group by ID.
get_userGet a JumpCloud system user by ID.
get_user_groupGet a JumpCloud user group by ID.
list_applicationsList JumpCloud SSO applications with offset pagination.
list_command_resultsList JumpCloud command results (outputs from past command runs) with offset pagination, sort and fields.
list_commandsList JumpCloud commands with offset pagination.
list_organizationsList JumpCloud organizations the API key can access, with offset pagination, sort, fields and filter.
list_policiesList JumpCloud policies with offset pagination.
list_policy_groupsList JumpCloud policy groups with offset pagination.
list_policy_templatesList JumpCloud policy templates with offset pagination.
list_radius_serversList JumpCloud RADIUS servers with offset pagination, sort, fields and filter.
list_system_group_membersList the direct member connections of a JumpCloud system group.
list_system_group_membershipList the resolved membership of a JumpCloud system group (systems that belong to it, direct and indirect).
list_system_groupsList JumpCloud system groups with offset pagination.
list_systemsList JumpCloud managed systems/devices with offset pagination.
list_user_group_membersList the direct member connections of a JumpCloud user group.
list_user_group_membershipList the resolved membership of a JumpCloud user group (users that belong to it, direct and indirect).
list_user_groupsList JumpCloud user groups with offset pagination.
list_user_ssh_keysList a JumpCloud user's SSH public keys.
list_usersList JumpCloud system users (directory identities) with offset pagination.
validate_credentialValidate the JumpCloud API key with a lightweight system-users lookup.

Write (8)​

Create or send data.

ToolWhat it does
create_commandCreate a JumpCloud command. command, command_type and name are required.
create_policyCreate a JumpCloud policy. name and template (a template object) are required; call list_policy_templates first to find a valid template.
create_policy_groupCreate a JumpCloud policy group. name is required.
create_radius_serverCreate a JumpCloud RADIUS server. name, network_source_ip and shared_secret are required.
create_system_groupCreate a JumpCloud system group. name is required.
create_userCreate a JumpCloud system user. username and email are required.
create_user_groupCreate a JumpCloud user group. name is required.
create_user_ssh_keyAdd an SSH public key to a JumpCloud user. name and public_key are required.

Delete or overwrite (30)​

Remove or replace existing data.

ToolWhat it does
activate_userActivate (reactivate) a suspended or staged JumpCloud user.
delete_commandDelete a JumpCloud command permanently.
delete_command_resultDelete a JumpCloud command result permanently.
delete_policyDelete a JumpCloud policy.
delete_policy_groupDelete a JumpCloud policy group.
delete_radius_serverDelete a JumpCloud RADIUS server.
delete_systemDelete (deprovision) a JumpCloud system permanently.
delete_system_groupDelete a JumpCloud system group.
delete_userDelete a JumpCloud system user permanently.
delete_user_groupDelete a JumpCloud user group.
delete_user_ssh_keyDelete an SSH public key from a JumpCloud user.
erase_systemRemotely erase (wipe) a JumpCloud system (built-in command).
lock_systemRemotely lock a JumpCloud system (built-in command).
manage_system_group_membersAdd or remove a system in a JumpCloud system group.
manage_user_group_membersAdd or remove a user in a JumpCloud user group.
reset_user_mfaReset a JumpCloud user's multi-factor authentication enrollment.
restart_systemRemotely restart a JumpCloud system (built-in command).
run_commandTrigger a JumpCloud command to run, optionally on specific systems.
shutdown_systemRemotely shut down a JumpCloud system (built-in command).
suspend_userSuspend a JumpCloud user, blocking sign-in without deleting them.
unlock_userUnlock a locked JumpCloud user account.
update_commandUpdate a JumpCloud command's text or settings.
update_organizationUpdate a JumpCloud organization's display name.
update_policyUpdate a JumpCloud policy's name, notes or values.
update_policy_groupUpdate a JumpCloud policy group's name or description.
update_radius_serverUpdate a JumpCloud RADIUS server's settings.
update_systemUpdate a JumpCloud system's settings (display name, SSH/MFA options).
update_system_groupUpdate a JumpCloud system group's name, description or email.
update_userUpdate a JumpCloud system user's profile fields.
update_user_groupUpdate a JumpCloud user group's name, description or email.
⌘J