KnowBe4 Plugin for Steampipe

Use SQL to query users, phishing campaigns, training enrollments and more from KnowBe4.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install ghcr.io/vthiery/knowbe4

Configure your credentials in ~/.steampipe/config/knowbe4.spc:

connection "knowbe4" {
  plugin = "ghcr.io/vthiery/knowbe4"

  # KnowBe4 API token (required).
  # You can generate one at https://training.knowbe4.com/account/info under "API".
  # api_token = "your-api-token"

  # KnowBe4 API region (optional, defaults to "us").
  # Valid values: "us", "eu", "ca", "uk", "de"
  # api_region = "us"
}

Run a query:

select
  id,
  email,
  phish_prone_percentage,
  current_risk_score
from
  knowbe4_user
where
  status = 'active'
order by
  current_risk_score desc
limit 10;

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/vthiery/steampipe-plugin-knowbe4.git
cd steampipe-plugin-knowbe4

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make install

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/knowbe4.spc

Try it!

steampipe query
> .inspect knowbe4

Further reading:

• Writing plugins
• KnowBe4 Reporting API