Skip to main content
KnowBe4
Betav0.2.0
259 actions · 3 auth methods
SecurityIAMLMSAnalytics

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

Product API Token · Connector Profile

No app registration required. Uses a KSAT Product API token created by a KnowBe4 admin for one KnowBe4 account. Write ac…

Reporting API Token · Connector Profile

No app registration required. Uses a read-only Reporting API token for one KnowBe4 account. It runs only the Reporting a…

User Event API Key · Connector Profile

No app registration required. Uses a User Event API key for one KnowBe4 account to add, read and delete user timeline ev…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Product API Token · Link Account

Reporting API Token · Link Account

User Event API Key · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
259 actions
Action
Description
List Allowed Domains
List all allowed domains for an account.
Create Allowed Domain
Create a new allowed domain.
Delete Allowed Domain
Delete an allowed domain.
List API Tokens
Paginated API tokens.
Get API Token
An API token.
Create API Token
Create an API token.
Delete API Token
Delete an API Token.
List Assessment Domains
Get assessment domains.
List Assessment Industry Benchmarks
List of assessment benchmarking data for industries.
Get Assessment Results
Get results for an assessment.
List Audit Log Object Search
Get search.
List Audit Logs
Get paginated audit logs for the account.
Get Audit Log Extended
Get an audit log by ID.
List Industries
List all industries.
List Industry Benchmarks
List of benchmarking data for industries.
List Callback Phishing Greeting Template Languages
List all callback phishing greeting template languages.
List Callback Phishing Greeting Templates
List all callback phishing greeting templates.
Get Callback Phishing Greeting Template
Get a callback phishing greeting template by ID.
Create Callback Phishing Greeting Template
Create a user callback phishing greeting template.
Copy Callback Phishing Greeting Templates
Copy a set of callback phishing greeting templates into the current account.
Delete Callback Phishing Greeting Templates
Delete a callback phishing greeting template.
Add Callback Phishing Greeting Template Topics
Add topics to callback phishing greeting templates.
Remove Callback Phishing Greeting Template Topics
Remove topics from callback phishing greeting templates.
List Callback Phishing Response Template Languages
List all callback phishing response template languages.
List Callback Phishing Response Templates
List all callback phishing response templates.
Get Callback Phishing Response Template
Get a callback phishing response template by ID.
Create Callback Phishing Response Template
Create a user callback phishing response template.
Copy Callback Phishing Response Templates
Copy a set of callback phishing response templates into the current account.
Delete Callback Phishing Response Templates
Delete a callback phishing response template.
Add Callback Phishing Response Template Topics
Add topics to callback phishing response templates.
Remove Callback Phishing Response Template Topics
Remove topics from callback phishing response templates.
List Callback Phishing Templates
List all callback phishing templates.
Get Callback Phishing Template
Get a callback phishing email template by ID.
Create Callback Phishing Template
Create a user callback phishing template.
Copy Callback Phishing Templates
Copy a set of callback phishing templates into the current account.
Delete Callback Phishing Audio File
Delete the audio file for a callback phishing audio template message.
Update Callback Phishing Template
Update a callback phishing template.
Get DKIM Config
Get the specified email type DKIM configuration for the current account.
Create DKIM Config
Create a DKIM configuration.
Delete DKIM Config
Delete a DKIM configuration.
List DMI Configs
List all DMI configurations for the current account.
Get DMI Config
Get a DMI configuration for the current account.
Create DMI Config
Create a DMI configuration.
Delete DMI Config
Delete a DMI configuration.
List Enrollments
List all enrollments for an account.
Get Enrollment
Get an enrollment by ID.
Update Enrollments
Update an enrollment.
Get Environment Questionnaire
Get an environment questionnaire by its parent.
Clear Environment Questionnaire
Clear the environment questionnaire.
Get Environment Survey Questionnaire
Get an environment survey questionnaire by its parent.
Archive Environment Survey Assessment
Archive the environment survey assessment.
Clear Environment Survey Questionnaire
Clear the environment questionnaire.
List Groups
List KnowBe4 groups with their type, status and security roles.
Get Group
Get a KnowBe4 group by ID.
Create Group
Create a group.
Archive Group Users
Archive users in a group.
Archive Groups
Archive groups.
Clone Group
Clone a group.
Delete Groups
Delete groups.
Remove Group Users
Remove users from a group.
Update Group
Update a group.
List Group Risk Score Histories
Get Risk Score history for a group.
Save Group Criteria
Save Smart Group criteria.
List Hosted Images
Get hosted images for an account.
Get Hosted Image
Get a hosted_image for an account.
Create Hosted Image
Create a hosted image.
Delete Hosted Image
Delete a hosted image.
List Unified Groups
List unified groups in KnowBe4.
Get Unified Group
Get a unified KnowBe4 group by ID.
List Unified Organizations
List unified organizations in KnowBe4.
Get Unified Organization
Get the unified KnowBe4 organization by ID.
List Unified Roles
List unified roles in KnowBe4.
Get Unified Role
Get a unified KnowBe4 role by ID.
List Unified Users
List unified users in KnowBe4.
Get Unified User
Get a unified KnowBe4 user by ID.
List IP Ranges
List all IP ranges.
Get IP Range
Get an IP range.
Create IP Range
Create an IP range for the account.
Delete IP Range
Delete a IP range for the account.
List Landing Domains
List all landing domains.
Get Landing Domain
Get a landing domain.
List Landing Pages
List all landing pages.
Get Landing Page
Get a landing page by ID or UUID.
Create Landing Page
Create a landing page in the current context.
Import Landing Pages
Import multiple templates based on a JSON format.
List Landing Page Categories
List all landing page categories.
Create Landing Page Category
Create a landing page category in the current account.
Delete Landing Page Category
Delete a landing page category.
List LDAP Sync Report Items
List all LDAP sync reports items for a sync report.
List LDAP Sync Reports
List all LDAP sync reports for an account.
Get LDAP Sync Report
Fetch a LDAP sync report.
Create Messages Template
Create a messages template in the current account.
Clone Messages Template
Clone a messages template within the current account.
List Notification Templates
List notification templates.
Get Notification Template
Get a notification template by ID.
Create Notification Template
Create a notification template in the current account.
Clone Notification Template
Clone a notification template within the current account, or within the partner for a partner admin.
Hide Notification Template
Hide or shows a notification template from an account.
Import Notification Templates
Import multiple notification templates based on a JSON format.
List Notification Template Categories
List all notification template categories.
Create Notification Template Category
Create a notification template category in the current account.
Delete Notification Template Category
Delete a notification template category.
Delete Notification Template Family
Archive every language version of a notification template’s translation family.
Hide Notification Template Category
Hide or shows a notification template category from an account.
Update Notification Template Category
Update a notification template category in the current account.
Get Account
Get the KnowBe4 account the token belongs to.
Create Account PAB Instance
Create a new PAB instance for the account.
Delete Account PAB Icon
Delete the PAB icon for a Phish Alert setting for the account.
List Phish Domains
List all phish domains.
Get Phish Domain
Get a phish domain.
Create Custom Phish Domain
Create a phish domain for the account.
Delete Phish Domain
Delete a phish domain for the account.
List Phishing Campaigns
List all phishing campaigns.
List Uas Campaigns
List all UAS campaigns (standard, callback, and vishing).
Get Phishing Campaign
Get a campaign by ID.
Create Phishing Campaign
Create a phishing campaign in the current account.
Deactivate Phishing Campaign
Deactivate or activate a phishing campaign.
Delete Phishing Campaign
Delete a phishing campaign.
Edit Phishing Campaign
Edit a phishing campaign in the current account.
Hide Phishing Campaign From Reports
Hide or show a phishing campaign from reports.
List Phishing Campaign Recipients
List all the campaign recipients in a campaign run.
List Phishing Campaign Runs
List all campaign runs in account.
Get Phishing Campaign Recipient
Get a campaign recipient by ID.
Get Phishing Campaign Run
Get a campaign run by ID.
Convert Phishing Campaign Recipient
Converts an ignored phishing failure to an actual phishing failure.
Delete Phishing Campaign Run
Delete a phishing campaign run.
Remove Phishing Campaign Recipient Reply
Delete the content associated with a reply event.
Update Phishing Campaign Recipient
Update a phishing campaign recipient.
List Phishing Campaign Recipient Failures
Get phishing failures for a campaign recipient or campaign run.
List Phishing Templates
List email templates.
Get Phishing Template
Get a phishing campaign by ID.
Create Phishing Template
Create a phishing template in the current account.
Clone Phishing Template
Clone a user-owned phishing template within the current account, or a managed one within the partner for a partner admin…
Copy Phishing Templates
Copy a set of phishing templates into the current account.
Hide Centralized Phishing Template
Hide or unhides a centralized phishing template from an account.
Hide Phishing Template
Hide or unhides a phishing template from an account.
Import Phishing Templates
Import multiple phishing templates based on a JSON format.
List Phishing Template Categories
List all phishing template categories.
Get Phishing Template Category
Get a phishing template category by ID.
Get Template Category
Get a phishing template category by ID.
Create Phishing Template Category
Create a phishing template category in the current account.
Add Phishing Template Topics
Add topics to phishing templates.
Delete Phishing Template Category
Delete a phishing template category.
Hide Phishing Template Category
Hide a phishing template category from an account.
List Physical QR Campaign Results
List all physical QR code campaign locations for a campaign.
List Physical QR Campaigns
List all physical QR code campaigns.
Get Physical QR Campaign
Get a physical QR code campaign by ID.
Create Physical QR Campaign
Create a physical QR code campaign.
Delete Physical QR Campaign
Delete a physical QR code campaign.
End Physical QR Campaign
Finishes a physical QR code campaign.
Get Physical QR Campaign Location
Get a physical QR code campaign by ID.
Create Physical QR Campaign Location
Create a physical QR code campaign location.
Delete Physical QR Campaign Location
Delete a physical QR code campaign location.
List Physical QR Templates
List all physical QR code templates.
Get Physical QR Template
Get a physical QR code template by ID.
Create Physical QR Template
Create a user physical QR code template.
Copy Physical QR Templates
Copy a set of Physical QR templates into the current account.
Add Physical QR Template Topics
Add topics to physical QR templates.
Remove Physical QR Template Topics
Remove topics from physical QR templates.
List Policies
List all your policies.
Get Policy
Get a policy.
Create Policy
Create a policy.
Delete Policy
Soft delete a policy.
Update Policy
Update a policy.
List Report Permission Groups
Get account groups with access to a given report.
List Report Categories
List all report categories for an account.
Create Report Category
Create a saved report category.
Delete Report Category
Delete a saved report category.
Get Reporting Account Risk Score History
Get your Knowbe4 account risk score history with the Reporting API.
Get Reporting Training Enrollment
Get a specific Training Enrollment from your KnowBe4 account with the Reporting API.
Get Reporting Training Enrollments
List all Training Enrollments in your KnowBe4 account with the Reporting API.
Get Reporting Group
Get a specific group in your KnowBe4 account, based on the provided group identifier (group_id) with the Reporting API.
Get Reporting Groups
List all groups in your KnowBe4 account with the Reporting API.
Get Reporting Group Members
List all users who are members of a specific group with the Reporting API.
Get Reporting Group Risk Score History
Get risk score history for a specific group in your KnowBe4 account, based on the provided group identifier (group_id) w…
Get Reporting Phishing Campaign
Get data from a specific phishing campaign, based on the provided campaign identifier (campaign_id) with the Reporting A…
Get Reporting Phishing Campaigns
Get data from all the phishing campaigns in your account with the Reporting API.
Get Reporting Campaign Security Tests
List all phishing security tests from a specific phishing campaign, based on the provided phishing campaign identifier (…
Get Reporting Policies
List all uploaded policies in your KnowBe4 account with the Reporting API.
Get Reporting Policy
Get a specific uploaded policy from your KnowBe4 account with the Reporting API.
Get Reporting Phishing Security Test
Get data from a specific phishing security test, based on the provided phishing security test identifier (pst_id) with t…
Get Reporting Phishing Security Tests
List all phishing security tests in your account with the Reporting API.
Get Reporting Security Test Recipient
Get details about a specific user’s phishing security test results, based on the provided phishing security test identif…
Get Reporting Security Test Recipients
List all the recipients (users) that were part of a specific phishing security test, based on the provided phishing secu…
Get Reporting Store Purchase
Get a specific Store Purchase from your KnowBe4 account with the Reporting API.
Get Reporting Store Purchases
List all Store Purchases in your KnowBe4 account with the Reporting API.
Get Reporting Training Campaign
Get a specific Training Campaign from your KnowBe4 account with the Reporting API.
Get Reporting Training Campaigns
List all training campaigns in your account with the Reporting API.
Get Reporting User
Get a specific user based on the provided user identifier (user_id) with the Reporting API.
Get Reporting Users
List all users in your KnowBe4 account with the Reporting API.
Get Reporting User Risk Score History
Get risk score history for a specific user based on the provided user identifier (user_id) with the Reporting API.
List Security Roles
List KnowBe4 security roles with their permission levels.
Get Security Role
Get a KnowBe4 security role by ID.
Create Security Role
Create Security Role.
Delete Security Role
Delete a Security Role.
List Second Chance Devices
List all Second Chance devices for an account.
List Second Chance Domains
List all Second Chance No Prompt Domains for an account.
List Second Chance Post Actions
List all Second Chance post actions for an account.
List Second Chance Urls
List all Second Chance URLs for an account.
Get Second Chance Device
Get a Second Chance device for an account.
Get Second Chance Overview
The stats and info for the Second Change Overview tab.
Get Second Chance Settings
The data for the Second Chance Settings tab.
Get Second Chance Url
Get a Second Chance URL for an account.
Get Second Chance User
Get a Second Chance user for an account.
Bulk Delete Second Chance Domains
Delete domains from Second Chance.
List Store Purchases
List all your store purchases.
Get Store Purchase
Get a store purchase.
Remove Store Purchase
Remove store purchase from the current account.
Update Store Purchase
Update store purchase from the current account.
Create Template Topic
Create a phishing template topic in the current account.
Delete Template Topic
Delete a phishing template topic.
Exclude Template Topic
Exclude a phishing template topic in the current account.
List Training Campaigns
List all training campaign.
Get Training Campaign
Get a training campaign by ID.
Create Training Campaign
Create a training campaign in the current account.
Add Training Campaign User
Add a user to a training campaign.
Close Training Campaign
Mark a training campaign as closed.
Delete Training Campaigns
Delete training campaigns.
Edit Training Campaign
Edit a training campaign in the current account.
Extend Training Campaign Due Date
Extend users enrollment due dates.
Remove Training Campaign User
Remove a user from a training campaign.
List USB Campaigns
List all USB drive test campaigns.
Get USB Campaign
Get a USB drive test by ID.
Create USB Campaign
Create a USB drive test.
Destroy USB Campaign
Destroy a USB drive test.
End USB Campaign
End a USB drive test.
Create User Event API Key
Create a User Event API key.
Delete User Event API Key
Delete a User Event API key.
List Events
List all events in your KnowBe4 account with the User Event API.
Batch Delete Events
Delete multiple events from your KnowBe4 account with the User Event API.
Delete Event
Delete a single event based on the ID supplied with the User Event API.
Post New Event
Add one event to a user’s timeline with the User Event API.
Post New Events
Add several user events in one call with the User Event API.
Show Event By ID
Get all of the available data about a specific event based on the ID supplied with the User Event API.
Get Event Types
List all event types in your KnowBe4 account with the User Event API.
Delete Event Type
Delete a single event type based on the ID supplied with the User Event API.
Post New Event Type
Create a new event type with the User Event API.
Show Event Type By ID
Get all of the available data about a specific event type based on the ID supplied with the User Event API.
Show Specific Status
Get the status of a specific event based on the ID supplied with the User Event API.
Show Statuses
Get all of the event statuses in your KnowBe4 account with the User Event API.
Force SCIM Sync
Force a new SCIM sync.
List Users
List KnowBe4 users with their role, security roles and sign-in details.
Get User
Get a KnowBe4 user by ID.
Get User By Email
Get a single user by email.
Create User
Create a user.
Add Users To Groups
Add a collections of users to a collection of classic groups.
Archive Users
Archive a collection of users.
Delete Users
Permanently delete a collection of non-admin users.
Disable User MFA
Deactivate MFA on User.
Edit User
Edit a user.
Enable User MFA
Enables MFA on the user (if valid).
Grant Users Admin
Grant admin priviledges to a collection of users.
Quick Import Users
Import multiple users by email address.
Remove Users From Group
Remove a collections of users from a specific group.
Unarchive Users
Unarchive a collection of users.
List User Risk Score Histories
Get the Risk Score history for a user.
Create Email Alias
Create an email alias for the user.
Delete Email Alias
Delete an email alias.
Get User Timeline
The user timeline.