Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 4.24 KB

index.md

File metadata and controls

94 lines (70 loc) · 4.24 KB
Raw
organization category icon_url brand_color display_name short_name description og_description og_image
Turbot
saas
/images/plugins/turbot/jumpcloud.svg
#14A19C
JumpCloud
jumpcloud
Steampipe plugin to query servers, applications, user groups, and more from your JumpCloud organization.
Query JumpCloud with SQL! Open source CLI. No DB required.
/images/plugins/turbot/jumpcloud-social-graphic.png

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 CLI 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

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

Get involved