Skip to content

Commit 53b2b18

Browse files
CONN-5465: Updated KnowBe4 C2C document (#6119)
* CONN-5465: Updated KnowBe4 C2C document * Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/knowbe4-api-source.md * Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/knowbe4-api-source.md --------- Co-authored-by: Jagadisha V <[email protected]>
1 parent 1b46895 commit 53b2b18

File tree

3 files changed

+26
-28
lines changed

3 files changed

+26
-28
lines changed

docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/knowbe4-api-source.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,7 @@ The **Region** is the region where your **KnowBe4** account is located. To know
4949

5050
#### API Token
5151

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).
5953

6054
### Source configuration
6155

@@ -71,10 +65,12 @@ To configure the KnowBe4 API Source:
7165
* <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.
7266
* <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.
7367
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**.
7874

7975
## Metadata Field
8076

@@ -103,9 +99,11 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
10399
| 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"`
104100
| 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"}` |
105101
| 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. | |
108104
| 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. | |
109107

110108
### JSON example
111109

static/files/c2c/knowbe4-api/example.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
"api.version": "v1",
33
"source": {
44
"config": {
5-
"name": "KnowBe4",
6-
"description": "Test Source",
7-
"category": "source_category",
8-
"region": "US",
9-
"apiKey": "************",
10-
"dataTypes": [
11-
"phishingTests"
12-
],
13-
"phishingPollInterval": 1
14-
},
5+
"name": "KnowBe4",
6+
"description": "Test Source",
7+
"category": "source_category",
8+
"region": "US",
9+
"collectPhishingTests": true,
10+
"collectExternalEvents": true,
11+
"apiKeyPhishing": "************",
12+
"phishingPollInterval": 24,
13+
"apiKeyEvent": "************"
14+
},
1515
"schemaRef": {
1616
"type": "KnowBe4 KMSAT"
1717
},

static/files/c2c/knowbe4-api/example.tf

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ resource "sumologic_cloud_to_cloud_source" "knowbe4-api-source" {
88
"description": "Test Source",
99
"category": "source_category",
1010
"region": "US",
11-
"apiKey": "************",
12-
"dataTypes": [
13-
"phishingTests"
14-
],
15-
"phishingPollInterval": 1
11+
"collectPhishingTests": true,
12+
"collectExternalEvents": true,
13+
"apiKeyPhishing": "************",
14+
"phishingPollInterval": 24,
15+
"apiKeyEvent": "************"
1616
})
1717
}
1818
resource "sumologic_collector" "collector" {

0 commit comments

Comments
 (0)