> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/knowbe4-integration-setup.md).

# KnowBe4 Integration Setup

### Getting Started

Use this guide to connect KnowBe4 to your BalkanID tenant. You will need a Product API token from your KnowBe4 console and access to the Integrations section in BalkanID.

{% hint style="info" %}
KnowBe4 issues two kinds of API token, **Product** and **Reporting**, and they are not interchangeable. This integration requires a **Product** token. A Reporting token will authenticate but cannot read security roles.
{% endhint %}

#### Requirements:

Before you begin, collect the following values from KnowBe4:

* **Region (us, eu, ca, uk or de)**
* **Product API Token**

### Configure KnowBe4 within your BalkanID tenant

1. To create the Product API Token, sign in to your KnowBe4 console.
2. Click your email address in the top-right corner and select **Account Settings**, then navigate to **Account Integrations** > **API**.
3. In the **Product API** section, click **Product API**, then click **+ Create New API Token** in the top-right corner.
4. Enter a descriptive name for the token, select the product it applies to, and choose **Read Only** access. Click to create the token.
5. Copy the token and store it somewhere safe. After creation KnowBe4 shows only the last 10 digits, so a lost token has to be replaced with a new one.
6. Note the region your KnowBe4 account is hosted in — `us`, `eu`, `ca`, `uk` or `de`. This is the region in your console address, and it must match the region you enter in BalkanID.
7. In BalkanID, head to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FcpXVWZxfqcc8dDVC1fpt%2Fknowbe4-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top-right corner"><figcaption><p>Integrations page in BalkanID</p></figcaption></figure></div>

8. Search for **KnowBe4** and select it, then click **Next**. Take care to select **KnowBe4** and not **KnowBe4 SCIM**, which is a separate integration.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FWyzCReD7llhRQ6jT0ihx%2Fknowbe4-connect-application.png?alt=media" alt="The Connect a new application step with KnowBe4 selected and a checkmark against it"><figcaption><p>Selecting KnowBe4 in Connect a new application</p></figcaption></figure></div>

9. Set the **Primary application owner** and a **Description**, if any. Set **Secondary application owner(s)**, if any.
10. Under **Select Extraction Type**, choose **Direct Configuration** and enter the **Region (us, eu, ca, uk or de)** and the **Product API Token** you created, then click **Next.**

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FgD87Ea0n7CfEhzSIaVqG%2Fknowbe4-direct-configuration.png?alt=media" alt="The Direct Configuration extraction type with fields for Region and Product API Token"><figcaption><p>Direct Configuration fields for KnowBe4</p></figcaption></figure></div>

11. Click Next to move onto Optional Configuration.
12. Fill **Optional Configuration**, if required.<br>

    <div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FJChBcQ8kXSHXuvwm27bU%2Fimage.png?alt=media&#x26;token=18b5db7b-ebd6-4c6f-972b-1ada56bec7a1" alt=""><figcaption></figcaption></figure></div>
13. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### What BalkanID extracts

| Type               | Description                                                                                             |
| ------------------ | ------------------------------------------------------------------------------------------------------- |
| **Users**          | KnowBe4 console users, including their console role, group membership and the security roles they hold. |
| **Groups**         | KnowBe4 groups, including the group type.                                                               |
| **Security Roles** | KnowBe4 security roles and the permissions each one grants.                                             |

KnowBe4 assigns a security role to groups rather than to individual users, so a user holds a security role through their group membership. BalkanID records both the group that carries the role and the resulting access for each user, so a reviewer can see which group granted it.

### Integration Scopes

| Read Only Scopes                                                           | Lifecycle Management Scopes |
| -------------------------------------------------------------------------- | --------------------------- |
| **KMSAT Product API (Read Only)** — reads users, groups and security roles | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/knowbe4-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
