You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/knowbe4-api-source.md
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,13 +49,7 @@ The **Region** is the region where your **KnowBe4** account is located. To know
49
49
50
50
#### API Token
51
51
52
-
The **API security token** is used to authenticate with KnowBe4 API. To get the **KnowBe4 API token**, follow the steps below:
53
-
1. Sign in to the **KnowBe4** application as an Admin user.
54
-
1. Navigate to the **Account Settings**.
55
-
1. Click **Account Integrations** from the left menu, and then click **API** option.
56
-
1. Under the API section, checkmark the **Enable Reporting API Access**. The **KnowBe4** Secure API token is displayed.
57
-
1. Save this API key to use while configuring the Source.
58
-
1. Click **Save Changes**.
52
+
The **API security token** is required to authenticate the KnowBe4 APIs. To get the **API token**, follow the steps mentioned in the [KnowBe4 Documentation](https://support.knowbe4.com/hc/en-us/articles/115016090908-Reporting-API-Overview#h_01HBDW9MRQ3XEWZCYK0S0T6MDC).
59
53
60
54
### Source configuration
61
55
@@ -71,10 +65,12 @@ To configure the KnowBe4 API Source:
71
65
* <img src={useBaseUrl('img/reuse/green-check-circle.png')} alt="green check circle.png" width="20"/> A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
72
66
* <img src={useBaseUrl('img/reuse/orange-exclamation-point.png')} alt="orange exclamation point.png" width="20"/> An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
73
67
7. In **Region**, choose the region where your KnowBe4 account is located. See [Region](#region) section to know your Region.
74
-
1. In **API Key**, authenticate your account by entering your secret API key. You can access your API key or generate a new one from **User Event API Management Console**. See [API Token](#api-token) section.
75
-
1. In **Data Types**, you can select the **Phishing Tests** data type to fetch a list of all recipients for each phishing security test on your KnowBe4 account.
76
-
1. In **Phishing Poll Interval**, enter the phishing poll interval frequency, which must be between 1 hour and 24 hours.
77
-
1. When you are finished configuring the Source, click **Submit**.
68
+
8. Select the **Collect Phishing Tests** checkbox to fetch a list of all recipients for each phishing security test on your KnowBe4 account. By default, **Collect Phishing Tests** checkbox will be selected.
69
+
9. In **API Key (Phishing Tests)**, authenticate your account by entering your API key. You can access your API key or generate a new one from **Reporting API Management Console**. See [API Token](#api-token) section.
70
+
10. The **Phishing Poll Interval** is set for 1 hour by default. You can adjust it based on your needs.
71
+
11. Select the **Collect External Events** checkbox to fetch a list of all external events. By default, **Collect External Events** checkbox will not be selected.
72
+
12. In **API Key (External Events)**, authenticate your account by entering your API key collected from KnowBe4 account. You can access your API key or generate a new one from **User Event API Management Console**. See [API Token](#api-token) section.
73
+
13. When you are finished configuring the Source, click **Submit**.
78
74
79
75
## Metadata Field
80
76
@@ -103,9 +99,11 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
103
99
| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"`
104
100
| fields | JSON Object | No |`null`| JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}`|
105
101
| region | String | Yes |`null`| Region of the KnowBe4 application. ||
106
-
|apiKey|String|Yes|`null`|Secret api key to authenticate your account. ||
107
-
|dataTypes|Array| Yes |`null`|Data sources to fetch from KnowBe4. ||
102
+
|collectPhishingTests|Boolean|No|`True`|Specify if we need to collect the phishing tests. ||
103
+
|apiKeyPhishing|String| Yes |`null`|Secret api key to authenticate phishing tests endpoint. ||
108
104
| phishingPollInterval | Integer | Yes | 1 hour| The Polling interval for phishing data requests. The minimum interval is 1 hour, and the maximum is 24 hours. ||
105
+
| collectExternalEvents | Boolean | No |`False`| Specify if we need to collect the external events. ||
106
+
| apiKeyEvent | String | Yes |`null`| Secret api key to authenticate events endpoint. ||
0 commit comments