JumpCloud + Steampipe

JumpCloud provides an open directory platform that helps to unify the technology stack across identity, access, and device management, cost-effectively that doesn't sacrifice security or functionality.

Steampipe is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

List JumpCloud user details:

select
  username,
  created,
  email,
  mfa
from
  jumpcloud_user;

+------------+---------------------------+------------------------+-----------------------------------------------+
| username   | created                   | email                  | mfa                                           |
+------------+---------------------------+------------------------+-----------------------------------------------+
| johnweb    | 2022-12-16T15:42:32+05:30 | johnweb@example.com    | <null>                                        |
| cookiesowl | 2022-12-19T15:10:02+05:30 | cookiesowl@example.com | {"exclusionUntil":"2022-12-27T02:30:24.498Z"} |
+------------+---------------------------+------------------------+-----------------------------------------------+

Documentation

Table definitions & examples →

Get started

Install

Download and install the latest JumpCloud plugin:

steampipe plugin install jumpcloud

Credentials

Item	Description
Credentials	JumpCloud requires an API token for all requests.
Permissions	API tokens have the same permissions as the user who creates them, and if the user permissions change, the API token permissions also change.
Radius	Each connection represents a single JumpCloud Installation.
Resolution	1. Credentials explicitly set in a steampipe config file (`~/.steampipe/config/jumpcloud.spc`) 2. Credentials specified in environment variables, e.g., `JUMPCLOUD_API_KEY`, `JUMPCLOUD_ORG_ID`.

Configuration

Installing the latest jumpcloud plugin will create a config file (~/.steampipe/config/jumpcloud.spc) with a single connection named jumpcloud:

connection "jumpcloud" {
  plugin = "jumpcloud"

  # The admin API key to access JumpCloud resources.
  # This can also be set via the `JUMPCLOUD_API_KEY` environment variable.
  # api_key = "1b234ac9de5f5gh67i89j10k9l366mnop6q965r6"

  # The JumpCloud organization ID to which you would like to make the request.
  # It is required for all multi-tenant admins when making API requests to JumpCloud.
  # This can also be set via the `JUMPCLOUD_ORG_ID` environment variable.
  # org_id = "123a45b6c78d8e9f6gh0769i"
}

Credentials from Environment Variables

The JumpCloud plugin will use the standard JumpCloud environment variables to obtain credentials only if other arguments (api_key and org_id) are not specified in the connection:

export JUMPCLOUD_API_KEY=1b234ac9de5f5gh67i89j10k9l366mnop6q965r6
export JUMPCLOUD_ORG_ID=123a45b6c78d8e9f6gh0769i

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_postgres_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/postgres.sh)" -- jumpcloud

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_jumpcloud;
CREATE SERVER steampipe_jumpcloud FOREIGN DATA WRAPPER steampipe_postgres_jumpcloud OPTIONS (config '<your_config>');
CREATE SCHEMA jumpcloud;
IMPORT FOREIGN SCHEMA jumpcloud FROM SERVER steampipe_jumpcloud INTO jumpcloud;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_sqlite_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/sqlite.sh)" -- jumpcloud

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_jumpcloud function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_jumpcloud.so
sqlite> select steampipe_configure_jumpcloud('<your_config>');

Export

This plugin is available as a standalone Export CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- jumpcloud

You can pass the configuration to the command with the --config argument:

steampipe_export_jumpcloud --config '<your_config>' <table_name>