jumpcloud · diff

v1.0.0 to v1.0.0

20 added, 0 removed. Audit A to A.

---
name: jumpcloud
description: |
JumpCloud integration via Apideck's HRIS unified API — same methods work across every connector in HRIS, switch by changing `serviceId`. Use when the user wants to read or sync employees, departments, payrolls, and time-off records in JumpCloud. Routes through Apideck with serviceId "jumpcloud".
license: Apache-2.0
alwaysApply: false
metadata:
author: apideck
version: "1.0.0"
serviceId: jumpcloud
unifiedApis: ["hris"]
authType: apiKey
tier: "2"
verified: true
status: beta
+ difficulty: moderate
+ partnershipRequired: false
+ sandboxAvailable: true
---
# JumpCloud (via Apideck)
Access JumpCloud through Apideck's **HRIS** unified API — one of 58 HRIS connectors that share the same method surface. Code you write here ports to BambooHR, Workday, Deel and 54 other HRIS connectors by changing a single `serviceId` string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant JumpCloud plumbing.
> **Beta connector.** JumpCloud is currently in beta on Apideck. Expect partial resource coverage and occasional mapping gaps. Always verify coverage (see below) and fall back to the Proxy API for unsupported operations.
## Quick facts
- **Apideck serviceId:** `jumpcloud`
- **Unified API:** HRIS
- **Auth type:** apiKey
- **Status:** beta
- **Gotchas:** [page](https://developers.apideck.com/apis/hris/jumpcloud/gotchas)
- **Homepage:** https://jumpcloud.com/
+
+ ## At a glance
+
+ - **Implementation difficulty:** moderate — API Key Authentication - Each Consumer Generates Their Own Key in JumpCloud
+ - **Vendor partnership required:** no
+ - **Apideck-managed credentials:** not available — Not needed: there is no JumpCloud app to register.
+ - **Account type required:** JumpCloud admin account with API access enabled.
+ - **Consumer access level:** API access is off by default; only a Billing-role admin can switch it on.
+ - **Sandbox:** available ([signup](https://console.jumpcloud.com/signup)) — A free 30-day trial of the full platform serves as the test organisation.
+ - **Rate limits:** No numeric limit published.
+ - **Webhooks:** No webhooks - changes are picked up by polling.
+
+ **Important to know:**
+
+ - A JumpCloud API key can expire. New keys default to 90 days, and admin accounts created before 15 July 2024 default to no expiry. Apideck does not renew API keys, so when a key expires the consumer must generate a new one and reconnect.
+
+ > Facts synced from Apideck's connector metadata API — `GET /connector/connectors/jumpcloud` (`overview` field) is the live, authoritative version.
## When to use this skill
Activate this skill when the user explicitly wants to work with **JumpCloud** — for example, "sync employees in JumpCloud" or "list time-off requests in JumpCloud". This skill teaches the agent:
1. Which Apideck unified API covers JumpCloud (HRIS)
2. The correct `serviceId` to pass on every call (`jumpcloud`)
3. JumpCloud-specific auth and coverage caveats
For the full method surface (parameters, pagination, filtering), use your language SDK skill:
- [`apideck-node`](../../skills/apideck-node/), [`apideck-python`](../../skills/apideck-python/), [`apideck-dotnet`](../../skills/apideck-dotnet/), [`apideck-java`](../../skills/apideck-java/), [`apideck-go`](../../skills/apideck-go/), [`apideck-php`](../../skills/apideck-php/), or [`apideck-rest`](../../skills/apideck-rest/)
For the raw OpenAPI spec:
- **HRIS:** [https://specs.apideck.com/hris.yml](https://specs.apideck.com/hris.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=hris)
## Minimal example (TypeScript)
```typescript
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env.APIDECK_API_KEY,
appId: process.env.APIDECK_APP_ID,
consumerId: "your-consumer-id",
});
// List employees in JumpCloud
const { data } = await apideck.hris.employees.list({
serviceId: "jumpcloud",
});
```
## Portable across 58 HRIS connectors
The Apideck **HRIS** unified API exposes the same methods for every connector in its catalog. Switching from JumpCloud to another HRIS connector is a one-string change — no rewrite, no new SDK.
```typescript
// Today — JumpCloud
await apideck.hris.employees.list({ serviceId: "jumpcloud" });
// Tomorrow — same code, different connector
await apideck.hris.employees.list({ serviceId: "bamboohr" });
await apideck.hris.employees.list({ serviceId: "workday" });
```
This is the compounding advantage of using Apideck over integrating JumpCloud directly: code against the unified HRIS API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.
## Authentication
- **Type:** API Key
- **Managed by:** Apideck Vault — the user pastes their JumpCloud API key into the Vault modal; Apideck stores it encrypted and injects it on every request.
- **Rotation:** if the user rotates their key, they re-enter it in Vault. No code changes needed.
See [`apideck-best-practices`](../../skills/apideck-best-practices/) for Vault setup, connection lifecycle, and handling re-auth flows.
## Verifying coverage
Not every HRIS operation is supported by every connector. Always verify before assuming a method works:
```bash
curl 'https://unify.apideck.com/connector/connectors/jumpcloud' \
-H "Authorization: Bearer ${APIDECK_API_KEY}" \
-H "x-apideck-app-id: ${APIDECK_APP_ID}"
```
See [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) for patterns around `UnsupportedOperationError` and connector-specific fallbacks.
## Escape hatch: Proxy API
When an endpoint isn't covered by the HRIS unified API, use Apideck's Proxy to call JumpCloud directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on JumpCloud's own API:
```bash
curl 'https://unify.apideck.com/proxy' \
-H "Authorization: Bearer ${APIDECK_API_KEY}" \
-H "x-apideck-app-id: ${APIDECK_APP_ID}" \
-H "x-apideck-consumer-id: ${CONSUMER_ID}" \
-H "x-apideck-service-id: jumpcloud" \
-H "x-apideck-downstream-url: <target endpoint on JumpCloud>" \
-H "x-apideck-downstream-method: GET"
```
See [JumpCloud's API docs](#) for available endpoints.
## Sibling connectors
Other **HRIS** connectors that share this unified API surface (same method signatures, just change `serviceId`):
[`bamboohr`](../bamboohr/), [`workday`](../workday/), [`deel`](../deel/) *(beta)*, [`hibob`](../hibob/), [`personio`](../personio/), [`adp-ihcm`](../adp-ihcm/) *(beta)*, [`adp-workforce-now`](../adp-workforce-now/) *(beta)*, [`paychex`](../paychex/) *(beta)*, and 49 more.
## See also
- [HRIS OpenAPI spec](https://specs.apideck.com/hris.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=hris)
- [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) — programmatic coverage checks
- [`apideck-best-practices`](../../skills/apideck-best-practices/) — architecture, Vault, pagination, error handling
- [`apideck-node`](../../skills/apideck-node/) — TypeScript / Node SDK patterns