The JumpCloud connector lets your AI agent act in each user's JumpCloud account. Each user connects their own JumpCloud API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 98 tools.
- Tools
- 98
- What they doRead · write · destructive
- 69 · 24 · 569 read24 write5 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the JumpCloud connection
In AgentKit > Connections, create a JumpCloud connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'jumpcloud'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize JumpCloud:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'jumpcloud_get_alert_stats',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "jumpcloud"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize JumpCloud:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="jumpcloud_get_alert_stats",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their JumpCloud credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooljumpcloud_get_alertRetrieve one JumpCloud alert by id.Read-onlyGet Alert
Retrieve one JumpCloud alert by id. Returns the alert with title, status, severity, category, source, remark and timestamps. Use get_alert when you have the alert id.
Inputs
idstringrequired- ObjectID of the alert. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_alert_statsGet alert statistics for the JumpCloud organization.Read-onlyGet Alert Stats
Get alert statistics for the JumpCloud organization. Returns context and totalCount with the breakdown of alerts. Use get_alert_stats for counts. Use list_alerts for the alerts themselves.
Inputs
groupBystring- Provide a list of group by strings as input. Possible values are 'GROUP_BY_STATUS', 'GROUP_BY_SEVERITY'.For combined grouping with 'GROUP_BY_STATUS' and 'GROUP_BY_SEVERITY' , the input should look like this: ['GROUP_BY_STATUS:GROUP_BY_SEVERITY'].Example : ["GROUP_BY_STATUS","GROUP_BY_SEVERITY","GROU...
jumpcloud_get_applicationRetrieve one JumpCloud SSO application by id.Read-onlyGet Application
Retrieve one JumpCloud SSO application by id. Returns the application with config, SSO settings, display fields and logo. Use get_application when you have the application id.
Inputs
idstringrequired- ObjectID of the application. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_application_templateRetrieve one JumpCloud SSO application template by id.Read-onlyGet Application Template
Retrieve one JumpCloud SSO application template by id. Returns the template with config, SSO and provisioning capabilities. Use get_application_template to see how a catalog app is configured.
Inputs
idstringrequired- ObjectID of the application template. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.
skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.
sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_get_commandRetrieve one saved JumpCloud command by id.Read-onlyGet Command
Retrieve one saved JumpCloud command by id. Returns the command definition including script body, type, launch type, schedule and targets. Use get_command when you have the command id.
Inputs
idstringrequired- ObjectID of the command. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
jumpcloud_get_command_resultRetrieve one JumpCloud command execution result by id.Read-onlyGet Command Result
Retrieve one JumpCloud command execution result by id. Returns the result with command, system, requestTime, responseTime and the response output. Use get_command_result to read the output of one run.
Inputs
idstringrequired- ObjectID of the command result. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
jumpcloud_get_ip_listRetrieve one JumpCloud IP list by id.Read-onlyGet IP List
Retrieve one JumpCloud IP list by id. Returns the IP list with name, description and ips. Use get_ip_list when you have the id.
Inputs
idstringrequired- ObjectID of the IP list. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_organizationRetrieve one JumpCloud organization by id.Read-onlyGet Organization
Retrieve one JumpCloud organization by id. Returns the organization with displayName, logoUrl, entitlement and account settings. Use get_organization when you have the organization id.
Inputs
idstringrequired- ObjectID of the organization. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
jumpcloud_get_policyRetrieve one JumpCloud device policy by id.Read-onlyGet Policy
Retrieve one JumpCloud device policy by id. Returns the policy with name, notes, template, configFields and configured values. Use get_policy when you have the policy id.
Inputs
idstringrequired- ObjectID of the policy. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_policy_groupRetrieve one JumpCloud policy group by id.Read-onlyGet Policy Group
Retrieve one JumpCloud policy group by id. Returns the group with name, description and attributes. Use get_policy_group when you have the group id.
Inputs
idstringrequired- ObjectID of the policy group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_policy_resultRetrieve one JumpCloud policy execution result by id.Read-onlyGet Policy Result
Retrieve one JumpCloud policy execution result by id. Returns the result with policyID, systemID, state, success, exitStatus, stdOut, stdErr and timestamps. Use get_policy_result when you have a result id from a list call.
Inputs
idstringrequired- ObjectID of the policy result. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_policy_templateRetrieve one JumpCloud policy template by id.Read-onlyGet Policy Template
Retrieve one JumpCloud policy template by id. Returns the template with description, osRestrictions and configFields. Use get_policy_template to see which settings a template exposes.
Inputs
idstringrequired- ObjectID of the policy template. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_radius_serverRetrieve one JumpCloud RADIUS server by id.Read-onlyGet RADIUS Server
Retrieve one JumpCloud RADIUS server by id. Returns the server with name, networkSourceIp, authIdp, mfa and user authentication settings. Use get_radius_server when you have the server id.
Inputs
idstringrequired- ObjectID of the RADIUS server. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_roleRetrieve one JumpCloud administrator role by id.Read-onlyGet Role
Retrieve one JumpCloud administrator role by id. Returns the role with name, description, scopes and ownership. Use get_role when you have the role id.
Inputs
role_idstringrequired- ObjectID of the role. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_software_appRetrieve one JumpCloud software application by id.Read-onlyGet Software App
Retrieve one JumpCloud software application by id. Returns the software app with displayName, settings and timestamps. Use get_software_app when you have the id.
Inputs
idstringrequired- ObjectID of the software application. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_systemRetrieve one JumpCloud device (system) by id.Read-onlyGet System
Retrieve one JumpCloud device (system) by id. Returns the full system record: hardware, OS, agent version, network and security settings, and attributes. Use get_system when you have the system id. Use list_systems or search_systems to find it.
Inputs
idstringrequired- ObjectID of the system. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
jumpcloud_get_system_groupRetrieve one JumpCloud device group by id.Read-onlyGet System Group
Retrieve one JumpCloud device group by id. Returns the group with name, description, email and member query settings. Use get_system_group when you have the group id.
Inputs
idstringrequired- ObjectID of the system group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_userRetrieve one JumpCloud user by id.Read-onlyGet User
Retrieve one JumpCloud user by id. Returns the full user record: identity, contact and job fields, state, MFA and lock status, and custom attributes. Use get_user when you already have the user id. Use list_users or search_users to find the id.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
jumpcloud_get_user_groupRetrieve one JumpCloud user group by id.Read-onlyGet User Group
Retrieve one JumpCloud user group by id. Returns the group with name, description, email, membershipMethod and member query settings. Use get_user_group when you have the group id.
Inputs
idstringrequired- ObjectID of the user group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_get_user_totp_infoGet TOTP (authenticator app) enrollment information for a JumpCloud user.Read-onlyGet User TOTP Info
Get TOTP (authenticator app) enrollment information for a JumpCloud user. Returns the TOTP enrollmentDate. Use get_user_totp_info to check whether a user has enrolled TOTP MFA.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_list_alert_notesList the notes attached to one JumpCloud alert.Read-onlyList Alert Notes
List the notes attached to one JumpCloud alert. Returns notes. Use list_alert_notes to read triage history.
Inputs
alertObjectIdstringrequired- ObjectID of the alert object. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_list_alert_occurrencesList the occurrences recorded for one JumpCloud alert.Read-onlyList Alert Occurrences
List the occurrences recorded for one JumpCloud alert. Returns alertOccurrences and count. Use list_alert_occurrences to see repeated triggers of an alert.
Inputs
idstringrequired- ObjectID of the alert. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitstring- Maximum number of records to return in one call. The API caps this at 100. Example: 25.
skipstring- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.
sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_alertsList JumpCloud alerts with optional filter, sort and paging.Read-onlyList Alerts
List JumpCloud alerts with optional filter, sort and paging. Returns alerts (objects with objectId, title, status, severity, category, sourceName and createdAt) and count. Use list_alerts to browse alerts. Use get_alert for one and get_alert_stats for counts.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitstring- Maximum number of records to return in one call. The API caps this at 100. Example: 25.
skipstring- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.
sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_application_templatesList the SSO application templates in the JumpCloud catalog.Read-onlyList Application Templates
List the SSO application templates in the JumpCloud catalog. Returns results (templates with id, name, displayName, jit, oidc) and totalCount. Use list_application_templates to find catalog apps. Use list_applications for ones already configured.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.
skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.
sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_application_user_groupsList the user groups that are bound to a JumpCloud SSO application.Read-onlyList Application User Groups
List the user groups that are bound to a JumpCloud SSO application. Returns an array of user group references with id, type and association paths. Use list_application_user_groups to see group-based access to an app.
Inputs
application_idstringrequired- ObjectID of the Application. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_application_usersList the users who can access a JumpCloud SSO application, directly or through groups.Read-onlyList Application Users
List the users who can access a JumpCloud SSO application, directly or through groups. Returns an array of user references with id, type and association paths. Use list_application_users to audit who has access to an app. Use list_application_user_groups for groups.
Inputs
application_idstringrequired- ObjectID of the Application. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_applicationsList JumpCloud SSO applications configured in the organization.Read-onlyList Applications
List JumpCloud SSO applications configured in the organization. Returns results (applications with id, name, displayLabel, ssoUrl, active) and totalCount. Use list_applications to browse apps. Use get_application for full config and list_application_users for access.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.
skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.
sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_command_resultsList execution results of JumpCloud commands across devices.Read-onlyList Command Results
List execution results of JumpCloud commands across devices. Returns results (command result objects with id, name, system, requestTime, responseTime, exitCode) and totalCount. Use list_command_results for all runs. Use list_results_for_command for one command.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_commandsList saved JumpCloud commands with optional filter, sort and paging.Read-onlyList Commands
List saved JumpCloud commands with optional filter, sort and paging. Returns results (command definitions with id, name, command, launchType, schedule) and totalCount. Use list_commands to browse commands. Use list_command_results to see their executions.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_directoriesList the directories (Google Workspace, Microsoft 365, LDAP, Active Directory and similar) connected to JumpCloud.Read-onlyList Directories
List the directories (Google Workspace, Microsoft 365, LDAP, Active Directory and similar) connected to JumpCloud. Returns an array of directories with id, name, type, defaultDomain and oAuthStatus. Use list_directories to see connected identity sources.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_insights_appsList applications installed on JumpCloud devices as reported by System Insights.Read-onlyList Insights Apps
List applications installed on JumpCloud devices as reported by System Insights. Returns an array with system_id, name, bundle_identifier, bundle_short_version and path details. Use list_insights_apps for installed-software inventory on macOS devices.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_insights_disk_encryptionList System Insights disk encryption status reported by JumpCloud devices.Read-onlyList Insights Disk Encryption
List System Insights disk encryption status reported by JumpCloud devices. Returns an array with system_id, name, encrypted, encryption_status and type. Use list_insights_disk_encryption to find unencrypted disks.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_insights_os_versionList System Insights operating system versions reported by JumpCloud devices.Read-onlyList Insights OS Version
List System Insights operating system versions reported by JumpCloud devices. Returns an array with system_id, name, version, major, minor, patch, build and platform. Use list_insights_os_version to find devices on outdated OS versions.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_insights_patchesList Windows patches and hotfixes reported by System Insights.Read-onlyList Insights Patches
List Windows patches and hotfixes reported by System Insights. Returns an array with system_id, hotfix_id, caption, description and install_date. Use list_insights_patches to audit Windows patch levels.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_insights_system_infoList System Insights hardware and system information collected from JumpCloud devices.Read-onlyList Insights System Info
List System Insights hardware and system information collected from JumpCloud devices. Returns an array with system_id, hostname, computer_name, hardware_model, hardware_serial, cpu and memory details. Use list_insights_system_info for hardware inventory. Use list_systems for agent and account data.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_ip_listsList the IP lists defined in JumpCloud (used for network access rules).Read-onlyList IP Lists
List the IP lists defined in JumpCloud (used for network access rules). Returns an array of IP lists with id, name, description, ips and managedBy. Use list_ip_lists to browse. Use get_ip_list for one.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_org_policy_resultsList policy execution results across all JumpCloud policies in the organization.Read-onlyList Policy Results For Organization
List policy execution results across all JumpCloud policies in the organization. Returns an array of results with policyID, systemID, state, success, exitStatus and timestamps. Use list_org_policy_results for an organization-wide view. Use list_policy_results for one policy.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_organizationsList the JumpCloud organizations the API key can access.Read-onlyList Organizations
List the JumpCloud organizations the API key can access. Returns results (organizations with _id, displayName and logoUrl) and totalCount. Use list_organizations to find organization ids. Use get_organization for details of one.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
sortIgnoreCasestring- Use space separated sort parameters to sort the collection, ignoring case. Default sort is ascending. Prefix with - to sort descending.
jumpcloud_list_policiesList JumpCloud device policies in the organization.Read-onlyList Policies
List JumpCloud device policies in the organization. Returns an array of policies with id, name and template reference. Use list_policies to browse policies. Use get_policy for configured values and list_policy_statuses for deployment results.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_policy_group_membersList the policies that belong to a JumpCloud policy group.Read-onlyList Policy Group Members
List the policies that belong to a JumpCloud policy group. Returns an array of graph connections with from and to objects identifying each policy. Use list_policy_group_members to see group contents.
Inputs
group_idstringrequired- ObjectID of the Policy Group. Example: 5f3a1b2c4d5e6f7890123456.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_policy_groupsList JumpCloud policy groups.Read-onlyList Policy Groups
List JumpCloud policy groups. Returns an array of policy groups with id, name and description. Use list_policy_groups to browse groups. Use list_policy_group_members to see the policies in one.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_policy_resultsList the execution results of one JumpCloud policy across devices.Read-onlyList Policy Results
List the execution results of one JumpCloud policy across devices. Returns an array of results with systemID, state, success, exitStatus, startedAt, endedAt, stdOut and stdErr. Use list_policy_results for the full history of one policy. Use list_policy_statuses for the latest result per device.
Inputs
policy_idstringrequired- ObjectID of the policy. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_policy_statusesList the latest status of one JumpCloud policy on each device it applies to.Read-onlyList Policy Statuses
List the latest status of one JumpCloud policy on each device it applies to. Returns an array with systemID, state, success, exitStatus, detail and timestamps. Use list_policy_statuses to see current compliance of a policy. Use list_system_policy_statuses for one device.
Inputs
policy_idstringrequired- ObjectID of the policy. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_policy_templatesList the policy templates available to create JumpCloud policies from.Read-onlyList Policy Templates
List the policy templates available to create JumpCloud policies from. Returns an array of templates with id, name, displayName, osMetaFamily, behavior and description. Use list_policy_templates to find a template id. Use get_policy_template for its config fields.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_radius_serversList JumpCloud RADIUS servers.Read-onlyList RADIUS Servers
List JumpCloud RADIUS servers. Returns results (RADIUS servers with id, name, networkSourceIp, authIdp, mfa) and totalCount. Use list_radius_servers to browse. Use get_radius_server for one.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_results_for_commandList the execution results of one saved JumpCloud command.Read-onlyList Results For Command
List the execution results of one saved JumpCloud command. Returns an array of command result objects with system, requestTime, responseTime and response. Use list_results_for_command to see every run of a command. Use list_command_results for all commands.
Inputs
idstringrequired- ObjectID of the command. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_rolesList administrator roles available in JumpCloud.Read-onlyList Roles
List administrator roles available in JumpCloud. Returns results (roles with id, name, scopes, isCustom, ownerType) and totalCount. Use list_roles to browse admin roles. Use get_role for one.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_software_app_statusesList the per-device install status of one JumpCloud software application.Read-onlyList Software App Statuses
List the per-device install status of one JumpCloud software application. Returns an array with systemId, state, details, code, version and timestamp. Use list_software_app_statuses to check rollout progress.
Inputs
software_app_idstringrequired- ObjectID of the Software App. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_software_appsList software applications configured for deployment in JumpCloud.Read-onlyList Software Apps
List software applications configured for deployment in JumpCloud. Returns an array of software apps with id, displayName, settings, createdAt and updatedAt. Use list_software_apps to browse. Use list_software_app_statuses for per-device install results.
Inputs
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_system_associationsList what a JumpCloud device is directly associated with (for example commands, policies, users, user groups).Read-onlyList System Associations
List what a JumpCloud device is directly associated with (for example commands, policies, users, user groups). Returns an array of graph connections with from and to objects. Use list_system_associations for direct bindings of one device.
Inputs
system_idstringrequired- ObjectID of the System. Example: 5f3a1b2c4d5e6f7890123456.
targetsstringrequired- Comma-separated list of target object types to list associations for. Valid values: command, policy, policy_group, user, user_group. Example: command.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_system_group_associationsList what a JumpCloud device group is directly associated with (for example commands, policies, policy groups, user groups).Read-onlyList System Group Associations
List what a JumpCloud device group is directly associated with (for example commands, policies, policy groups, user groups). Returns an array of graph connections with from and to objects. Use list_system_group_associations for direct bindings of a device group.
Inputs
group_idstringrequired- ObjectID of the System Group. Example: 5f3a1b2c4d5e6f7890123456.
targetsstringrequired- Comma-separated list of target object types to list associations for. Valid values: command, policy, policy_group, radius_server, user, user_group. Example: command.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_system_group_membersList the devices that belong to a JumpCloud device group.Read-onlyList System Group Members
List the devices that belong to a JumpCloud device group. Returns an array of graph connections with from and to objects identifying each member device. Use list_system_group_members to see group membership. Use list_system_group_memberships to see which groups a device is in.
Inputs
group_idstringrequired- ObjectID of the System Group. Example: 5f3a1b2c4d5e6f7890123456.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_system_group_membershipsList the device groups a JumpCloud device belongs to.Read-onlyList System Group Memberships
List the device groups a JumpCloud device belongs to. Returns an array of group references with id, type and membership paths. Use list_system_group_memberships to see a device's groups. Use list_system_group_members for the reverse.
Inputs
system_idstringrequired- ObjectID of the System. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_system_groupsList JumpCloud device (system) groups with optional filter, sort and paging.Read-onlyList System Groups
List JumpCloud device (system) groups with optional filter, sort and paging. Returns an array of system groups with id, name, description and membershipMethod. Use list_system_groups to browse device groups. Use list_system_group_members to see devices in one.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_system_policy_statusesList the latest status of every JumpCloud policy applied to one device.Read-onlyList System Policy Statuses
List the latest status of every JumpCloud policy applied to one device. Returns an array with policyID, state, success, exitStatus, detail and timestamps. Use list_system_policy_statuses to check one device's compliance. Use list_policy_statuses for one policy.
Inputs
system_idstringrequired- ObjectID of the System. Example: 5f3a1b2c4d5e6f7890123456.
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_system_usersList the users who can access a JumpCloud device, directly or through groups.Read-onlyList System Users
List the users who can access a JumpCloud device, directly or through groups. Returns an array of user references with id, type and association paths. Use list_system_users to answer who can sign in to a device. Use list_user_systems for the reverse.
Inputs
system_idstringrequired- ObjectID of the System. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_systemsList devices (systems) enrolled in JumpCloud, with optional filter, sort and paging.Read-onlyList Systems
List devices (systems) enrolled in JumpCloud, with optional filter, sort and paging. Returns results (system objects with id, hostname, OS, agent version, status) and totalCount. Use list_systems to browse or filter devices. Use search_systems for compound queries and get_system for one device.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_user_applicationsList the SSO applications a JumpCloud user can access, directly or through groups.Read-onlyList User Applications
List the SSO applications a JumpCloud user can access, directly or through groups. Returns an array of application references with id, type and association paths. Use list_user_applications to audit a user's app access. Use list_application_users for the reverse.
Inputs
user_idstringrequired- ObjectID of the User. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_user_associationsList what a JumpCloud user is directly associated with (for example applications, systems, policies, RADIUS servers).Read-onlyList User Associations
List what a JumpCloud user is directly associated with (for example applications, systems, policies, RADIUS servers). Returns an array of graph connections with from and to objects. Use list_user_associations for direct bindings only. Use list_user_applications or list_user_systems for everything reachable including through groups.
Inputs
targetsstringrequired- Comma-separated list of target object types to list associations for. Valid values: active_directory, application, g_suite, idp_routing_policy, ldap_server, office_365, password_manager_item, policy, policy_group, radius_server, system, system_group. Example: active_directory.
user_idstringrequired- ObjectID of the User. Example: 5f3a1b2c4d5e6f7890123456.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_user_group_associationsList what a JumpCloud user group is directly associated with (for example applications, systems, policies, RADIUS servers).Read-onlyList User Group Associations
List what a JumpCloud user group is directly associated with (for example applications, systems, policies, RADIUS servers). Returns an array of graph connections with from and to objects. Use list_user_group_associations for direct bindings only. Use list_user_group_systems for the devices reachable through the group.
Inputs
group_idstringrequired- ObjectID of the User Group. Example: 5f3a1b2c4d5e6f7890123456.
targetsstringrequired- Comma-separated list of target object types to list associations for. Valid values: active_directory, application, g_suite, idp_routing_policy, ldap_server, office_365, password_manager_item, policy, policy_group, radius_server, system, system_group. Example: active_directory.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_user_group_membersList the users that belong to a JumpCloud user group.Read-onlyList User Group Members
List the users that belong to a JumpCloud user group. Returns an array of graph connections with from and to objects identifying each member user. Use list_user_group_members to see group membership. Use list_user_group_memberships to see which groups a user is in.
Inputs
group_idstringrequired- ObjectID of the User Group. Example: 5f3a1b2c4d5e6f7890123456.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_user_group_membershipsList the user groups a JumpCloud user belongs to.Read-onlyList User Group Memberships
List the user groups a JumpCloud user belongs to. Returns an array of group references with id, type and membership paths. Use list_user_group_memberships to see a user's groups. Use list_user_group_members for the reverse.
Inputs
user_idstringrequired- ObjectID of the User. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_user_group_systemsList the devices reachable through a JumpCloud user group.Read-onlyList User Group Systems
List the devices reachable through a JumpCloud user group. Returns an array of system references with id, type and association paths. Use list_user_group_systems to see device access granted by a group.
Inputs
group_idstringrequired- ObjectID of the User Group. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_user_groupsList JumpCloud user groups with optional filter, sort and paging.Read-onlyList User Groups
List JumpCloud user groups with optional filter, sort and paging. Returns an array of user groups with id, name, description, membershipMethod and type. Use list_user_groups to browse groups. Use list_user_group_members to see who is in one.
Inputs
fieldsstring- Comma-separated field names to include in each returned record. Omit to get the default field set. Example: id,name.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Comma-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_list_user_ssh_keysList the public SSH keys stored on a JumpCloud user.Read-onlyList User SSH Keys
List the public SSH keys stored on a JumpCloud user. Returns an array of keys with id, name, public_key and create_date. Use list_user_ssh_keys to audit SSH access for one user.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_list_user_systemsList the devices a JumpCloud user can access, directly or through groups.Read-onlyList User Systems
List the devices a JumpCloud user can access, directly or through groups. Returns an array of system references with id, type and association paths. Use list_user_systems to answer which devices a user can sign in to. Use list_system_users for the reverse.
Inputs
user_idstringrequired- ObjectID of the User. Example: 5f3a1b2c4d5e6f7890123456.
filterstring- Filter expression in the form field:operator:value using v2 operators such as eq, ne, gt, ge, lt, le, between, search and in. Example: name:eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_list_usersList JumpCloud users (system users) in the organization, with optional filter, sort and paging.Read-onlyList Users
List JumpCloud users (system users) in the organization, with optional filter, sort and paging. Returns results (user objects with id, username, email, state, MFA and account flags) and totalCount. Use list_users to browse or filter. Use search_users for text or multi-field searches, and get_user for one user by id.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit to get the default field set. Example: username email.
filterstring- Filter expression in the form field:$operator:value using v1 operators such as $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte and $sw. Example: department:$eq:Engineering.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0 sortstring- Space-separated field names to sort by. Prefix a field with - for descending order. Example: -created.
jumpcloud_search_systemsSearch JumpCloud devices with a filter or search-filter body for more complex queries than list_systems supports.Read-onlySearch Systems
Search JumpCloud devices with a filter or search-filter body for more complex queries than list_systems supports. Returns results (matching system objects) and totalCount. Use search_systems for compound or text searches. Use list_systems for simple paging. This call only reads data.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit for the default field set. Example: email username.
filterobject- Object with a single and or or key whose value is an array of field-match expressions. and matches all expressions and or matches any. Example: {"or": [{"department": "IT"}, {"department": "Sales"}]}.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 searchFilterobject- Text search object with searchTerm (a string or an array of strings) and fields (the field names to match against). A record matches when any listed field partially matches the term. Example: {"searchTerm": "@example.com", "fields": ["email"]}.
skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_search_usersSearch JumpCloud users with a filter or search-filter body for more complex queries than list_users supports.Read-onlySearch Users
Search JumpCloud users with a filter or search-filter body for more complex queries than list_users supports. Returns results (matching user objects) and totalCount. Use search_users for compound or text searches. Use list_users for simple paging and single-field filters. This call only reads data.
Inputs
fieldsstring- Space-separated field names to include in each returned record. Omit for the default field set. Example: email username.
filterobject- Object with a single and or or key whose value is an array of field-match expressions. and matches all expressions and or matches any. Example: {"or": [{"department": "IT"}, {"department": "Sales"}]}.
limitinteger- Maximum number of records to return in one call. The API caps this at 100. Example: 25.default
10 searchFilterobject- Text search object with searchTerm (a string or an array of strings) and fields (the field names to match against). A record matches when any listed field partially matches the term. Example: {"searchTerm": "@example.com", "fields": ["email"]}.
skipinteger- Number of records to skip before returning results, used for paging. Example: 0 for the first page, 25 for the second page when limit is 25.default
0
jumpcloud_activate_userActivate a staged JumpCloud user and send the activation email.WriteActivate User
Activate a staged JumpCloud user and send the activation email. Returns a confirmation string. Use activate_user for users in the STAGED state. Use update_user to move a suspended user back to ACTIVATED.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
emailobject- Email address the activation message is sent to. Defaults to the address on the user record. Example: jane.doe@example.com. Provide JSON.
jumpcloud_add_alert_noteAdd a note to a JumpCloud alert.WriteAdd Alert Note
Add a note to a JumpCloud alert. Returns the created note. Use add_alert_note to record findings. Use update_alert_status to change the status.
Inputs
alertNotestringrequired- Text of the note to add to the alert. Example: Confirmed false positive.
alertObjectIdstringrequired- ObjectID of the alert object. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_create_commandCreate a saved JumpCloud command (script) definition.WriteCreate Command
Create a saved JumpCloud command (script) definition. This does not run it on devices. Returns the created command including its id. Use create_command to define a script. Use manage_system_association or manage_system_group_association to target devices.
Inputs
commandstringrequired- The script or command body to run on devices. Example: echo hello.
commandTypestringrequired- Operating system the command targets. Valid values: linux, mac, windows. Example: linux.
namestringrequired- Name of the command shown in the JumpCloud console. Example: Rotate logs.
descriptionstring- Free-text description or notes. Example: Created via Scalekit.
launchTypestring- How the command is launched. Example: manual (run on demand), repeated (scheduled), trigger (webhook triggered).
schedulestring- Cron expression for scheduled commands, with seconds first. Example: 0 0 12 * * *.
scheduleRepeatTypestring- How often a scheduled command repeats. Example: day.
scheduleYearinteger- Year in which a one-off scheduled command runs. Example: 2026.
shellstring- Shell used to run the command on Linux and macOS. Example: bash.
sudoboolean- Set true to give the user administrator (sudo) rights on devices they can access. For commands, set true to run the command with elevated privileges.
timeoutstring- Seconds to let the command run before it is stopped. Example: 120.
timeToLiveSecondsinteger- Seconds a queued command waits for an offline device before it expires. Example: 600.
triggerstring- Name of the webhook trigger used when launchType is trigger. Example: my-trigger.
userstring- ObjectID of the system user the command runs as on the device, or 000000000000000000000000 for root. Example: 000000000000000000000000.
jumpcloud_create_system_groupCreate a JumpCloud device (system) group.WriteCreate System Group
Create a JumpCloud device (system) group. Returns the created group including its id. Use create_system_group to start a new group, then manage_system_group_member to add devices.
Inputs
namestringrequired- Display name of the system group. Example: Engineering.
descriptionstring- Description of the group. Example: All engineering staff.
emailstring- Email address associated with the group. Example: engineering@example.com.
memberQueryobject- Dynamic group member query as a JSON object, used when membershipMethod is dynamic. Example: {"queryType": "FilterQuery", "filters": [{"field": "department", "operator": "eq", "value": "Engineering"}]}.
membershipMethodstring- How group membership is decided. STATIC means members are added by hand, the DYNAMIC options compute members from memberQuery. Valid values: NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, DYNAMIC_AUTOMATED.one of
NOTSETSTATICDYNAMIC_REVIEW_REQUIREDDYNAMIC_AUTOMATED
jumpcloud_create_userCreate a JumpCloud user in the organization.WriteCreate User
Create a JumpCloud user in the organization. Returns the created user record including its generated id. Use create_user to onboard a person. Use update_user to change an existing user.
Inputs
emailstringrequired- Primary email address of the user. Must be unique in the organization and is used for notifications and sign-in. Example: jane.doe@example.com.
usernamestringrequired- Unique login name for the user. Must be unique in the organization. Example: jdoe.
allow_public_keyboolean- Set true to allow the user to authenticate with SSH public keys on their devices.
alternateEmailstring- Secondary email address for the user, such as a personal address. Example: jane@personal.example.com.
companystring- Company the user works for. Example: Example Inc.
costCenterstring- Cost center the user is charged to. Example: CC-1001.
departmentstring- Department the user belongs to. Example: Engineering.
descriptionstring- Free-text description or notes. Example: Created via Scalekit.
displaynamestring- Name shown for the user in the JumpCloud console and apps. Example: Jane Doe.
employeeIdentifierstring- Employee ID for the user. Must be unique per user in the organization. Example: E-10234.
employeeTypestring- Employment type of the user. Example: Full time.
enable_user_portal_multifactorboolean- Set true to require multi-factor authentication for the user when signing in to the User Portal.
firstnamestring- Given name of the user. Example: Jane.
jobTitlestring- Job title of the user. Example: Software Engineer.
lastnamestring- Family name of the user. Example: Doe.
locationstring- Office or work location of the user. Example: Denver.
managerstring- ObjectID of another JumpCloud user who is this user's manager. Example: 5f3a1b2c4d5e6f7890123456.
middlenamestring- Middle name of the user. Example: Quinn.
passwordstring- Initial or new password for the user. Must satisfy the organization password policy. Omit to let the user set it during activation.
password_never_expiresboolean- Set true so the password never expires, or false to follow the password expiration policy.
passwordless_sudoboolean- Set true to grant sudo without a password on Linux and macOS devices the user can access.
statestring- Lifecycle state of the user. STAGED users are not active until activated, ACTIVATED users can sign in, SUSPENDED users cannot. Example: ACTIVATED. Valid values: STAGED, ACTIVATED, SUSPENDED.one of
STAGEDACTIVATEDSUSPENDED sudoboolean- Set true to give the user administrator (sudo) rights on devices they can access. For commands, set true to run the command with elevated privileges.
jumpcloud_create_user_groupCreate a JumpCloud user group.WriteCreate User Group
Create a JumpCloud user group. Returns the created group including its id. Use create_user_group to start a new group, then manage_user_group_member to add users.
Inputs
namestringrequired- Display name of the user group. Example: Engineering.
descriptionstring- Description of the group. Example: All engineering staff.
emailstring- Email address associated with the group. Example: engineering@example.com.
memberQueryobject- Dynamic group member query as a JSON object, used when membershipMethod is dynamic. Example: {"queryType": "FilterQuery", "filters": [{"field": "department", "operator": "eq", "value": "Engineering"}]}.
membershipMethodstring- How group membership is decided. STATIC means members are added by hand, the DYNAMIC options compute members from memberQuery. Valid values: NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, DYNAMIC_AUTOMATED.one of
NOTSETSTATICDYNAMIC_REVIEW_REQUIREDDYNAMIC_AUTOMATED
jumpcloud_expire_user_passwordExpire a JumpCloud user password so the user must set a new one at next sign-in.WriteExpire User Password
Expire a JumpCloud user password so the user must set a new one at next sign-in. Returns a confirmation string. Use expire_user_password to force a password change.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_lock_systemSend the built-in lock command to a JumpCloud device.WriteLock System
Send the built-in lock command to a JumpCloud device. Returns an empty response on success (HTTP 201). Use lock_system to lock a lost or compromised device. Use restart_system to reboot it.
Inputs
system_idstringrequired- ObjectID of the system. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_manage_system_associationAdd or remove an association between a JumpCloud device and a command, policy, policy group, user or user group.WriteManage System Association
Add or remove an association between a JumpCloud device and a command, policy, policy group, user or user group. Returns an empty response on success (HTTP 204). Use manage_system_association to bind a single device. Prefer groups for many devices.
Inputs
idstringrequired- ObjectID of the object being added or removed. Example: 5f3a1b2c4d5e6f7890123456.
opstringrequired- How to modify the connection: add, remove or update.one of
addremoveupdate system_idstringrequired- ObjectID of the System. Example: 5f3a1b2c4d5e6f7890123456.
typestringrequired- Type of the object being added or removed. Valid values: command, policy, policy_group, user, user_group.one of
commandpolicypolicy_groupuseruser_group attributesobject- Custom key and value attributes as a JSON array of objects with name and value. Example: [{"name": "badge", "value": "1234"}].
jumpcloud_manage_system_group_associationAdd or remove an association between a JumpCloud device group and a command, policy, policy group, user or user group.WriteManage System Group Association
Add or remove an association between a JumpCloud device group and a command, policy, policy group, user or user group. Returns an empty response on success (HTTP 204). Use manage_system_group_association to apply policies or commands to a device group.
Inputs
group_idstringrequired- ObjectID of the System Group. Example: 5f3a1b2c4d5e6f7890123456.
idstringrequired- ObjectID of the object being added or removed. Example: 5f3a1b2c4d5e6f7890123456.
opstringrequired- How to modify the connection: add, remove or update.one of
addremoveupdate typestringrequired- Type of the object being added or removed. Valid values: command, policy, policy_group, radius_server, user, user_group.one of
commandpolicypolicy_groupradius_serveruseruser_group attributesobject- Custom key and value attributes as a JSON array of objects with name and value. Example: [{"name": "badge", "value": "1234"}].
jumpcloud_manage_system_group_memberAdd or remove one device in a JumpCloud device group.WriteManage System Group Member
Add or remove one device in a JumpCloud device group. Returns an empty response on success (HTTP 204). Use manage_system_group_member to change group membership. Use manage_system_group_association to bind the group to users, policies or commands.
Inputs
group_idstringrequired- ObjectID of the System Group. Example: 5f3a1b2c4d5e6f7890123456.
idstringrequired- ObjectID of the object being added or removed. Example: 5f3a1b2c4d5e6f7890123456.
opstringrequired- How to modify the connection: add, remove or update.one of
addremoveupdate typestringrequired- Type of the member being added or removed. Valid value: system.one of
system attributesobject- Custom key and value attributes as a JSON array of objects with name and value. Example: [{"name": "badge", "value": "1234"}].
jumpcloud_manage_user_associationAdd or remove an association between a JumpCloud user and an application, system, policy, RADIUS server or other target.WriteManage User Association
Add or remove an association between a JumpCloud user and an application, system, policy, RADIUS server or other target. Returns an empty response on success (HTTP 204). Use manage_user_association to grant one user direct access. Prefer groups with manage_user_group_member for many users.
Inputs
idstringrequired- ObjectID of the object being added or removed. Example: 5f3a1b2c4d5e6f7890123456.
opstringrequired- How to modify the connection: add, remove or update.one of
addremoveupdate typestringrequired- Type of the object being added or removed. Valid values: active_directory, application, g_suite, idp_routing_policy, ldap_server, office_365, password_manager_item, policy, policy_group, radius_server, system, system_group.one of
active_directoryapplicationg_suiteidp_routing_policyldap_serveroffice_365password_manager_itempolicypolicy_groupradius_serversystemsystem_group user_idstringrequired- ObjectID of the User. Example: 5f3a1b2c4d5e6f7890123456.
attributesobject- Custom key and value attributes as a JSON array of objects with name and value. Example: [{"name": "badge", "value": "1234"}].
jumpcloud_manage_user_group_associationAdd or remove an association between a JumpCloud user group and another object such as an application, system, policy or RADIUS server.WriteManage User Group Association
Add or remove an association between a JumpCloud user group and another object such as an application, system, policy or RADIUS server. Returns an empty response on success (HTTP 204). Use manage_user_group_association to grant a group access. Use manage_user_group_member to change who is in the group.
Inputs
group_idstringrequired- ObjectID of the User Group. Example: 5f3a1b2c4d5e6f7890123456.
idstringrequired- ObjectID of the object being added or removed. Example: 5f3a1b2c4d5e6f7890123456.
opstringrequired- How to modify the connection: add, remove or update.one of
addremoveupdate typestringrequired- Type of the object being added or removed. Valid values: active_directory, application, g_suite, idp_routing_policy, ldap_server, office_365, password_manager_item, policy, policy_group, radius_server, system, system_group.one of
active_directoryapplicationg_suiteidp_routing_policyldap_serveroffice_365password_manager_itempolicypolicy_groupradius_serversystemsystem_group attributesobject- Custom key and value attributes as a JSON array of objects with name and value. Example: [{"name": "badge", "value": "1234"}].
jumpcloud_manage_user_group_memberAdd or remove one user in a JumpCloud user group.WriteManage User Group Member
Add or remove one user in a JumpCloud user group. Returns an empty response on success (HTTP 204). Use manage_user_group_member to change group membership. Use manage_user_group_association to bind the group to systems, apps or policies.
Inputs
group_idstringrequired- ObjectID of the User Group. Example: 5f3a1b2c4d5e6f7890123456.
idstringrequired- ObjectID of the object being added or removed. Example: 5f3a1b2c4d5e6f7890123456.
opstringrequired- How to modify the connection: add, remove or update.one of
addremoveupdate typestringrequired- Type of the member being added or removed. Valid value: user.one of
user attributesobject- Custom key and value attributes as a JSON array of objects with name and value. Example: [{"name": "badge", "value": "1234"}].
jumpcloud_reset_user_mfaReset the MFA token of a JumpCloud user so they re-enroll, optionally exempting them from MFA for a period.WriteReset User MFA
Reset the MFA token of a JumpCloud user so they re-enroll, optionally exempting them from MFA for a period. Returns a confirmation string. Use reset_user_mfa when a user lost their MFA device. Use get_user_totp_info to check enrollment first.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
exclusionboolean- Set true to exempt the user from MFA, for example until exclusionUntil, instead of forcing re-enrollment.
exclusionDaysnumber- Number of days the MFA exemption lasts, as an alternative to exclusionUntil. Example: 7.
exclusionUntilstring- ISO 8601 timestamp when the MFA exemption ends. Example: 2026-12-31T00:00:00Z.
jumpcloud_restart_systemSend the built-in restart command to a JumpCloud device.WriteRestart System
Send the built-in restart command to a JumpCloud device. Returns an empty response on success (HTTP 201). Use restart_system to reboot a device remotely. The device restarts without prompting the user.
Inputs
system_idstringrequired- ObjectID of the system. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_suspend_userSuspend a JumpCloud user so they can no longer sign in.WriteSuspend User
Suspend a JumpCloud user so they can no longer sign in. Returns an empty response on success. Use suspend_user to disable access while keeping the account. Use activate_user to restore it.
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_unlock_userUnlock a JumpCloud user account that was locked after failed logins.WriteUnlock User
Unlock a JumpCloud user account that was locked after failed logins. Returns a confirmation string. Use unlock_user for locked accounts (account_locked is true).
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_update_alert_statusSet the status of a JumpCloud alert (for example acknowledge or resolve) with an optional remark.WriteUpdate Alert Status
Set the status of a JumpCloud alert (for example acknowledge or resolve) with an optional remark. Returns the updated alert. Use update_alert_status to triage an alert. Use add_alert_note to record context without changing status.
Inputs
idstringrequired- ObjectID of the alert. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
statusstringrequired- New alert status. Valid values: ALERT_STATUS_OPEN, ALERT_STATUS_ACKNOWLEDGED, ALERT_STATUS_RESOLVED. Example: ALERT_STATUS_ACKNOWLEDGED.one of
ALERT_STATUS_OPENALERT_STATUS_ACKNOWLEDGEDALERT_STATUS_RESOLVEDALERT_STATUS_AUTO_RESOLVEDALERT_STATUS_DELETED remarkstring- Free-text remark stored with the status change. Example: Investigated and resolved.
jumpcloud_update_commandReplace the definition of a saved JumpCloud command.WriteUpdate Command
Replace the definition of a saved JumpCloud command. Name, command and commandType are required. Returns the updated command. Use update_command to edit a script or schedule.
- Idempotent
Inputs
commandstringrequired- The script or command body to run on devices. Example: echo hello.
commandTypestringrequired- Operating system the command targets. Valid values: linux, mac, windows. Example: linux.
idstringrequired- ObjectID of the command. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
namestringrequired- Name of the command shown in the JumpCloud console. Example: Rotate logs.
descriptionstring- Free-text description or notes. Example: Created via Scalekit.
launchTypestring- How the command is launched. Example: manual (run on demand), repeated (scheduled), trigger (webhook triggered).
schedulestring- Cron expression for scheduled commands, with seconds first. Example: 0 0 12 * * *.
scheduleRepeatTypestring- How often a scheduled command repeats. Example: day.
scheduleYearinteger- Year in which a one-off scheduled command runs. Example: 2026.
shellstring- Shell used to run the command on Linux and macOS. Example: bash.
sudoboolean- Set true to give the user administrator (sudo) rights on devices they can access. For commands, set true to run the command with elevated privileges.
timeoutstring- Seconds to let the command run before it is stopped. Example: 120.
timeToLiveSecondsinteger- Seconds a queued command waits for an offline device before it expires. Example: 600.
triggerstring- Name of the webhook trigger used when launchType is trigger. Example: my-trigger.
userstring- ObjectID of the system user the command runs as on the device, or 000000000000000000000000 for root. Example: 000000000000000000000000.
jumpcloud_update_systemUpdate display name, SSH and MFA settings or attributes on a JumpCloud device.WriteUpdate System
Update display name, SSH and MFA settings or attributes on a JumpCloud device. Only supplied fields change. Returns the updated system record. Use update_system to change device settings. Use lock_system or restart_system for device actions.
- Idempotent
Inputs
idstringrequired- ObjectID of the system. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
allowMultiFactorAuthenticationboolean- Set true to require multi-factor authentication when signing in to this device.
allowPublicKeyAuthenticationboolean- Set true to allow SSH public key authentication on this device.
allowSshPasswordAuthenticationboolean- Set true to allow SSH password authentication on this device.
allowSshRootLoginboolean- Set true to allow root login over SSH on this device. Leave false unless required.
displayNamestring- Display name of the device shown in the JumpCloud console. Example: Jane laptop.
jumpcloud_update_system_groupUpdate a JumpCloud device group.WriteUpdate System Group
Update a JumpCloud device group. The name is required. Returns the updated group. Use update_system_group to rename or reconfigure a group. Use manage_system_group_member to change membership.
- Idempotent
Inputs
idstringrequired- ObjectID of the system group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
namestringrequired- Display name of the system group. Example: Engineering.
descriptionstring- Description of the group. Example: All engineering staff.
emailstring- Email address associated with the group. Example: engineering@example.com.
memberQueryobject- Dynamic group member query as a JSON object, used when membershipMethod is dynamic. Example: {"queryType": "FilterQuery", "filters": [{"field": "department", "operator": "eq", "value": "Engineering"}]}.
membershipMethodstring- How group membership is decided. STATIC means members are added by hand, the DYNAMIC options compute members from memberQuery. Valid values: NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, DYNAMIC_AUTOMATED.one of
NOTSETSTATICDYNAMIC_REVIEW_REQUIREDDYNAMIC_AUTOMATED
jumpcloud_update_userUpdate fields on an existing JumpCloud user.WriteUpdate User
Update fields on an existing JumpCloud user. Only the fields you supply are changed. Returns the updated user record. Use update_user for profile, job or flag changes. Use suspend_user or activate_user to change account state, and unlock_user for locked accounts.
- Idempotent
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
account_lockedboolean- Set false to unlock the account or true to lock it. Prefer unlock_user for unlocking.
allow_public_keyboolean- Set true to allow the user to authenticate with SSH public keys on their devices.
alternateEmailstring- Secondary email address for the user, such as a personal address. Example: jane@personal.example.com.
companystring- Company the user works for. Example: Example Inc.
costCenterstring- Cost center the user is charged to. Example: CC-1001.
departmentstring- Department the user belongs to. Example: Engineering.
descriptionstring- Free-text description or notes. Example: Created via Scalekit.
displaynamestring- Name shown for the user in the JumpCloud console and apps. Example: Jane Doe.
emailstring- Primary email address of the user. Must be unique in the organization and is used for notifications and sign-in. Example: jane.doe@example.com.
employeeIdentifierstring- Employee ID for the user. Must be unique per user in the organization. Example: E-10234.
employeeTypestring- Employment type of the user. Example: Full time.
enable_user_portal_multifactorboolean- Set true to require multi-factor authentication for the user when signing in to the User Portal.
firstnamestring- Given name of the user. Example: Jane.
jobTitlestring- Job title of the user. Example: Software Engineer.
lastnamestring- Family name of the user. Example: Doe.
locationstring- Office or work location of the user. Example: Denver.
managerstring- ObjectID of another JumpCloud user who is this user's manager. Example: 5f3a1b2c4d5e6f7890123456.
middlenamestring- Middle name of the user. Example: Quinn.
passwordstring- Initial or new password for the user. Must satisfy the organization password policy. Omit to let the user set it during activation.
password_never_expiresboolean- Set true so the password never expires, or false to follow the password expiration policy.
statestring- Lifecycle state of the user. STAGED users are not active until activated, ACTIVATED users can sign in, SUSPENDED users cannot. Example: ACTIVATED. Valid values: ACTIVATED, SUSPENDED.one of
ACTIVATEDSUSPENDED sudoboolean- Set true to give the user administrator (sudo) rights on devices they can access. For commands, set true to run the command with elevated privileges.
usernamestring- Unique login name for the user. Must be unique in the organization. Example: jdoe.
jumpcloud_update_user_groupUpdate a JumpCloud user group.WriteUpdate User Group
Update a JumpCloud user group. The name is required and replaces the existing group definition fields you send. Returns the updated group. Use update_user_group to rename or reconfigure a group. Use manage_user_group_member to change membership.
- Idempotent
Inputs
idstringrequired- ObjectID of the user group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
namestringrequired- Display name of the user group. Example: Engineering.
descriptionstring- Description of the group. Example: All engineering staff.
emailstring- Email address associated with the group. Example: engineering@example.com.
memberQueryobject- Dynamic group member query as a JSON object, used when membershipMethod is dynamic. Example: {"queryType": "FilterQuery", "filters": [{"field": "department", "operator": "eq", "value": "Engineering"}]}.
membershipMethodstring- How group membership is decided. STATIC means members are added by hand, the DYNAMIC options compute members from memberQuery. Valid values: NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, DYNAMIC_AUTOMATED.one of
NOTSETSTATICDYNAMIC_REVIEW_REQUIREDDYNAMIC_AUTOMATED
jumpcloud_delete_commandDelete a saved JumpCloud command.DestructiveDelete Command
Delete a saved JumpCloud command. Returns the deleted command. Use delete_command to remove a command definition.
- Idempotent
Inputs
idstringrequired- ObjectID of the command. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_delete_systemRemove a device from JumpCloud.DestructiveDelete System
Remove a device from JumpCloud. The agent is uninstalled from the device. Returns the deleted system record. Use delete_system only to retire a device. This cannot be undone.
- Idempotent
Inputs
idstringrequired- ObjectID of the system. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_delete_system_groupDelete a JumpCloud device group.DestructiveDelete System Group
Delete a JumpCloud device group. Returns the deleted group. Use delete_system_group to remove a group. Devices in it are not deleted.
- Idempotent
Inputs
idstringrequired- ObjectID of the system group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
jumpcloud_delete_userPermanently delete a JumpCloud user.DestructiveDelete User
Permanently delete a JumpCloud user. Returns the deleted user record. Use delete_user only when the account must be removed. Use suspend_user to disable sign-in without deleting.
- Idempotent
Inputs
idstringrequired- ObjectID of the user. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
cascade_managerstring- Set to true to also delete or reassign users managed by this user according to the manager cascade rules. Omit for the default behavior.
jumpcloud_delete_user_groupDelete a JumpCloud user group.DestructiveDelete User Group
Delete a JumpCloud user group. Returns the deleted group. Use delete_user_group to remove a group. Users in it are not deleted.
- Idempotent
Inputs
idstringrequired- ObjectID of the user group. Example: 5f3a1b2c4d5e6f7890123456. Example: 5f3a1b2c4d5e6f7890123456.
No tools match.
