module · Endpoints & MDM

Workspaceone

Workspace ONE UEM — cross-platform device inventory via the REST API

Namespace: weave workspaceone Env: WS1_HOST

Commands

State kinds

Endpoints & MDM

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.

Workspace ONE UEM API

Variable	Description	Status
WS1_HOST	Required for authentication.	required
WS1_USER	Required for authentication.	required
WS1_PASSWORD	Required for authentication.	required
WS1_TENANT_CODE	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave workspaceone --help
weave doctor   # reports WS1_HOST 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
device	✓	✓	·	·	✓	✓	·

Commands

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

find (1)

find device

read

Find a device by serial number or numeric device id.

weave workspaceone find device <identifier>

list (1)

list devices

read

List enrolled devices.

weave workspaceone list devices <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/workspaceone/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

devices

snapshot diff apply

Workspace ONE UEM device inventory — snapshot + diff only (read-only API).

Scope: —
Round-trip: Snapshot + diff (apply not wired).

State file skeleton

module: workspaceone
kind: devices
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.

Devices audit

Snapshot and diff devices (read-only; apply is intentionally not implemented).

weave workspaceone snapshot devices
$EDITOR .weave-state/workspaceone/devices.yaml
weave workspaceone diff devices

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
workspaceone_devices	weave workspaceone snapshot/diff devices Snapshot/diff only; the vendor API does not support generic writes for this kind.

Troubleshooting & source

Missing credentials

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

Unexpected behaviour from a state apply

Re-run weave workspaceone 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/workspaceone. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.