KnowBe4

App · 24 actions

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

Actions

ActionWhat it does
Get accountGet Account and Subscription Data.
Get account risk historyGet Account Risk Score History.
Get groupGet a Specific Group.
Get group risk historyGet a Specific Group's Risk Score History.
Get phishing campaignGet a Specific Phishing Campaign.
Get policyGet a Specific Policy.
Get security testGet a Specific PST.
Get store purchaseGet a Specific Store Purchase.
Get test recipientGet a Specific Recipient's Results.
Get training campaignGet a Specific Training Campaign.
Get training enrollmentGet a Specific Training Enrollment.
Get userGet a Specific User.
Get user risk historyGet a Specific User's Risk Score History.
List campaign security testsGet All PSTs From a Specific Campaign.
List group membersGet a List of Users in a Specific Group.
List groupsGet a List of All Groups.
List phishing campaignsGet All Phishing Campaigns.
List policiesGet all Policies.
List security testsGet All Phishing Security Tests (PSTs).
List store purchasesGet all Store Purchases.
List test recipientsGet All Recipient Results.
List training campaignsGet all Training Campaigns.
List training enrollmentsGet all Training Enrollments.
List usersGet a List of All Users.

Get account

Get Account and Subscription Data.

Inputs

None.

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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 pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

Get group

Get a Specific Group.

Inputs

Group idgroup_idtextRequired
Group ID

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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

Groupgroup_idtextRequired
The record ID from the corresponding list action.
Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

Get phishing campaign

Get a Specific Phishing Campaign.

Inputs

Campaign idcampaign_idtextRequired
Campaign ID
Campaign type callbackcampaign_type_callbacktext
Returns information related to callback phishing campaigns.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

Get policy

Get a Specific Policy.

Inputs

Policy idpolicy_idtextRequired
Policy id.

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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 idpst_idtextRequired
PST ID
Campaign type callbackcampaign_type_callbacktext
Returns information related to callback phishing campaigns.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

Get store purchase

Get a Specific Store Purchase.

Inputs

Store purchase idstore_purchase_idtextRequired
Store Purchase ID

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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 idpst_idtextRequired
PST ID
Recipient idrecipient_idtextRequired
Recipient ID
Campaign type callbackcampaign_type_callbacktext
Returns information related to callback phishing campaigns.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

Get training campaign

Get a Specific Training Campaign.

Inputs

Campaign idcampaign_idtextRequired
Campaign id.

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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 idenrollment_idtextRequired
Enrollment ID
Include campaign id trueinclude_campaign_id_truetrue/false
Returns the campaign ID for each training enrollment.

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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

Userapp_user_idtextRequired
User ID

Outputs

dataobject
Know Be4 response data.
Example output
{
  "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

Userapp_user_idtextRequired
The record ID from the corresponding list action.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List campaign security tests

Get All PSTs From a Specific Campaign.

Inputs

Campaign idcampaign_idtextRequired
Campaign ID
Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List group members

Get a List of Users in a Specific Group.

Inputs

Group idgroup_idtextRequired
Group ID
Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List groups

Get a List of All Groups.

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List phishing campaigns

Get All Phishing Campaigns.

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List policies

Get all Policies.

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List security tests

Get All Phishing Security Tests (PSTs).

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List store purchases

Get all Store Purchases.

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List test recipients

Get All Recipient Results.

Inputs

Pst idpst_idtextRequired
PST ID
Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List training campaigns

Get all Training Campaigns.

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List training enrollments

Get all Training Enrollments.

Inputs

Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

List users

Get a List of All Users.

Inputs

Statusstatustext
Status.One of: active, archived.
Group idgroup_idtext
Group id.
Expandexpandtext
Expand.One of: group.
Per pageper_pagenumber
Per page.From 1 to 500.
Cursorcursortext
Cursor.

Outputs

datalist
Know Be4 response data.
Example output
{
  "data": []
}

On this page