Skip to main content
New to Corsair? See API access, authentication, and error handling.

Applications

get

applications.get Get a JumpCloud application by ID Risk: read
Input Output

list

applications.list List JumpCloud applications with pagination Risk: read
Input Output

Commands

create

commands.create Create a JumpCloud command Risk: write
Input
Output

get

commands.get Get a JumpCloud command by ID Risk: read
Input Output

list

commands.list List JumpCloud commands with pagination Risk: read
Input Output

run

commands.run Run a command against target systems Risk: destructive
Input
Output

Organizations

get

organizations.get Get a JumpCloud organization by ID Risk: read
Input Output

list

organizations.list List JumpCloud organizations Risk: read
Input Output

Policies

create

policies.create Create a JumpCloud policy Risk: write
Input
Output

delete

policies.delete Delete a JumpCloud policy Risk: destructive
Input Output: void

get

policies.get Get a JumpCloud policy by ID Risk: read
Input Output

list

policies.list List JumpCloud policies with pagination Risk: read
Input Output: object[]

listStatuses

policies.listStatuses List policy statuses for a policy Risk: read
Input Output: object[]

update

policies.update Update a JumpCloud policy Risk: write
Input
Output

systems

search.systems Search JumpCloud systems (POST body search) Risk: read
Input
Output

systemUsers

search.systemUsers Search JumpCloud system users (POST body search) Risk: read
Input
Output

System Groups

create

systemGroups.create Create a JumpCloud system group Risk: write
Input
Output

delete

systemGroups.delete Delete a JumpCloud system group Risk: destructive
Input Output

get

systemGroups.get Get a JumpCloud system group by ID Risk: read
Input Output

list

systemGroups.list List JumpCloud system groups with pagination Risk: read
Input Output: object[]

manageMembers

systemGroups.manageMembers Manage (add or remove) members of a system group Risk: write
Input
Output: void

update

systemGroups.update Update a JumpCloud system group Risk: write
Input
Output

Systems

delete

systems.delete Delete a JumpCloud system Risk: destructive
Input Output

get

systems.get Get a JumpCloud system by ID Risk: read
Input Output

list

systems.list List JumpCloud systems with pagination Risk: read
Input Output

listAssociations

systems.listAssociations List associations for a system Risk: read
Input Output: object[]

listPolicyStatuses

systems.listPolicyStatuses List policy statuses for a system Risk: read
Input Output: object[]

listUsers

systems.listUsers List users bound to a system Risk: read
Input Output: object[]

User Groups

create

userGroups.create Create a JumpCloud user group Risk: write
Input
Output

delete

userGroups.delete Delete a JumpCloud user group Risk: destructive
Input Output

get

userGroups.get Get a JumpCloud user group by ID Risk: read
Input Output

list

userGroups.list List JumpCloud user groups with pagination Risk: read
Input Output: object[]

listMembers

userGroups.listMembers List members of a user group Risk: read
Input Output: object[]

listMembership

userGroups.listMembership List a user group’s membership graph Risk: read
Input Output: object[]

manageMembers

userGroups.manageMembers Manage (add or remove) members of a user group Risk: write
Input
Output: void

update

userGroups.update Update a JumpCloud user group Risk: write
Input
Output

Users

create

users.create Create a JumpCloud system user; unless state is STAGED, JumpCloud emails the user a welcome or activation link Risk: destructive
Input
Output

delete

users.delete Delete a JumpCloud system user Risk: destructive
Input Output

enforceMfa

users.enforceMfa Update a system user’s MFA requirement; an unenrolled user is locked out of MFA-protected resources once any exclusion ends Risk: destructive
Input
Output: void

expirePassword

users.expirePassword Expire a system user’s password so they must reset it at next login Risk: destructive
Input Output: string \| object

get

users.get Get a JumpCloud system user by ID Risk: read
Input Output

list

users.list List JumpCloud system users with limit/skip pagination Risk: read
Input Output

listSshKeys

users.listSshKeys List SSH keys of a system user Risk: read
Input Output: object[]

resetMfa

users.resetMfa Reset a system user’s MFA (TOTP key) and start a new enrollment period Risk: destructive
Input
Output: string

setPassword

users.setPassword Force-set a system user’s password, replacing the current one Risk: destructive
Input
Output: void

syncMfa

users.syncMfa Sync system user MFA Risk: write
Input Output: string

unlock

users.unlock Unlock a locked system user Risk: write
Input Output: string

update

users.update Update a JumpCloud system user; setting state to ACTIVATED on a staged user emails them an activation link Risk: destructive
Input
Output