# KnowBe4

> Report on security awareness users, groups, phishing tests and training results.

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/knowbe4

## Actions

### Get account

Get Account and Subscription Data.

**Inputs**: None.

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "admins": [],
    "current_risk_score": 1,
    "domains": [],
    "name": "example",
    "number_of_seats": 1,
    "subscription_end_date": "example",
    "subscription_level": "example",
    "type": "example"
  }
}
```

### Get account risk history

Get Account Risk Score History.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### Get group

Get a Specific Group.

**Inputs**

- Group id (`group_id`, text, required): Group ID

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "current_risk_score": 1,
    "group_type": "example",
    "id": 1,
    "member_count": 1,
    "name": "example",
    "provisioning_guid": "example",
    "status": "example"
  }
}
```

### Get group risk history

Get a Specific Group's Risk Score History.

**Inputs**

- Group (`group_id`, text, required): The record ID from the corresponding list action.
- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### Get phishing campaign

Get a Specific Phishing Campaign.

**Inputs**

- Campaign id (`campaign_id`, text, required): Campaign ID
- Campaign type callback (`campaign_type_callback`, text): Returns information related to callback phishing campaigns.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### Get policy

Get a Specific Policy.

**Inputs**

- Policy id (`policy_id`, text, required): Policy id.

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "content_type": "example",
    "default_language": "example",
    "minimum_time": 1,
    "name": "example",
    "policy_id": 1,
    "status": 1
  }
}
```

### Get security test

Get a Specific PST.

**Inputs**

- Pst id (`pst_id`, text, required): PST ID
- Campaign type callback (`campaign_type_callback`, text): Returns information related to callback phishing campaigns.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### Get store purchase

Get a Specific Store Purchase.

**Inputs**

- Store purchase id (`store_purchase_id`, text, required): Store Purchase ID

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "content_type": "example",
    "description": "example",
    "duration": 1,
    "name": "example",
    "policy_url": "example",
    "publish_date": "example",
    "publisher": "example",
    "purchase_date": "example",
    "retired": false,
    "retirement_date": "example",
    "store_purchase_id": 1,
    "type": "example"
  }
}
```

### Get test recipient

Get a Specific Recipient's Results.

**Inputs**

- Pst id (`pst_id`, text, required): PST ID
- Recipient id (`recipient_id`, text, required): Recipient ID
- Campaign type callback (`campaign_type_callback`, text): Returns information related to callback phishing campaigns.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### Get training campaign

Get a Specific Training Campaign.

**Inputs**

- Campaign id (`campaign_id`, text, required): Campaign id.

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "allow_multiple_enrollments": false,
    "auto_enroll": false,
    "campaign_id": 1,
    "completion_percentage": 1,
    "content": [],
    "duration_type": "example",
    "end_date": "example",
    "groups": [],
    "name": "example",
    "relative_duration": "example",
    "start_date": "example",
    "status": "example"
  }
}
```

### Get training enrollment

Get a Specific Training Enrollment.

**Inputs**

- Enrollment id (`enrollment_id`, text, required): Enrollment ID
- Include campaign id true (`include_campaign_id_true`, true/false): Returns the campaign ID for each training enrollment.

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "campaign_name": "example",
    "completion_date": "example",
    "content_type": "example",
    "enrollment_date": "example",
    "enrollment_id": 1,
    "module_name": "example",
    "policy_acknowledged": false,
    "start_date": "example",
    "status": "example",
    "time_spent": 1,
    "user": {
      "email": "example",
      "employee_number": "example",
      "first_name": "example",
      "id": 1,
      "last_name": "example"
    }
  }
}
```

### Get user

Get a Specific User.

**Inputs**

- User (`app_user_id`, text, required): User ID

**Outputs**

- `data` (object): Know Be4 response data.

**Example output**

```json
{
  "data": {
    "aliases": [],
    "archived_at": "example",
    "comment": "example",
    "current_risk_score": 1,
    "custom_date_1": "example",
    "custom_date_2": "example",
    "custom_field_1": "example",
    "custom_field_2": "example",
    "custom_field_3": "example",
    "custom_field_4": "example",
    "department": "example",
    "division": "example",
    "email": "example",
    "employee_number": "example",
    "employee_start_date": "example",
    "extension": "example",
    "first_name": "example",
    "groups": [],
    "id": 1,
    "job_title": "example",
    "joined_on": "example",
    "language": "example",
    "last_name": "example",
    "last_sign_in": "example",
    "location": "example",
    "manager_email": "example",
    "manager_name": "example",
    "mobile_phone_number": "example",
    "organization": "example",
    "phish_prone_percentage": 1,
    "phone_number": "example",
    "provisioning_guid": "example",
    "provisioning_managed": false,
    "status": "example"
  }
}
```

### Get user risk history

Get a Specific User's Risk Score History.

**Inputs**

- User (`app_user_id`, text, required): The record ID from the corresponding list action.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List campaign security tests

Get All PSTs From a Specific Campaign.

**Inputs**

- Campaign id (`campaign_id`, text, required): Campaign ID
- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List group members

Get a List of Users in a Specific Group.

**Inputs**

- Group id (`group_id`, text, required): Group ID
- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List groups

Get a List of All Groups.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List phishing campaigns

Get All Phishing Campaigns.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List policies

Get all Policies.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List security tests

Get All Phishing Security Tests (PSTs).

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List store purchases

Get all Store Purchases.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List test recipients

Get All Recipient Results.

**Inputs**

- Pst id (`pst_id`, text, required): PST ID
- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List training campaigns

Get all Training Campaigns.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List training enrollments

Get all Training Enrollments.

**Inputs**

- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```

### List users

Get a List of All Users.

**Inputs**

- Status (`status`, text): Status. One of: `active`, `archived`.
- Group id (`group_id`, text): Group id.
- Expand (`expand`, text): Expand. One of: `group`.
- Per page (`per_page`, number): Per page. From 1 to 500.
- Cursor (`cursor`, text): Cursor.

**Outputs**

- `data` (list): Know Be4 response data.

**Example output**

```json
{
  "data": []
}
```
