module · Identity & SSO

Jumpcloud

JumpCloud — directory + device-bound identity

Namespace: weave jumpcloud Env: JUMPCLOUD_API_KEY

Commands

State kinds

Identity & SSO

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

Directory API

Variable	Description	Status
JUMPCLOUD_API_KEY	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave jumpcloud --help
weave doctor   # reports JUMPCLOUD_API_KEY status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
system	·	✓	·	·	·	·	·
user	✓	✓	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find user

read

Find a user by email or JumpCloud user id.

weave jumpcloud find user <identifier>

list (2)

list systems

read

List managed systems (workstations/servers).

weave jumpcloud list systems <arg>

list users

read

List directory users.

weave jumpcloud list users <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/jumpcloud/.

users

snapshot diff apply

jumpcloud users — field-level apply via REST.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: jumpcloud
kind: users
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Users audit

Snapshot, diff, and apply users.

weave jumpcloud snapshot users
$EDITOR .weave-state/jumpcloud/users.yaml
weave jumpcloud diff users
weave jumpcloud apply users

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
jumpcloud_users	weave jumpcloud snapshot/diff/apply users Round-trip via weave state.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including JUMPCLOUD_API_KEY) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave jumpcloud diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/jumpcloud. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.