- Region (
regionaccount field).us(console.jumpcloud.com, the default),eu(console.eu.jumpcloud.com) orin(console.in.jumpcloud.com). A key only works in its organization’s region; a pasted console host is read as its region, and any other value is rejected. - Organization (
org_idaccount field). Multi-tenant (MSP) administrators set the 24-character organization ID each call acts on; it is sent as thex-org-idheader. Leave it empty for a single-organization key. - Calls that email or lock out people.
users.createemails the new user a welcome or activation link unlessstateisSTAGED, andusers.updatedoes the same when it activates a staged user.users.setPassword,expirePassword,resetMfaandenforceMfachange how a person signs in. These are all marked destructive. - Commands.
commands.createneedsuser(the system user to run as) for linux and mac commands;000000000000000000000000runs as root.commands.runruns the command on every bound system right away. - No local data. Every call returns live data from JumpCloud.
- 48 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the JumpCloud API key before the first call: More: API Key
pnpm corsair setup --plugin=jumpcloud --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
applications.get
commands.create
What’s next
API reference
Every
jumpcloud.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.