Articles in this section

Available JumpCloud APIs

When you configure an export, import, or other type of flow step using the prebuilt JumpCloud connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the JumpCloud API documentation. *You can also create a composite endpoint for this application in HTTP mode.

API v2 version

Resource

API endpoint

Export

Import

Active directory

List active directories

X

Create a new active directory

X

List active directory agents

X

Create a new active directory agent

X

Get an active directory agent

X

Delete active directory agent

X

Get an active directory

X

Delete an active directory

X

Update active directory

X

Graph

List the associations of an active directory instance

X

Manage the associations of an active directory instance

X

List the user groups bound to an active directory instance

X

List the users bound to an active directory instance

X

Organization

Get all cases (support/feature requests) for organization

X

Managed service provider

Remove association between an administrator and an organization

X

List the association links between an administrator and organizations

X

Allow administrator access to an organization

X

List the association links between an organization and administrators

X

Apple MDM

List Apple MDMs

X

List Apple MDM devices

X

Details of an Apple MDM device

X

Remove an Apple MDM device's enrollment

X

Clears the activation lock for a device

X

Erase device

X

Lock device

X

Request the status of an OS update for a device

X

Refresh activation lock information for a device

X

Restart device

X

Schedule an OS update for a device

X

Shut down device

X

List Apple MDM enrollment profiles

X

Refresh dep devices

X

Update an Apple MDM

X

Delete an Apple MDM

X

Applications

List the associations of an application

X

Manage the associations of an application

X

List the user groups bound to an application

X

List the users bound to an application

X

Get an application

X

Create an import job

X

Save application logo

X

SCIM import

Get a list of users to import from an application IDM service provider

X

Image

Delete application image

X

Authentication policies

List authentication policies

X

Create an authentication policy

X

Get an authentication policy

X

Delete authentication policy

X

Patch authentication policy

X

Bulk job requests

Bulk expire users

X

Bulk unlock users

X

Bulk users create

X

Bulk users update

X

List bulk users results

X

List scheduled user state change jobs

X

Create scheduled user state job

X

Get the next scheduled state change for a list of users

X

Delete scheduled user state job

X

Providers

Get the metadata for cases

X

Retrieve provider

X

List provider administrators

X

Create a new provider administrator

X

Get all cases (support/feature requests) for provider

X

List a provider's invoices

X

List provider organizations

X

Create provider organization

X

Update provider organization

X

Retrieve auto-task integration configuration

X

Delete auto-task integration

X

Update auto-task integration configuration

X

Retrieve auto-task companies

X

Retrieve auto-task company types

X

Retrieve auto-task contracts

X

Retrieve auto-task contract fields

X

Retrieve auto-task contract services

X

Retrieve auto-task mappings

X

Create edit and/or delete auto task mappings

X

Retrieve auto task integration settings

X

Create edit and/or delete auto task integration settings

X

Retrieve the Connectwise integration configuration

X

Delete Connectwise integration

X

Update Connectwise integration configuration

X

Retrieve Connectwise agreements

X

Retrieve Connectwise additions

X

Retrieve Connectwise companies

X

Retrieve Connectwise company types

X

Retrieve Connectwise mappings

X

Create edit and/or delete Connectwise mappings

Retrieve Connectwise integration settings

X

Create edit and/or delete Connectwise integration settings

Retrieve Syncro integration configuration

X

Delete Syncro integration

X

Update Syncro integration configuration

X

Retrieve Syncro billing mappings dependencies

X

Retrieve Syncro companies

X

Retrieve Syncro mappings

X

Create edit and/or delete syncro mappings

X

Retrieve Syncro integration settings

X

Create edit and/or delete syncro integration settings

Retrieve recent integration sync errors

X

Delete provider administrator

X

Retrieve billing details for a provider

X

Retrieve integrations for provider

X

Creates a new auto-task integration for the provider

X

Get all auto-task ticketing alert configurations for a provider

X

Get all auto-task ticketing alert configuration options for a provider

X

Update an auto-task ticketing alert's configuration

X

Creates a new Connectwise integration for the provider

X

Get all Connectwise ticketing alert configurations for a provider

X

Get all Connectwise ticketing alert configuration options for a provider

X

Update a Connectwise ticketing alert's configuration

X

Creates a new Syncro integration for the provider

X

Get all Syncro ticketing alert configurations for a provider

X

Get all Syncro ticketing alert configuration options for a provider

X

Update a Syncro ticketing alert's configuration

X

Get all ticketing alerts available for a provider's ticketing integration

X

Commands

List the associations of a command

X

Manage the associations of a command

X

List the system groups bound to a command

X

List the systems bound to a command

X

Cancel all queued commands for an organization by workflow instance ID

X

Fetch the queued commands for an organization

X

Command results

List all command results by workflow

X

Custom emails

List custom email templates

X

Create custom email configuration

X

Get custom email configuration

X

Update custom email configuration

X

Delete custom email configuration

X

Systems organization settings

Get the sign-in with JumpCloud settings

X

Set the sign-in with JumpCloud settings

X

Directories

List all directories

X

Duo

List Duo accounts

X

Create Duo account

X

List Duo applications

X

Create Duo application

X

Get a Duo application

X

Update Duo application

X

Delete a Duo application

X

Get a Duo account

X

Delete a Duo account

X

Feature trials

Check current feature trial usage for a specific feature

X

Google EMM

Get device

X

Erase the Android device

X

Lock device

X

Get the policy JSON of a device

X

Reboot device

X

Reset password of a device

X

Create an enrollment token

X

List Google enterprises

X

Create a Google enterprise

X

Delete a Google enterprise

X

Update a Google enterprise

X

Test connection with Google

X

Deletes an enrollment token for a given enterprise and token ID

X

List devices

X

List enrollment tokens

X

Create an enrollment token for a given enterprise

X

Get a signup URL to enroll in Google enterprise

X

Get a web token to render Google Play iframe

X

Groups

List all groups

X

G Suite

List the associations of a G Suite instance

X

Manage the associations of a G Suite instance

X

List the user groups bound to a G Suite instance

X

List the users bound to a G Suite instance

X

List all domains configured for the Google Workspace integration instance

X

Add a domain to a Google Workspace integration instance

X

Delete a domain from a Google Workspace integration instance

X

List all the G Suite translation rules

X

Create a new G Suite translation rule

X

Gets a specific G Suite translation rule

X

Deletes a G Suite translation rule

X

Get G Suite

X

Update existing G Suite

X

G Suite import

Get a list of users in JumpCloud format to import from a Google Workspace account

X

Get a list of users to import from a G Suite instance

X

IP lists

List IP lists

X

Create IP list

X

Get an IP list

X

Replace an IP list

X

Delete an IP list

X

Update an IP list

X

LDAP servers

List the associations of an LDAP server

X

Manage the associations of an LDAP server

X

List the user groups bound to an LDAP server

X

List the users bound to an LDAP server

X

List LDAP servers

X

Get LDAP server

X

Update existing LDAP server

X

Samba domains

List Samba domains

X

Create Samba domain

X

Get Samba domain

X

Update Samba domain

X

Delete Samba domain

X

Office 365

List the associations of an Office 365 instance

X

Manage the associations of an Office 365 instance

X

List the user groups bound to an Office 365 instance

X

List the users bound to an Office 365 instance

X

Get an Office 365 instance

X

Update existing Office 365 instance

X

List all domains configured for an Office 365 instance

X

Add a domain to an Office 365 instance

X

Delete a domain from an Office 365 instance

X

List all the Office 365 translation rules

X

Create a new Office 365 translation rule

X

Gets a specific Office 365 translation rule

X

Deletes an Office 365 translation rule

X

Office 365 import

Get a list of users to import from an Office 365 instance

X

Password manager

List devices

X

Get device

X

Policies

List the associations of a policy

X

Manage the associations of a policy

X

List the parent groups of a policy

X

List the system groups bound to a policy

X

List the systems bound to a policy

X

List the policy statuses for a system

X

Lists all the policies

X

Create a new policy

X

Gets a specific policy

X

Update an existing policy

X

Deletes a policy

X

Lists all the policy results of a policy

X

Lists the latest policy results of a policy

X

Lists all of the policy results for an organization

X

Get a specific policy result

X

Policy groups

List all policy groups

X

Create a new policy group

X

View an individual policy group details

X

Update a policy group

X

Delete a policy group

X

Policy group associations

List the associations of a policy group.

X

Manage the associations of a policy group

X

List the system groups bound to policy groups

X

List the systems bound to a policy group

X

Policy group members and membership

List the members of a policy group

X

Manage the members of a policy group

X

List the policy group's membership

X

Policy templates

Lists all of the policy templates

X

Get a specific policy template

X

Policy group templates

List a provider's configured policy templates

X

Retrieve a configured policy template by ID

X

List a provider's policy group templates

X

Gets a provider's policy group template

X

Deletes policy group template.

X

Gets the list of members from a policy group template

X

Radius servers

List the associations of a radius server

X

Manage the associations of a radius server

X

List the user groups bound to a radius server

X

List the users bound to a radius server

X

Software apps

List the associations of a software application

X

Manage the associations of a software application.

X

List the system groups bound to a software app

X

List the systems bound to a software app

X

Get all configured software applications

X

Create a software application that will be managed by JumpCloud

X

Validate installation packages

X

Retrieve a configured software application

X

Update a software application configuration

X

Delete a configured software application

X

Reclaim licenses for a software application

X

Retry installation for a software application

X

Get the status of the provided software application

X

Subscriptions

Lists all the pricing and packaging subscriptions

X

System groups

List all system groups

X

Create a new system group

X

List suggestions for a system group

X

Apply suggestions for a system group

X

View an individual system group details

X

Update a system group

X

Delete a system group

X

System group associations

List the associations of a system group

X

Manage the associations of a system group

X

List the commands bound to a system group

X

List the policies bound to a system group

X

List the policy groups bound to a system group

X

List the user groups bound to a system group

X

List the users bound to a system group

X

System group members and membership

List the members of a system group

X

Manage the members of a system group

X

List the system group's membership

X

System insights

List system insights ALF

X

List system insights ALF exceptions

X

List system insights ALF explicit authentications

X

List system insights application compatibility shims

X

List system insights apps

X

List system insights authorized keys

X

List system insights Azure instance metadata

X

List system insights Azure instance tags

X

List system insights battery

X

List system insights Bitlocker info

X

List system insights browser plugins

X

List system insights certificates

X

List system insights chassis info

X

List system insights Chrome extensions

X

List system insights connectivity

X

List system insights crashes

X

List system insights cups destinations

X

List system insights disk encryption

X

List system insights disk info

X

List system insights DNS resolvers

X

List system insights etc hosts

X

List system insights Firefox addons

X

List system insights groups

X

List system insights ie extensions

X

List system insights interface addresses

X

List system insights interface details

X

List system insights kernel info

X

List system insights launched

X

List system insights Linux packages

X

List system insights logged-in users

X

List system insights logical drives

X

List system insights managed policies

X

List system insights mounts

X

List system insights OS version

X

List system insights patches

X

List system insights programs

X

List system insights Python packages

X

List system insights Safari extensions

X

List system insights scheduled tasks

X

List system insights secure boot

X

List system insights services

X

List system insights shadow

X

List system insights shared folders

X

List system insights shared resources

X

List system insights sharing preferences

X

List system insights SIP config

X

List system insights startup items

X

List system insights system control

X

List system insights system info

X

List system insights uptime

X

List system insights USB devices

X

List system insights user groups

X

List system insights user SSH keys

X

List system insights user assist

X

List system insights users

X

List system insights on Wi-Fi networks

X

List system insights on Wi-Fi status

X

List system insights Windows security center

X

List system insights Windows security products

X

Aggregated policy stats

Get the aggregated policy stats for a system

X

Systems

List the associations of a system

X

Manage associations of a system

X

List the commands bound to a system

X

List the parent groups of a system

X

List the policies bound to a system

X

List the policy groups bound to a system

X

List the user groups bound to a system

X

List the users bound to a system

X

List the associated software application statuses of a system

X

FDE

Get system FDE key

X

User groups

List all user groups

X

Create a new user group

X

List suggestions for a user group

X

Apply suggestions for a user group

X

View individual user group details

X

Update a user group

X

Delete a user group

X

User group associations

List the active directories bound to a user group

X

List the applications bound to a user group

X

List the associations of a user group.

X

Manage the associations of a user group

X

List the directories bound to a user group

X

List the G Suite instances bound to a user group

X

List the LDAP servers bound to a user group

X

List the Office 365 instances bound to a user group

X

List the radius servers bound to a user group

X

List the system groups bound to user groups

X

List the systems bound to a user group

X

User group members and membership

List the members of a user group

X

Manage the members of a user group

X

List the user group's membership

X

Users

List the active directory instances bound to a user

X

List the applications bound to a user

X

List the associations of a user

X

Manage the associations of a user

X

List the directories bound to a user

X

List the G Suite instances bound to a user

X

List the LDAP servers bound to a user

X

List the parent groups of a user

X

List the Office 365 instances bound to a user

X

List the radius servers bound to a user

X

List the system groups bound to a user

X

List the systems bound to a user

X

List push endpoints associated with a user

X

Get a push endpoint associated with a user

X

Delete a push endpoint associated with a user

X

Update a push endpoint associated with a user

X

Workday import

List workdays

X

Create new workday

X

Get workday

X

Update workday

X

List import results

X

Authorize workday

X

Deauthorize workday

X

workday import

X

List workday workers

X

API v1 version

Resource

API endpoint

Export

Import

System user

List all system users

X

Get system user by ID

X

Create a system user

X

Update a system user

X

Delete a system user

X

Users

Manage the associations of a user

X

Update a user

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.