KnowBe4KMSAT Deprecated

Deprecated. Use KnowBe4KMSAT instead.

Details

ID	`KnowBe4KMSAT`
Provider	Vista Equity Partners
Category	Network Security
From Version	6.5.0
Docker Image	`demisto/python3:3.10.10.48392`
Supported Modules	Agentix

README

KnowBe4’s KMSAT Console is a security awareness training and simulated phishing console that you can use to improve your organization’s overall security. This integration pack allows you to push and pull your external data to and from your KMSAT console.

What Does This Pack Do?
1. Pull Risk Score history for your account
2. Pull Risk Score history for your groups
3. Pull Risk Score history for your users
4. Pull all Phishing Security Test (PST) results for your account
5. Pull Phishing Security Test (PST) results for a specific campaign
6. Pull statuses of your training campaigns
7. Pull a list of your users’ training campaign enrollments
8. Pull your users’ event data
9. Add events to User Timelines in KMSAT
10. Delete events from User Timelines in KMSAT

Configuration

Parameter	Description	Requirement
Instance Name	Enter a name for your KMSAT instance.	Required
Your Reporting Server URL	Enter the Reporting Server URL for your KMSAT instance, which you can find in KnowBe4’s Reporting API documentation.	Required
Reporting API Key	Enter the Reporting API key to use for the connection. To generate this key, see KnowBe4’s Account Settings: API documentation.	Required
Your User Events Server URL	Enter the User Event URL for your KMSAT instance, which you can find in KnowBe4’s User Event API documentation.	Required
User Events API Key	Enter the User Event API key to use for the connection. To generate this key, see KnowBe4’s User Event API documentation.	Required

Commands

Commands	Description
kmsat-account-info-list	Displays account information
kmsat-account-risk-score-history-list	Displays your organization’s Risk Score history
kmsat-groups-list	Displays all groups
kmsat-groups-risk-score-history-list	Displays Risk Score history for groups
kmsat-groups-members-list	Displays members of groups
kmsat-users-risk-score-history-list	Displays Risk Score history for users
kmsat-phishing-security-tests-list	Displays all PSTs
kmsat-phishing-security-tests-recipients-list	Displays PSTs and user data for enrolled users
kmsat-phishing-security-tests-failed-recipients-list	Displays failed PSTs and user data for enrolled users
kmsat-phishing-campaign-security-tests-list	Displays PSTs for a phishing campaign
kmsat-training-campaigns-list	Displays all training campaigns
kmsat-training-enrollments-list	Displays all training enrollments
kmsat-user-event-list	Displays a user event by id
kmsat-user-events-list	Displays all user events
kmsat-user-event-types-list	Displays types of user events
kmsat-user-event-create	Creates an event on the User Timeline
kmsat-user-event-delete	Deletes an event from the User Timeline
kmsat-user-event-status-list	Lists the status of user event request by request id
kmsat-user-event-statuses-list	Lists the statuses of user event requests

kmsat-account-info-list

Context Output

Path	Type	Description
KMSAT.AccountInfo.name	String	Account name
KMSAT.AccountInfo.type	String	Account type
KMSAT.AccountInfo.domains	String	Account domains
KMSAT.AccountInfo.admins.id	Number	Account admin ID
KMSAT.AccountInfo.admins.first_name	String	Account admin first name
KMSAT.AccountInfo.admins.last_name	String	Account admin last name
KMSAT.AccountInfo.admins.email	String	Account admin email address
KMSAT.AccountInfo.subscription_email	String	Account subscription level
KMSAT.AccountInfo.subscription_end_date	Date	Account subscription end date
KMSAT.AccountInfo.number_of_seats	Number	Number of account seats
KMSAT.AccountInfo.current_risk_score	Number	Account Risk Score

Command Example


#### Context Example

```json

{
  "name": "KB4-Demo",
  "type": "paid",
  "domains": [
    "kb4-demo.com"
  ],
  "admins": [
    {
      "id": 974278,
      "first_name": "Grace",
      "last_name": "O'Malley",
      "email": "example5@kb4-demo.com"
    }
  ],
  "subscription_level": "Diamond",
  "subscription_end_date": "2021-03-06",
  "number_of_seats": 25,
  "current_risk_score": 45.742
}

kmsat-account-risk-score-history

Argument Name	Description	Required
page	Page Number	No
per_page	Per Page Amount	No

Context Output

Path	Type	Description
KMSAT.AccountRiskScoreHistory.risk_score	String	Account Risk Score and associated date
KMSAT.AccountRiskScoreHistory.date	Date	Account Risk Score history date

Command Example

!kmsat-account-risk-score-history-list page=1 per_page=25

Context Example

{
  "risk_score": 37.3,
  "date": "2021-02-07"
}

kmsat-groups-list

kmsat-account-risk-score-history

Argument Name	Description	Requirement
page	Page Number	Optional
per_page	Per Page Amount	Optional

Context Output

Path	Type	Description
KMSAT.Groups.id	Number	Group ID
KMSAT.Groups.name	String	Group name
KMSAT.Groups.group_type	String	Group type
KMSAT.Groups.provisioning_guid	String	Group provisioning GUID
KMSAT.Groups.member_count	Number	Group member count
KMSAT.Groups.current_risk_score	Number	Group’s current Risk Score
KMSAT.Groups.status	String	Groups status

Command Example

!kmsat-groups-list page=1 per_page=25

Context Example

{
  "id": 3142,
  "name": "Customer Service",
  "group_type": "console_group",
  "provisioning_guid": "abc12345-6789-abc-1234-456789abc123",
  "member_count": 42,
  "current_risk_score": 45.742,
  "status": "active"
}

kmsat-groups-risk-score-history

Argument Name	Description	Requirement
group_id	Group ID	Optional
page	Page number	Optional
per_page	Amount per page	Optional

Context Output

Path	Type	Description
KMSAT.GroupRiskScoreHistory.risk_score	String	Group Risk Score And associated date
KMSAT.GroupRiskHistory.date	Date	Group Risk Score history date

Command Example

!kmsat-groups-risk-score-history-list page=1 per_page=25

Context Example

{
  "risk_score": 37.3,
  "date": "2021-02-07"
}

kmsat-groups-members

Argument Name	Description	Requirement
group_id	Group ID	Required
page	Page Number	Optional
per_page	Per Page Amount	Optional

Context Output

Path	Type	Description
KMSAT.GroupsMembers.id	Number	User’s ID
KMSAT.GroupsMembers.employee_number	String	User’s employee number
KMSAT.GroupsMembers.first_name	String	User’s first name
KMSAT.GroupsMembers.last_name	String	User’s last name
KMSAT.GroupsMembers.job_title	String	User’s job title
KMSAT.GroupsMembers.email	String	User’s email address
KMSAT.GroupsMembers.phish_prone_percentage	Number	User’s Phish-prone Percentage
KMSAT.GroupsMembers.phone_number	String	User’s phone number
KMSAT.GroupsMembers.extension	String	User’s extension
KMSAT.GroupsMembers.mobile_phone_number	String	User’s phone number
KMSAT.GroupsMembers.location	String	User’s location
KMSAT.GroupsMembers.division	String	User’s division
KMSAT.GroupsMembers.manager_name	String	Name of user’s manager
KMSAT.GroupsMembers.provisioning_managed	Boolean	Email address of user’s manager
KMSAT.GroupsMembers.provisioning_guid	Unknown	User’s provisioning GUID
KMSAT.GroupsMembers.groups	Number	User’s groups
KMSAT.GroupsMembers.current_risk_score	Number	User’s current Risk Score
KMSAT.GroupsMembers.aliases	String	User’s aliases
KMSAT.GroupsMembers.joined_on	Date	User created at
KMSAT.GroupsMembers.last_sign_in	Date	User’s last login
KMSAT.GroupsMembers.status	String	User’s status
KMSAT.GroupsMembers.organization	String	User’s organization
KMSAT.GroupsMembers.department	String	User’s department
KMSAT.GroupsMembers.language	String	User’s language
KMSAT.GroupsMembers.comment	String	User comment
KMSAT.GroupsMembers.employee_start_date	Date	User’s employee start date
KMSAT.GroupsMembers.archived_at	Date	User archived at
KMSAT.GroupsMembers.custom_field_1	String	User custom field 1
KMSAT.GroupsMembers.custom_field_2	String	User custom field 2
KMSAT.GroupsMembers.custom_field_3	String	User custom field 3
KMSAT.GroupsMembers.custom_date_1	Date	User custom date 1
KMSAT.GroupsMembers.custom_date_2	Date	User custom date 2

Command Example

!kmsat-groups-members-list group_id=1 page=1 per_page=25

Context Example

{
  "id": 667542,
  "employee_number": "19425",
  "first_name": "William",
  "last_name": "Marcoux",
  "job_title": "VP of Sales",
  "email": "example2@kb4-demo.com",
  "phish_prone_percentage": 14.235,
  "phone_number": "555-554-2222",
  "extension": "42",
  "mobile_phone_number": "555-553-4422",
  "location": "Office A",
  "division": "Sales",
  "manager_name": "Michael Scott",
  "manager_email": "example3@kb4-demo.com",
  "provisioning_managed": false,
  "provisioning_guid": null,
  "groups": [
    3264
  ],
  "current_risk_score": 45.742,
  "aliases": [
    "alias_email@kb4-demo.com"
  ],
  "joined_on": "2019-04-02T15:02:38.000Z",
  "last_sign_in": "2019-04-02T15:02:38.000Z",
  "status": "active",
  "organization": "KB4-Demo",
  "department": "Sales",
  "language": "English - United States",
  "comment": "Low PPP",
  "employee_start_date": "2019-04-02T15:02:38.000Z",
  "archived_at": null,
  "custom_field_1": "Building C, 4th Floor",
  "custom_field_2": null,
  "custom_field_3": null,
  "custom_field_4": null,
  "custom_date_1": "1986-11-26",
  "custom_date_2": null
}

kmsat-users-risk-score-history

Argument Name	Description	Requirement
user_id	User ID	Required
page	Page number	Optional
per_page	Amount per page	Optional

Context Output

Path	Type	Description
KMSAT.UsersRiskHistory.risk_score	Number	User’s Risk Score and associated date
KMSAT.UsersRiskHistory.date	Date	User’s Risk Score history date

Command Example

!kmsat-users-risk-score-history-list user_id=1 page=1 per_page=25

Context Example

{
  "risk_score": 37.3,
  "date": "2021-02-07"
}

kmsat-phishing-security-tests

Argument Name	Description	Requirement
page	Page number	Optional
per_page	Amount per page	Optional

Context Output

Path	Type	Description
KMSAT.PhishingSecurity.campaign_id	Number	Phishing campaign ID
KMSAT.PhishingSecurity.pst_id	Number	PST ID
KMSAT.PhishingSecurity.status	String	PST status
KMSAT.PhishingSecurity.name	String	PST name
KMSAT.PhishingSecurity.groups.group_id	Number	PST group ID
KMSAT.PhishingSecurity.groups.name	String	PST group name
KMSAT.PhishingSecurity.phish_prone_percentage	Number	PST Phish-prone Percentage
KMSAT.PhishingSecurity.started_at	Date	PST started date
KMSAT.PhishingSecurity.duration	Number	PST duration
KMSAT.PhishingSecurity.categories.category_id	Number	PST category ID
KMSAT.PhishingSecurity.categories.name	String	PST category name
KMSAT.PhishingSecurity.template.id	Number	PST template ID
KMSAT.PhishingSecurity.template.name	String	PST template Name
KMSAT.PhishingSecurity.lading_page.id	Number	PST landing page ID
KMSAT.PhishingSecurity.landing_page.name	String	PST landing page name
KMSAT.PhishingSecurity.scheduled_count	Number	PST scheduled count
KMSAT.PhishingSecurity.delivered_count	Number	PST delivered count
KMSAT.PhishingSecurity.opened_count	Number	PST opened count
KMSAT.PhishingSecurity.clicked_count	Number	PST clicked count
KMSAT.PhishingSecurity.replied_count	Number	PST replied count
KMSAT.PhishingSecurity.attachment_open_count	Number	PST attachment opened count
KMSAT.PhishingSecurity.macro_enabled_count	Number	PST macro enabled count
KMSAT.PhishingSecurity.data_entered_count	Number	PST data entered count
KMSAT.PhishingSecurity.qr_code_scanned_count	Number	PST QR Code scanned count
KMSAT.PhishingSecurity.reported_count	Number	PST reported count
KMSAT.PhishingSecurity.bounced_count	Number	PST bounced count

Command Example

!kmsat-phishing-security-tests-list page=1 per_page=25

Context Example

[
  {
    "campaign_id": 3423,
    "pst_id": 16142,
    "status": "Closed",
    "name": "Corporate Test",
    "groups": [
      {
        "group_id": 16342,
        "name": "Corporate Employees"
      }
    ],
    "phish_prone_percentage": 0.5,
    "started_at": "2019-04-02T15:02:38.000Z",
    "duration": 1,
    "categories": [
      {
        "category_id": 4237,
        "name": "Current Events"
      }
    ],
    "template": {
      "id": 11428,
      "name": "CNN Breaking News"
    },
    "landing_page": {
      "id": 1842,
      "name": "SEI Landing Page"
    },
    "scheduled_count": 42,
    "delivered_count": 4,
    "opened_count": 24,
    "clicked_count": 20,
    "replied_count": 0,
    "attachment_open_count": 3,
    "macro_enabled_count": 0,
    "data_entered_count": 0,
    "qr_code_scanned_count": 0,
    "reported_count": 0,
    "bounced_count": 0
  }
]

kmsat-phishing-security-tests-recipients

Argument Name	Description	Requirement
pst_id	PST ID	Required
page	Page number	Optional
per_page	Amount per page	Optional

Context Output

Path	Type	Description
KMSAT.PhishingSecurityPST.recipient_id	Number	PST recipient ID
KMSAT.PhishingSecurityPST.pst_id	Number	PST ID
KMSAT.PhishingSecurityPST.user	String	PST user
KMSAT.PhishingSecurityPST.template	String	PST template
KMSAT.PhishingSecurityPST.scheduled_at	Date	PST scheduled at
KMSAT.PhishingSecurityPST.delivered_at	Date	PST delivered at
KMSAT.PhishingSecurityPST.opened_at	Date	PST opened at
KMSAT.PhishingSecurityPST.clicked_at	Date	PST clicked at
KMSAT.PhishingSecurityPST.replied_at	Date	PST replied at
KMSAT.PhishingSecurityPST.attachment_opened_at	Date	PST attachment opened at
KMSAT.PhishingSecurityPST.macro_enabled_at	Date	PST macro enabled at
KMSAT.PhishingSecurityPST.data_entered_at	Date	PST data entered at
KMSAT.PhishingSecurityPST.qr_code_scanned	Date	PST QR code scanned at
KMSAT.PhishingSecurityPST.reported_at	Date	PST reported at
KMSAT.PhishingSecurityPST.bounced_at	Date	PST bounced at
KMSAT.PhishingSecurityPST.ip	String	PST IP address
KMSAT.PhishingSecurityPST.up_location	String	PST IP address location
KMSAT.PhishingSecurityPST.browser	String	PST browser
KMSAT.PhishingSecurityPST.browser_version	String	PST browser version
KMSAT.PhishingSecurityPST.os	String	PST operating system

Command Example

!kmsat-phishing-security-tests-recipients-list pst_id=1 page=1 per_page=25

Context Example

[
  {
    "recipient_id": 3077742,
    "pst_id": 14240,
    "user": {
      "id": 264215,
      "provisioning_guid": null,
      "first_name": "Bob",
      "last_name": "Ross",
      "email": "example4@kb4-demo.com"
    },
    "template": {
      "id": 2,
      "name": "Your Amazon Order"
    },
    "scheduled_at": "2019-04-02T15:02:38.000Z",
    "delivered_at": "2019-04-02T15:02:38.000Z",
    "opened_at": "2019-04-02T15:02:38.000Z",
    "clicked_at": "2019-04-02T15:02:38.000Z",
    "replied_at": null,
    "attachment_opened_at": null,
    "macro_enabled_at": null,
    "data_entered_at": "2019-04-02T15:02:38.000Z",
    "qr_code_scanned": "2022-05-12T15:29:54.000Z",
    "reported_at": null,
    "bounced_at": null,
    "ip": "XX.XX.XXX.XXX",
    "ip_location": "St.Petersburg, FL",
    "browser": "Chrome",
    "browser_version": "48.0",
    "os": "MacOSX"
  }
]

kmsat-phishing-security-tests-failed-recipients

Argument Name	Description	Requirement
pst_id	PST ID	Required

Context Output

Path	Type	Description
KMSAT.PhishingSecurityPST.recipient_id	Number	PST recipient ID
KMSAT.PhishingSecurityPST.pst_id	Number	PST ID
KMSAT.PhishingSecurityPST.user	String	PST user
KMSAT.PhishingSecurityPST.template	String	PST template
KMSAT.PhishingSecurityPST.scheduled_at	Date	PST scheduled at
KMSAT.PhishingSecurityPST.delivered_at	Date	PST delivered at
KMSAT.PhishingSecurityPST.opened_at	Date	PST opened at
KMSAT.PhishingSecurityPST.clicked_at	Date	PST clicked at
KMSAT.PhishingSecurityPST.replied_at	Date	PST replied at
KMSAT.PhishingSecurityPST.attachment_opened_at	Date	PST attachment opened at
KMSAT.PhishingSecurityPST.macro_enabled_at	Date	PST macro enabled at
KMSAT.PhishingSecurityPST.data_entered_at	Date	PST data entered at
KMSAT.PhishingSecurityPST.qr_code_scanned	Date	PST QR code scanned at
KMSAT.PhishingSecurityPST.reported_at	Date	PST reported at
KMSAT.PhishingSecurityPST.bounced_at	Date	PST bounced at
KMSAT.PhishingSecurityPST.ip	String	PST IP address
KMSAT.PhishingSecurityPST.up_location	String	PST IP address location
KMSAT.PhishingSecurityPST.browser	String	PST browser
KMSAT.PhishingSecurityPST.browser_version	String	PST browser version
KMSAT.PhishingSecurityPST.os	String	PST operating system

Command Example

!kmsat-phishing-security-tests-failed-recipients-list pst_id=1

Context Example

[
  {
    "recipient_id": 3077742,
    "pst_id": 14240,
    "user": {
      "id": 264215,
      "provisioning_guid": null,
      "first_name": "Bob",
      "last_name": "Ross",
      "email": "example4@kb4-demo.com"
    },
    "template": {
      "id": 2,
      "name": "Your Amazon Order"
    },
    "scheduled_at": "2019-04-02T15:02:38.000Z",
    "delivered_at": "2019-04-02T15:02:38.000Z",
    "opened_at": "2019-04-02T15:02:38.000Z",
    "clicked_at": "2019-04-02T15:02:38.000Z",
    "replied_at": null,
    "attachment_opened_at": null,
    "macro_enabled_at": null,
    "data_entered_at": "2019-04-02T15:02:38.000Z",
    "qr_code_scanned": "2022-05-12T15:29:54.000Z",
    "reported_at": null,
    "bounced_at": null,
    "ip": "XX.XX.XXX.XXX",
    "ip_location": "St.Petersburg, FL",
    "browser": "Chrome",
    "browser_version": "48.0",
    "os": "MacOSX"
  }
]

kmsat-phishing-campaign-security-tests

Argument Name	Description	Requirement
campaign_id	Campaign ID	Required
page	Page number	Optional
per_page	Amount per page	Optional

Context Output

Path	Type	Description
KMSAT.CampaignPST.campaign_id	Number	Phishing campaign ID
KMSAT.CampaignPST.pst_id	Number	PST ID
KMSAT.CampaignPST.status	String	PST status
KMSAT.CampaignPST.name	String	PST name
KMSAT.CampaignPST.groups.group_id	Number	PST group ID
KMSAT.CampaignPST.groups.name	String	PST group name
KMSAT.CampaignPST.phish_prone_percentage	Number	PST Phish-prone Percentage
KMSAT.CampaignPST.started_at	Date	PST started at
KMSAT.CampaignPST.duration	Number	PST duration
KMSAT.CampaignPST.categories.category_id	Number	PST category ID
KMSAT.CampaignPST.categories.name	String	PST category name
KMSAT.CampaignPST.template.id	Number	PST template ID
KMSAT.CampaignPST.template.name	String	PST template name
KMSAT.CampaignPST.landing_page.id	Number	PST landing page ID
KMSAT.CampaignPST.landing_page.name	String	PST landing page name
KMSAT.CampaignPST.scheduled_count	Number	PST scheduled count
KMSAT.CampaignPST.delivered_count	Number	PST delivered count
KMSAT.CampaignPST.opened_count	Number	PST opened count
KMSAT.CampaignPST.clicked_count	Number	PST clicked count
KMSAT.CampaignPST.replied_count	Number	PST replied count
KMSAT.CampaignPST.attachment_open_count	Number	PST attachment opened count
KMSAT.CampaignPST.macro_enabled_count	Number	PST macro enabled count
KMSAT.CampaignPST.data_entered_count	Number	PST data entered count
KMSAT.CampaignPST.qr_code_scanned_count	Number	PST QR code scanned count
KMSAT.CampaignPST.reported_count	Number	PST reported count
KMSAT.CampaignPST.bounced_count	Number	PST bounced count

Command Example

!kmsat-phishing-campaign-security-tests-list campaign_id=1 page=1 per_page=25

Context Example

[
  {
    "campaign_id": 3423,
    "pst_id": 16142,
    "status": "Closed",
    "name": "Corporate Test",
    "groups": [
      {
        "group_id": 16342,
        "name": "Corporate Employees"
      }
    ],
    "phish_prone_percentage": 0.5,
    "started_at": "2019-04-02T15:02:38.000Z",
    "duration": 1,
    "categories": [
      {
        "category_id": 4237,
        "name": "Current Events"
      }
    ],
    "template": {
      "id": 11428,
      "name": "CNN Breaking News"
    },
    "landing_page": {
      "id": 1842,
      "name": "SEI Landing Page"
    },
    "scheduled_count": 42,
    "delivered_count": 4,
    "opened_count": 24,
    "clicked_count": 20,
    "replied_count": 0,
    "attachment_open_count": 3,
    "macro_enabled_count": 0,
    "data_entered_count": 0,
    "qr_code_scanned_count": 0,
    "reported_count": 0,
    "bounced_count": 0
  }
]

kmsat-training-campaigns

Argument Name	Description	Requireent
page	Page Number	Optional
per_page	Per Page Amount	Optional

Context Output

Path	Type	Description
KMSAT.TrainingCampaigns.campaign_id	Number	Training campaign ID
KMSAT.TrainingCampaigns.name	String	Training campaign name
KMSAT.TrainingCampaigns.groups.group_id	Number	Training campaign group ID
KMSAT.TrainingCampaigns.groups.name	String	Training campaign group name
KMSAT.TrainingCampaigns.status	String	Training campaign Status
KMSAT.TrainingCampaigns.content.store_purchase_id	Number	Training campaign content store purchase ID
KMSAT.TrainingCampaigns.content.content_type	String	Training campaign content type
KMSAT.TrainingCampaigns.content.name	String	Training campaign content name
KMSAT.TrainingCampaigns.content.description	String	Training campaign content description
KMSAT.TrainingCampaigns.content.type	String	Training campaign content type
KMSAT.TrainingCampaigns.content.duration	Number	Training campaign content duration
KMSAT.TrainingCampaigns.content.retired	Boolean	Training campaign content retired
KMSAT.TrainingCampaigns.content.retirement_date	Date	Training campaign content retirement date
KMSAT.TrainingCampaigns.content.publish_date	Date	Training campaign content publish date
KMSAT.TrainingCampaigns.content.publisher	String	Training campaign content publisher
KMSAT.TrainingCampaigns.content.purchase_date	Date	Training campaign content purchase date
KMSAT.TrainingCampaigns.content.policy_url	String	Training campaign content policy URL
KMSAT.TrainingCampaigns.content.policy_id	Number	Training campaign content policy ID
KMSAT.TrainingCampaigns.content.minimum_time	Number	Training campaign content minimum time
KMSAT.TrainingCampaigns.content.default_language	String	Training campaign content default language
KMSAT.TrainingCampaigns.content.published	Boolean	Training campaign content published
KMSAT.TrainingCampaigns.duration_type	String	Training campaign duration type
KMSAT.TrainingCampaigns.start_date	Date	Training campaign start date
KMSAT.TrainingCampaigns.end_date	Date	Training campaign end date
KMSAT.TrainingCampaigns.relative_duration	String	Training campaign relative duration
KMSAT.TrainingCampaigns.auto_enroll	Boolean	Training campaign auto enrolls
KMSAT.TrainingCampaigns.allow_multiple_enrollments	Boolean	Training campaign allows multiple enrollments
KMSAT.TrainingCampaigns.completion_percentage	Number	Training campaign completion percentage

Command Example

!kmsat-training-campaigns-list campaign_id=1 page=1 per_page=25

Context Example

{
  "campaign_id": 4261,
  "name": "Annual Training",
  "groups": [
    {
      "group_id": 0,
      "name": "All Users"
    }
  ],
  "status": "Completed",
  "content": [
    [
      {
        "store_purchase_id": 7,
        "content_type": "Store Purchase",
        "name": "2019 Security Awareness Training",
        "description": "A comprehensive overview of best practices...",
        "type": "Training Module",
        "duration": 42,
        "retired": false,
        "retirement_date": null,
        "publish_date": "2019-04-02T15:02:38.000Z",
        "publisher": "KnowBe4",
        "purchase_date": "2019-04-02T15:02:38.000Z",
        "policy_url": "https://www.yourcompany.com/employees/acceptableusepolicy.html"
      },
      {
        "policy_id": 142,
        "content_type": "Uploaded Policy",
        "name": "Security Awareness Policy",
        "minimum_time": 3,
        "default_language": "en-us",
        "published": true
      }
    ]
  ],
  "duration_type": "Specific End Date",
  "start_date": "2019-04-02T15:02:38.000Z",
  "end_date": "2019-04-02T15:02:38.000Z",
  "relative_duration": "string",
  "auto_enroll": true,
  "allow_multiple_enrollments": false,
  "completion_percentage": 0
}

kmsat-training-enrollments

Argument Name	Description	Requirement
status	Status	Optional
page	Page number	Optional
per_page	Amount per page	Optional

Context Output

Path	Type	Description
KMSAT.TrainingEnrollments.enrollment_id	Number	Training enrollment ID
KMSAT.TrainingEnrollments.content_type	String	Training enrollment content type
KMSAT.TrainingEnrollments.module_name	String	Training enrollment module name
KMSAT.TrainingEnrollments.user.id	Number	Training enrollment user ID
KMSAT.TrainingEnrollments.user.first_name	String	Training enrollment user’s first name
KMSAT.TrainingEnrollments.user.last_name	String	Training enrollment user’s last name
KMSAT.TrainingEnrollments.user.email	String	Training enrollment user’s email address
KMSAT.TrainingEnrollments.campaign_name	String	Training enrollment campaign name
KMSAT.TrainingEnrollments.enrollment_date	Date	Training enrollment date
KMSAT.TrainingEnrollments.start_date	Date	Training enrollment start date
KMSAT.TrainingEnrollments.completion_date	Date	Training enrollment completion date
KMSAT.TrainingEnrollments.status	String	Training enrollment status
KMSAT.TrainingEnrollments.time_spent	Number	Training enrollment time spent
KMSAT.TrainingEnrollments.policy_acknowledged	Boolean	Training enrollment policy acknowledged

Command Example

!kmsat-training-enrollments-list status="Completed" page=1 per_page=25

Context Example

{
  "enrollment_id": 1425526,
  "content_type": "Uploaded Policy",
  "module_name": "Acceptable Use Policy",
  "user": {
    "id": 796742,
    "first_name": "Sarah",
    "last_name": "Thomas",
    "email": "example1@kb4-demo.com"
  },
  "campaign_name": "New Employee Policies",
  "enrollment_date": "2019-04-02T15:02:38.000Z",
  "start_date": "2019-04-02T15:02:38.000Z",
  "completion_date": "2019-04-02T15:02:38.000Z",
  "status": "Passed",
  "time_spent": 2340,
  "policy_acknowledged": false
}

kmsat-user-event-list

Argument Name	Type	Requirement
event_type	String	Optional
target_user	String	Optional
external_id	String	Optional
source	string	Optional
occurred_date	String	Optional
risk_level	Number	Optional
risk_decay_mode	Number	Optional
risk_expired_date	String	Optional
page	Number	Optional
per_page	Number	Optional
order_by	String	Optional
order_direction	String	Optional

Context Output

Path	Type	Description
KMSAT.UserEvents.id	Number	Event ID
KMSAT.UserEvents.user.email	String	User email address
KMSAT.UserEvents.user.id	Number	User ID
KMSAT.UserEvents.user.archived	Boolean	User archived
KMSAT.UserEvents.external_id	String	External ID of the event
KMSAT.UserEvents.source	String	Source of the event
KMSAT.UserEvents.description	String	Description of the event
KMSAT.UserEvents.occurred_date	Date	Date the event occurred
KMSAT.UserEvents.risk.level	Number	Risk level of the event
KMSAT.UserEvents.risk.factor	Number	Risk factor of the event
KMSAT.UserEvents.risk.decay_mode	String	Decay Mode of the risk level
KMSAT.UserEvents.risk.expire_date	String	Risk expiration date
KMSAT.UserEvents.event_type.id	Number	ID of event type
KMSAT.UserEvents.event_type.name	String	Name of event type

Command Example

!kmsat-user-event-list id=xyz

kmsat-user-events-list

Argument Name	Type	Requirement
event_type	String	Optional
target_user	String	Optional
external_id	String	Optional
source	string	Optional
occurred_date	String	Optional
risk_level	Number	Optional
risk_decay_mode	Number	Optional
risk_expired_date	String	Optional
page	Number	Optional
per_page	Number	Optional
order_by	String	Optional
order_direction	String	Optional

Context Output

Path	Type	Description
KMSAT.UserEvents.id	Number	Event ID
KMSAT.UserEvents.user.email	String	User email address
KMSAT.UserEvents.user.id	Number	User ID
KMSAT.UserEvents.user.archived	Boolean	User archived
KMSAT.UserEvents.external_id	String	External ID of the event
KMSAT.UserEvents.source	String	Source of the event
KMSAT.UserEvents.description	String	Description of the event
KMSAT.UserEvents.occurred_date	Date	Date the event occurred
KMSAT.UserEvents.risk.level	Number	Risk level of the event
KMSAT.UserEvents.risk.factor	Number	Risk factor of the event
KMSAT.UserEvents.risk.decay_mode	String	Decay Mode of the risk level
KMSAT.UserEvents.risk.expire_date	String	Risk expiration date
KMSAT.UserEvents.event_type.id	Number	ID of event type
KMSAT.UserEvents.event_type.name	String	Name of event type

Command Example

!kmsat-user-events-list target_user=1 risk_level=1 page=1 per_page=25

Context Example

{
  "data": [
    {
      "id": 0,
      "user": {
        "email": "string",
        "id": 0,
        "archived": true
      },
      "external_id": "string",
      "source": "string",
      "description": "string",
      "occurred_date": "2019-08-24",
      "risk": {
        "level": 0,
        "factor": 0,
        "decay_mode": "string",
        "expire_date": "string"
      },
      "event_type": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}

kmsat-user-event-types-list

Argument Name	Description	Requirement
name	Filter by name of the event type	Optional

Context Output

Path	Type	Description
KMSAT.UserEventTypes.id	Number	ID of the event type
KMSAT.UserEventTypes.account_id	Number	Account ID
KMSAT.UserEventTypes.name	String	Name of the event type
KMSAT.UserEventTypes.description	String	Description of event type

Command Example

!kmsat-user-event-types-list name="John"

Context Example

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string"
    }
  ]
}

kmsat-user-event-create

Argument Name	Description	Requirement
target_user	String	Required
event_type	String	Required
external_id	String	Optional
source	string	Optional
description	String	Optional
occurred_date	String	Optional
risk_level	Number	Optional
risk_decay_mode	Number	Optional
risk_expired_date	String	Optional

Context Output

Path	Type	Description
KMSAT.UserEventCreate.id	Number	Unique ID of the event

Command Example

!kmsat-user-event-create target_user="John" event_type="New Event"

Context Example

{
  "data": {
    "id": "string"
  }
}

kmsat-user-event-delete

Argument Name	Description	Requirement
id	Event ID	Required

Command Example

!kmsat-user-event-delete id=1

kmsat-user-event-status-list

Argument Name	Description	Requirement
id	request id from kmsat-	Required

Context Output

Path	Type	Description
KMSAT.UserEventStatus.id	Number	ID of the Event Type
KMSAT.UserEventTypes.details	Object	Details of event request including event id and any failures
KMSAT.UserEventTypes.details.events	Array	list of event ids
KMSAT.UserEventTypes.details.failures	Array	reasons for failure
KMSAT.UserEventTypes.processed	Date	Date and time event was processed
KMSAT.UserEventTypes.api_key	String	Name of api key used

Command Example

!kmsat-user-event-status-list id=xyz

Context Example

{
    "data": {
          "id": "abcdefgh-843c-4fc8-bb2f-decf89876f7b",
          "details": {
              "events": [
                  "123456-a083-42b9-b50a-fb69b8e2b185"
              ],
              "failures": []
          },
          "processed": "2023-04-1T14:39:40.132Z",
          "api_key": "Test integration"
      }
}

kmsat-user-event-statuses-list

Argument Name	Description	Requirement
processed	date item was processed	No
page	Page Number	No
per_page	Per Page Amount	No

Context Output

Path	Type	Description
KMSAT.UserEventStatus.id	Number	ID of the Event Type
KMSAT.UserEventTypes.details	Object	Details of event request including event id and any failures
KMSAT.UserEventTypes.details.events	Array	list of event ids
KMSAT.UserEventTypes.details.failures	Array	reasons for failure
KMSAT.UserEventTypes.processed	Date	Date and time event was processed
KMSAT.UserEventTypes.api_key	String	Name of api key used

Command Example

!kmsat-user-event-status-list id=xyz

Context Example

{
    "data": [
        {
            "id": "abcdefgh-843c-4fc8-bb2f-decf89876f7b",
            "details": {
                "events": [
                    "123456-a083-42b9-b50a-fb69b8e2b185"
                ],
                "failures": []
            },
            "processed": "2023-04-1T14:39:40.132Z",
            "api_key": "Test integration"
        },
        {
            "id": "qrstevei-843c-4fc8-bb2f-decf89876f7b",
            "details": {
                "events": [
                    "9876543-a083-42b9-b50a-fb69b8e2b185"
                ],
                "failures": []
            },
            "processed": "2023-04-1T00:39:40.132Z",
            "api_key": "Test integration"
        }
    ]
}

Configuration parameters

url — Your Reporting Server URL (required)
apikey — (required)
userEventsUrl — Your User Events Server URL (required)
userEventsApiKey — (required)
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings

Commands (19)

kmsat-account-info-list
Returns KMSAT account information
kmsat-account-risk-score-history-list
Returns KMSAT Account Risk Score History.
kmsat-groups-list
Returns KMSAT Group Specific Risk Score History.
kmsat-groups-members-list
Returns KMSAT Groups Members.
kmsat-groups-risk-score-history-list
Returns KMSAT Group Specific Risk Score History.
kmsat-phishing-campaigns-security-tests-list
Returns All Campaign Phishing Security Tests (PSTs).
kmsat-phishing-security-tests-failed-recipients-list
Returns a Specific Failed Recipient's Results.
kmsat-phishing-security-tests-list
Returns All Phishing Security Tests (PSTs)
kmsat-phishing-security-tests-recipients-list
Returns a Specific Recipient's Results.
kmsat-training-campaigns-list
Returns All Training Campaigns.
kmsat-training-enrollments-list
Returns all Training Enrollments
kmsat-user-event-create
Adds a User Event
kmsat-user-event-delete
Deletes User Event by Event ID
kmsat-user-event-list
Returns a KMSAT User Event.
kmsat-user-event-status-list
returns the status of the User Event request
kmsat-user-event-statuses-list
returns the status of the User Event request
kmsat-user-event-types-list
Returns all KMSAT User Event Types
kmsat-user-events-list
Returns all KMSAT User Events.
kmsat-users-risk-score-history-list
Returns KMSAT User Specific Risk Score History

Source

KnowBe4KMSAT.py KnowBe4KMSAT_test.py KnowBe4KMSAT.yml KnowBe4KMSAT_description.md command_examples.txt

Download History Raw

category: Network Security
provider: Vista Equity Partners
commonfields:
  id: KnowBe4KMSAT
  version: -1
configuration:
- defaultvalue: https://us.api.knowbe4.com
  display: Your Reporting Server URL
  name: url
  required: true
  type: 0
  additionalinfo: URL of the Reporting API endpoint, only FQDN is required, e.g. https://us.api.knowbe4.com
- displaypassword: Reporting API Key
  additionalinfo: The Reporting API Key to use for connection
  name: apikey
  required: true
  hiddenusername: true
  type: 9
- defaultvalue: https://api.events.knowbe4.com
  display: Your User Events Server URL
  name: userEventsUrl
  required: true
  type: 0
  additionalinfo: URL of the User Events API endpoint, only FQDN is required, e.g. https://api.events.knowbe4.com
- displaypassword: User Events API Key
  additionalinfo: The User Events API Key to use for connection
  name: userEventsApiKey
  required: true
  hiddenusername: true
  type: 9
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
description: "Deprecated. Use KnowBe4KMSAT instead."
display: "KnowBe4KMSAT (Deprecated)"
deprecated: true
name: KnowBe4KMSAT
script:
  commands:
  - name: kmsat-account-info-list
    arguments: []
    outputs:
    - contextPath: KMSAT.AccountInfo.name
      description: "Account Name"
      type: String
    - contextPath: KMSAT.AccountInfo.type
      description: "Account Type"
      type: String
    - contextPath: KMSAT.AccountInfo.domains
      description: "Account Domains"
      type: String
    - contextPath: KMSAT.AccountInfo.admins.id
      description: "Account Admin ID"
      type: Number
    - contextPath: KMSAT.AccountInfo.admins.first_name
      description: "Account Admin First Name"
      type: String
    - contextPath: KMSAT.AccountInfo.admins.last_name
      description: "Account Admin Last Name"
      type: String
    - contextPath: KMSAT.AccountInfo.admins.email
      description: "Account Admin Email"
      type: String
    - contextPath: KMSAT.AccountInfo.subscription_level
      description: "Account Subscription Level"
      type: String
    - contextPath: KMSAT.AccountInfo.subscription_end_date
      description: "Account Subscription End Date"
      type: Date
    - contextPath: KMSAT.AccountInfo.number_of_seats
      description: "Number of Seats"
      type: Number
    - contextPath: KMSAT.AccountInfo.current_risk_score
      description: "Account Risk Score"
      type: Number
    description: Returns KMSAT account information
  - name: kmsat-account-risk-score-history-list
    arguments:
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.AccountRiskScoreHistory.risk_score
      description: Account Risk Score and Associated Date
      type: String
    - contextPath: KMSAT.AccountRiskScoreHistory.date
      description: Account Risk Score History Date
      type: Date
    description: Returns KMSAT Account Risk Score History.
  - name: kmsat-groups-list
    arguments:
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.Groups.id
      description: Groups ID
      type: Number
    - contextPath: KMSAT.Groups.name
      description: Groups Name
      type: String
    - contextPath: KMSAT.Groups.group_type
      description: Groups Type
      type: String
    - contextPath: KMSAT.Groups.provisioning_guid
      description: Groups Provisioning GUID
      type: String
    - contextPath: KMSAT.Groups.member_count
      description: Groups Member Count
      type: Number
    - contextPath: KMSAT.Groups.current_risk_score
      description: Groups Risk Score
      type: Number
    - contextPath: KMSAT.Groups.status
      description: Groups Status
      type: String
    description: Returns KMSAT Group Specific Risk Score History.
  - name: kmsat-groups-risk-score-history-list
    arguments:
    - name: group_id
      required: true
      description: Group ID
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.GroupsRiskScoreHistory.risk_score
      description: Groups Risk score and associated date
      type: String
    - contextPath: KMSAT.GroupsRiskScoreHistory.date
      description: Groups Risk score history date
      type: Date
    description: Returns KMSAT Group Specific Risk Score History.
  - name: kmsat-groups-members-list
    arguments:
    - name: group_id
      required: true
      description: Group ID
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.GroupsMembers.id
      description: Groups Member ID
      type: Number
    - contextPath: KMSAT.GroupsMembers.employee_number
      description: Groups Member Employee Number
      type: String
    - contextPath: KMSAT.GroupsMembers.first_name
      description: Groups Member First Name
      type: String
    - contextPath: KMSAT.GroupsMembers.last_name
      description: Groups Member Last Name
      type: String
    - contextPath: KMSAT.GroupsMembers.job_title
      description: Groups Member Job Title
      type: String
    - contextPath: KMSAT.GroupsMembers.email
      description: Groups Member Email
      type: String
    - contextPath: KMSAT.GroupsMembers.phish_prone_percentage
      description: Groups Member Phish Prone Percentage
      type: Number
    - contextPath: KMSAT.GroupsMembers.phone_number
      description: Groups Member Phone Number
      type: String
    - contextPath: KMSAT.GroupsMembers.extension
      description: Groups Member Extension
      type: String
    - contextPath: KMSAT.GroupsMembers.mobile_phone_number
      description: Groups Member Phone Number
      type: String
    - contextPath: KMSAT.GroupsMembers.location
      description: Groups Member Location
      type: String
    - contextPath: KMSAT.GroupsMembers.division
      description: Groups Member Division
      type: String
    - contextPath: KMSAT.GroupsMembers.manager_name
      description: Groups Member Manager Name
      type: String
    - contextPath: KMSAT.GroupsMembers.manager_email
      description: Groups Member Manager Email
      type: String
    - contextPath: KMSAT.GroupsMembers.provisioning_managed
      description: Groups Member Provisioning Managed
      type: Boolean
    - contextPath: KMSAT.GroupsMembers.provisioning_guid
      description: Groups Member Provisioning GUID
      type: Unknown
    - contextPath: KMSAT.GroupsMembers.groups
      description: Groups Member Groups
      type: Number
    - contextPath: KMSAT.GroupsMembers.current_risk_score
      description: Groups Member Current Risk Score
      type: Number
    - contextPath: KMSAT.GroupsMembers.aliases
      description: Groups Member Aliases
      type: String
    - contextPath: KMSAT.GroupsMembers.joined_on
      description: Groups Member Joined On
      type: Date
    - contextPath: KMSAT.GroupsMembers.last_sign_in
      description: Groups Member Last Sign In
      type: Date
    - contextPath: KMSAT.GroupsMembers.status
      description: Groups Member Status
      type: String
    - contextPath: KMSAT.GroupsMembers.organization
      description: Groups Member Organization
      type: String
    - contextPath: KMSAT.GroupsMembers.department
      description: Groups Member Department
      type: String
    - contextPath: KMSAT.GroupsMembers.language
      description: Groups Member Language
      type: String
    - contextPath: KMSAT.GroupsMembers.comment
      description: Groups Member Comment
      type: String
    - contextPath: KMSAT.GroupsMembers.employee_start_date
      description: Groups Member Employee Start Date
      type: Date
    - contextPath: KMSAT.GroupsMembers.archived_at
      description: Groups Member Archived At
      type: Date
    - contextPath: KMSAT.GroupsMembers.custom_field_1
      description: Groups Member Custom Field 1
      type: String
    - contextPath: KMSAT.GroupsMembers.custom_field_2
      description: Groups Member Custom Field 2
      type: String
    - contextPath: KMSAT.GroupsMembers.custom_field_3
      description: Groups Member Custom Field 3
      type: String
    - contextPath: KMSAT.GroupsMembers.custom_field_4
      description: Groups Member Custom Field 4
      type: String
    - contextPath: KMSAT.GroupsMembers.custom_date_1
      description: Groups Member Custom Date 1
      type: Date
    - contextPath: KMSAT.GroupsMembers.custom_date_2
      description: Groups Member Custom Date 2
      type: Date
    description: Returns KMSAT Groups Members.
  - name: kmsat-users-risk-score-history-list
    arguments:
    - name: user_id
      required: true
      description: User ID
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.UsersRiskScoreHistory.risk_score
      description: Users Risk score and associated date
      type: Number
    - contextPath: KMSAT.UsersRiskScoreHistory.date
      description: Users Risk score history date
      type: Date
    description: Returns KMSAT User Specific Risk Score History
  - name: kmsat-phishing-security-tests-list
    arguments:
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.PhishingSecurity.campaign_id
      description: Phishing Security Campaign ID
      type: Number
    - contextPath: KMSAT.PhishingSecurity.pst_id
      description: Phishing Security PST ID
      type: Number
    - contextPath: KMSAT.PhishingSecurity.status
      description: Phishing Security Status
      type: String
    - contextPath: KMSAT.PhishingSecurity.name
      description: Phishing Security Name
      type: String
    - contextPath: KMSAT.PhishingSecurity.groups.group_id
      description: Phishing Security Group ID
      type: Number
    - contextPath: KMSAT.PhishingSecurity.groups.name
      description: Phishing Security Group Name
      type: String
    - contextPath: KMSAT.PhishingSecurity.phish_prone_percentage
      description: Phishing Security Phishing Prone Percent
      type: Number
    - contextPath: KMSAT.PhishingSecurity.started_at
      description: Phishing Security Started At Date
      type: Date
    - contextPath: KMSAT.PhishingSecurity.duration
      description: Phishing Security Duration
      type: Number
    - contextPath: KMSAT.PhishingSecurity.categories.category_id
      description: Phishing Security Category ID
      type: Number
    - contextPath: KMSAT.PhishingSecurity.categories.name
      description: Phishing Security Category Name
      type: String
    - contextPath: KMSAT.PhishingSecurity.template.id
      description: Phishing Security Template ID
      type: Number
    - contextPath: KMSAT.PhishingSecurity.template.name
      description: Phishing Security Template Name
      type: String
    - contextPath: KMSAT.PhishingSecurity.landing_page.id
      description: Phishing Security Landing Page ID
      type: Number
    - contextPath: KMSAT.PhishingSecurity.landing_page.name
      description: Phishing Security Landing Page Name
      type: String
    - contextPath: KMSAT.PhishingSecurity.scheduled_count
      description: Phishing Security Scheduled Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.delivered_count
      description: Phishing Security Delivered Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.opened_count
      description: Phishing Security Opened Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.clicked_count
      description: Phishing Security Clicked Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.replied_count
      description: Phishing Security Replied Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.attachment_open_count
      description: Phishing Security Attachment Open Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.macro_enabled_count
      description: Phishing Security Macro Enabled Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.data_entered_count
      description: Phishing Security Data Entered Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.qr_code_scanned_count
      description: Phishing Security QR Code Scanned Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.reported_count
      description: Phishing Security Reported Count
      type: Number
    - contextPath: KMSAT.PhishingSecurity.bounced_count
      description: Phishing Security Bounced Count
      type: Number
    description: Returns All Phishing Security Tests (PSTs)
  - name: kmsat-phishing-security-tests-recipients-list
    arguments:
    - name: pst_id
      required: true
      description: PST ID
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.PhishingSecurityPST.recipient_id
      description: Phishing Security Recipient ID
      type: Number
    - contextPath: KMSAT.PhishingSecurityPST.psd_id
      description: Phishing Security PST ID
      type: Number
    - contextPath: KMSAT.PhishingSecurityPST.user
      description: Phishing Security User
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.template
      description: Phishing Security Template
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.scheduled_at
      description: Phishing Security Scheduled At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.delivered_at
      description: Phishing Security Delivered At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.opened_at
      description: Phishing Security Opened At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.clicked_at
      description: Phishing Security Clicked At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.replied_at
      description: Phishing Security Replied At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.attachment_opened_at
      description: Phishing Security Attachment Opened At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.macro_enabled_at
      description: Phishing Security Macro Enabled At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.data_entered_at
      description: Phishing Security Date Entered At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.qr_code_scanned
      description: Phishing Security QR Scanned At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.reported_at
      description: Phishing Security Reported At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.bounced_at
      description: Phishing Security Bounced At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.ip
      description: Phishing Security IP
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.ip_location
      description: Phishing Security IP Location
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.browser
      description: Phishing Security Browser
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.browser_version
      description: Phishing Security Browser Security
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.os
      description: Phishing Security OS
      type: String
    description: Returns a Specific Recipient's Results.
  - name: kmsat-phishing-security-tests-failed-recipients-list
    arguments:
    - name: pst_id
      required: true
      description: PST ID
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.PhishingSecurityPST.recipient_id
      description: Phishing Security Recipient ID
      type: Number
    - contextPath: KMSAT.PhishingSecurityPST.psd_id
      description: Phishing Security PST ID
      type: Number
    - contextPath: KMSAT.PhishingSecurityPST.user
      description: Phishing Security User
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.template
      description: Phishing Security Template
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.scheduled_at
      description: Phishing Security Scheduled At
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.delivered_at
      description: Phishing Security Delivered At
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.opened_at
      description: Phishing Security Opened At
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.clicked_at
      description: Phishing Security Clicked At
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.replied_at
      description: Phishing Security Replied At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.attachment_opened_at
      description: Phishing Security Attachment Opened At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.macro_enabled_at
      description: Phishing Security Macro Enabled At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.data_entered_at
      description: Phishing Security Date Entered At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.qr_code_scanned
      description: Phishing Security QR Scanned At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.reported_at
      description: Phishing Security Reported At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.bounced_at
      description: Phishing Security Bounced At
      type: Date
    - contextPath: KMSAT.PhishingSecurityPST.ip
      description: Phishing Security IP
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.ip_location
      description: Phishing Security IP Location
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.browser
      description: Phishing Security Browser
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.browser_version
      description: Phishing Security Browser Security
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.os
      description: Phishing Security OS
      type: String
    - contextPath: KMSAT.PhishingSecurityPST.meta.paging_end
      description: Phishing Security Meta Page End
      type: Boolean
    - contextPath: KMSAT.PhishingSecurityPST.meta.filtered_items_in_page
      description: Phishing Security Meta Filtered Items
      type: Number
    - contextPath: KMSAT.PhishingSecurityPST.meta.items_total
      description: Phishing Security Meta Items Total
      type: Number
    description: Returns a Specific Failed Recipient's Results.
  - name: kmsat-phishing-campaigns-security-tests-list
    arguments:
    - name: campaign_id
      required: true
      description: Campaign ID
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.CampaignPST.campaign_id
      description: Campaign Phishing Security Campaign ID
      type: Number
    - contextPath: KMSAT.CampaignPST.pst_id
      description: Campaign Phishing Security PST ID
      type: Number
    - contextPath: KMSAT.CampaignPST.status
      description: Campaign Phishing Security Status
      type: String
    - contextPath: KMSAT.CampaignPST.name
      description: Campaign Phishing Security Name
      type: String
    - contextPath: KMSAT.CampaignPST.groups.group_id
      description: Campaign Phishing Security Group ID
      type: Number
    - contextPath: KMSAT.CampaignPST.groups.name
      description: Campaign Phishing Security Name
      type: String
    - contextPath: KMSAT.CampaignPST.phish_prone_percentage
      description: Campaign Phishing Security Phish Prone Percentage
      type: Number
    - contextPath: KMSAT.CampaignPST.started_at
      description: Campaign Phishing Security Started At
      type: Date
    - contextPath: KMSAT.CampaignPST.duration
      description: Campaign Phishing Security Duration
      type: Number
    - contextPath: KMSAT.CampaignPST.categories.category_id
      description: Campaign Phishing Security Categories Category ID
      type: Number
    - contextPath: KMSAT.CampaignPST.categories.name
      description: Campaign Phishing Security Categories Name
      type: String
    - contextPath: KMSAT.CampaignPST.template.id
      description: Campaign Phishing Security Template ID
      type: Number
    - contextPath: KMSAT.CampaignPST.template.name
      description: Campaign Phishing Security Template Name
      type: String
    - contextPath: KMSAT.CampaignPST.landing_page.id
      description: Campaign Phishing Security Landing Page ID
      type: Number
    - contextPath: KMSAT.CampaignPST.landing_page.name
      description: Campaign Phishing Security Landing Page Name
      type: String
    - contextPath: KMSAT.CampaignPST.scheduled_count
      description: Campaign Phishing Security Scheduled Count
      type: Number
    - contextPath: KMSAT.CampaignPST.delivered_count
      description: Campaign Phishing Security Delivered Count
      type: Number
    - contextPath: KMSAT.CampaignPST.opened_count
      description: Campaign Phishing Security Opened Count
      type: Number
    - contextPath: KMSAT.CampaignPST.clicked_count
      description: Campaign Phishing Security Clicked Count
      type: Number
    - contextPath: KMSAT.CampaignPST.replied_count
      description: Campaign Phishing Security Replied Count
      type: Number
    - contextPath: KMSAT.CampaignPST.attachment_open_count
      description: Campaign Phishing Security Attachment Open Count
      type: Number
    - contextPath: KMSAT.CampaignPST.macro_enabled_count
      description: Campaign Phishing Security Macro Enabled Count
      type: Number
    - contextPath: KMSAT.CampaignPST.data_entered_count
      description: Campaign Phishing Security Data Entered Count
      type: Number
    - contextPath: KMSAT.CampaignPST.qr_code_scanned_count
      description: Campaign Phishing Security QR Code Scanned Count
      type: Number
    - contextPath: KMSAT.CampaignPST.reported_count
      description: Campaign Phishing Security Reported Count
      type: Number
    - contextPath: KMSAT.CampaignPST.bounced_count
      description: Campaign Phishing Security Bounced Count
      type: Number
    description: Returns All Campaign Phishing Security Tests (PSTs).
  - name: kmsat-training-campaigns-list
    arguments:
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.TrainingCampaigns.campaign_id
      description: Training Campaigns Campaign ID
      type: Number
    - contextPath: KMSAT.TrainingCampaigns.name
      description: Training Campaigns Name
      type: String
    - contextPath: KMSAT.TrainingCampaigns.groups.group_id
      description: Training Campaigns Groups ID
      type: Number
    - contextPath: KMSAT.TrainingCampaigns.groups.name
      description: "raining Campaigns Groups Name"
      type: String
    - contextPath: KMSAT.TrainingCampaigns.status
      description: Training Campaigns Status
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.store_purchase_id
      description: Training Campaigns Content Store Purchase ID
      type: Number
    - contextPath: KMSAT.TrainingCampaigns.content.content_type
      description: Training Campaigns Content Type
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.name
      description: Training Campaigns Content Name
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.description
      description: Training Campaigns Content Description
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.type
      description: Training Campaigns Type
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.duration
      description: Training Campaigns Duration
      type: Number
    - contextPath: KMSAT.TrainingCampaigns.content.retired
      description: Training Campaigns Retired
      type: Boolean
    - contextPath: KMSAT.TrainingCampaigns.content.retirement_date
      description: Training Campaigns Retirement Date
      type: Date
    - contextPath: KMSAT.TrainingCampaigns.content.publish_date
      description: Training Campaigns Publish Date
      type: Date
    - contextPath: KMSAT.TrainingCampaigns.content.publisher
      description: Training Campaigns Publisher
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.purchase_date
      description: Training Campaigns Purchase Date
      type: Date
    - contextPath: KMSAT.TrainingCampaigns.content.policy_url
      description: Training Campaigns Policy URL
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.policy_id
      description: Training Campaigns Policy ID
      type: Number
    - contextPath: KMSAT.TrainingCampaigns.content.minimum_time
      description: Training Campaigns Minimum Time
      type: Number
    - contextPath: KMSAT.TrainingCampaigns.content.default_language
      description: Training Campaigns Default Language
      type: String
    - contextPath: KMSAT.TrainingCampaigns.content.published
      description: Training Campaigns Published
      type: Boolean
    - contextPath: KMSAT.TrainingCampaigns.duration_type
      description: Training Campaigns Duration Type
      type: String
    - contextPath: KMSAT.TrainingCampaigns.start_date
      description: Training Campaigns Start Date
      type: Date
    - contextPath: KMSAT.TrainingCampaigns.end_date
      description: Training Campaigns  End Date
      type: Date
    - contextPath: KMSAT.TrainingCampaigns.relative_duration
      description: Training Campaigns Relative Duration
      type: String
    - contextPath: KMSAT.TrainingCampaigns.auto_enroll
      description: Training Campaigns Auto Enroll
      type: Boolean
    - contextPath: KMSAT.TrainingCampaigns.allow_multiple_enrollments
      description: Training Campaigns Allow Multiple Enrollments
      type: Boolean
    - contextPath: KMSAT.TrainingCampaigns.completion_percentage
      description: Training Campaigns Completion Percentage
      type: Number
    description: Returns All Training Campaigns.
  - name: kmsat-training-enrollments-list
    arguments:
    - name: status
      description: Status
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.TrainingEnrollments.data.enrollment_id
      description: Training Enrollments Enrollment ID
      type: Number
    - contextPath: KMSAT.TrainingEnrollments.data.content_type
      description: Training Enrollments Content Type
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.module_name
      description: Training Enrollments Module Name
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.user.id
      description: Training Enrollments User ID
      type: Number
    - contextPath: KMSAT.TrainingEnrollments.data.user.first_name
      description: Training Enrollments User First Name
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.user.last_name
      description: Training Enrollments Last Name
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.user.email
      description: Training Enrollments User Email
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.campaign_name
      description: Training Enrollments Campaign Name
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.enrollment_date
      description: Training Enrollments Enrollment Date
      type: Date
    - contextPath: KMSAT.TrainingEnrollments.data.start_date
      description: Training Enrollments Start Date
      type: Date
    - contextPath: KMSAT.TrainingEnrollments.data.completion_date
      description: Training Enrollments Completion Date
      type: Date
    - contextPath: KMSAT.TrainingEnrollments.data.status
      description: Training Enrollments Status
      type: String
    - contextPath: KMSAT.TrainingEnrollments.data.time_spent
      description: Training Enrollments Time Spent
      type: Number
    - contextPath: KMSAT.TrainingEnrollments.data.policy_acknowledged
      description: Training Enrollments Policy Acknowledged
      type: Boolean
    - contextPath: KMSAT.TrainingEnrollments.meta.paging_end
      description: Training Enrollments Meta Page End
      type: Boolean
    - contextPath: KMSAT.TrainingEnrollments.meta.filtered_items_in_page
      description: Training Enrollments Meta Filtered Items
      type: Number
    - contextPath: KMSAT.TrainingEnrollments.meta.items_total
      description: Training Enrollments Meta Items Total
      type: Number
    description: Returns all Training Enrollments
  - name: kmsat-user-events-list
    arguments:
    - name: event_type
      description: Filter by Event Type
    - name: target_user
      description: Filter by User
    - name: external_id
      description: Filter by External ID
    - name: source
      description: Filter by Source
    - name: occurred_date
      description: Filter by Occurred Date (YYYY-MM-DD)
    - name: risk_level
      description: Filter by Risk Level by entering a value from -10 (low risk) to 10 (high risk).
      auto: PREDEFINED
      predefined:
      - "-10"
      - "-9"
      - "-8"
      - "-7"
      - "-6"
      - "-5"
      - "-4"
      - "-3"
      - "-2"
      - "-1"
      - "-0"
      - "1"
      - "2"
      - "3"
      - "4"
      - "5"
      - "6"
      - "7"
      - "8"
      - "9"
      - "10"
    - name: risk_decay_mode
      description: Filter by Risk Decay Mode by entering a value of 0 or 1
      auto: PREDEFINED
      predefined:
      - "0"
      - "1"
    - name: risk_expire_date
      description: Filter by Risk Expire Date (YYYY-MM-DD)
    - name: order_by
      description: Order returned events by ID, Event Type, or Occurred Date ("id", "event_type", "occurred_date")
    - name: order_direction
      description: Order returned events in ascending (asc) or descending (desc) order ("asc", "desc")
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    outputs:
    - contextPath: KMSAT.UserEvents.id
      description: "Unique ID of the event"
      type: Number
    - contextPath: KMSAT.UserEvents.user.email
      description: "User email address"
      type: String
    - contextPath: KMSAT.UserEvents.user.id
      description: "User ID"
      type: Number
    - contextPath: KMSAT.UserEvents.user.archived
      description: "User Archived flag"
      type: Boolean
    - contextPath: KMSAT.UserEvents.external_id
      description: "External ID of the event"
      type: String
    - contextPath: KMSAT.UserEvents.source
      description: "Source of the event"
      type: String
    - contextPath: KMSAT.UserEvents.description
      description: "Description of the event"
      type: String
    - contextPath: KMSAT.UserEvents.occurred_date
      description: "When the event occurred"
      type: Date
    - contextPath: KMSAT.UserEvents.risk.level
      description: "Risk Level of the event"
      type: Number
    - contextPath: KMSAT.UserEvents.risk.factor
      description: "Risk Factor of the event"
      type: Number
    - contextPath: KMSAT.UserEvents.risk.decay_mode
      description: "The Risk Level Decay Mode"
      type: String
    - contextPath: KMSAT.UserEvents.risk.expire_date
      description: "Risk Expire Date"
      type: String
    - contextPath: KMSAT.UserEvents.event_type.id
      description: "Event Type ID"
      type: Number
    - contextPath: KMSAT.UserEvents.event_type.name
      description: "Event Type Name"
      type: String
    description: Returns all KMSAT User Events.
  - name: kmsat-user-event-list
    arguments:
    - name: id
      required: true
      description: event ID
    outputs:
    - contextPath: KMSAT.UserEvent.id
      description: "Unique ID of the event"
      type: Number
    - contextPath: KMSAT.UserEvent.user.email
      description: "User email address"
      type: String
    - contextPath: KMSAT.UserEvent.user.id
      description: "User ID"
      type: Number
    - contextPath: KMSAT.UserEvent.user.archived
      description: "User Archived flag"
      type: Boolean
    - contextPath: KMSAT.UserEvent.external_id
      description: "External ID of the event"
      type: String
    - contextPath: KMSAT.UserEvent.source
      description: "Source of the event"
      type: String
    - contextPath: KMSAT.UserEvent.description
      description: "Description of the event"
      type: String
    - contextPath: KMSAT.UserEvent.occurred_date
      description: "When the event occurred"
      type: Date
    - contextPath: KMSAT.UserEvent.risk.level
      description: "Risk Level of the event"
      type: Number
    - contextPath: KMSAT.UserEvent.risk.factor
      description: "Risk Factor of the event"
      type: Number
    - contextPath: KMSAT.UserEvent.risk.decay_mode
      description: "The Risk Level Decay Mode"
      type: String
    - contextPath: KMSAT.UserEvent.risk.expire_date
      description: "Risk Expire Date"
      type: String
    - contextPath: KMSAT.UserEvent.event_type.id
      description: "Event Type ID"
      type: Number
    - contextPath: KMSAT.UserEvent.event_type.name
      description: "Event Type Name"
      type: String
    description: Returns a KMSAT User Event.
  - name: kmsat-user-event-types-list
    arguments:
    - name: name
      description: Filter by name of the event type
    outputs:
    - contextPath: KMSAT.UserEventTypes.id
      description: "ID of the Event Type"
      type: Number
    - contextPath: KMSAT.UserEventTypes.account_id
      description: "Account ID"
      type: Number
    - contextPath: KMSAT.UserEventTypes.name
      description: "Name of the Event Type"
      type: String
    - contextPath: KMSAT.UserEventTypes.description
      description: "Description of Event Type"
      type: String
    description: Returns all KMSAT User Event Types
  - name: kmsat-user-event-create
    arguments:
    - name: target_user
      description: User's email address
      required: true
    - name: event_type
      description: If the event type does not already exist, the value entered here will be used to create a new event type.
      required: true
    - name: external_id
      description: Include a custom External ID.
    - name: source
      description: Include a custom Source
    - name: description
      description: Description of the Event
    - name: occurred_date
      description: (YYYY-MM-DD) If a date is not set, this field will default to the current time (UTC).
    - name: risk_level
      description: Assign a value from -10 (low risk) to 10 (high risk).
      auto: PREDEFINED
      predefined:
      - "-10"
      - "-9"
      - "-8"
      - "-7"
      - "-6"
      - "-5"
      - "-4"
      - "-3"
      - "-2"
      - "-1"
      - "-0"
      - "1"
      - "2"
      - "3"
      - "4"
      - "5"
      - "6"
      - "7"
      - "8"
      - "9"
      - "10"
    - name: risk_decay_mode
      auto: PREDEFINED
      description: Assign a value of 0 or 1.
      predefined:
      - "0"
      - "1"
    - name: risk_expire_date
      description: (YYYY-MM-DD) If a date is not set, this field will default to the occurred_date plus one (1) month.
    outputs:
    - contextPath: KMSAT.UserEventCreate.id
      description: "Unique ID of the event"
      type: Number
    description: Adds a User Event
  - name: kmsat-user-event-delete
    arguments:
    - name: id
      description: Event ID
      required: true
    description: Deletes User Event by Event ID
  - name: kmsat-user-event-status-list
    arguments:
    - name: id
      description: Request Event ID from kmsat-user-event-create
      required: true
    outputs:
    - contextPath: KMSAT.UserEventStatus.id
      description: "ID of the Event Type"
      type: Number
    - contextPath: KMSAT.UserEventTypes.details
      description: "Details of event request including event id and any failures"
      type: Object
    - contextPath: KMSAT.UserEventTypes.details.events
      description: "list of event ids"
      type: Array
    - contextPath: KMSAT.UserEventTypes.details.failures
      description: "list of failures"
      type: Array
    - contextPath: KMSAT.UserEventTypes.processed
      description: "date the event was processed"
      type: Date
    - contextPath: KMSAT.UserEventTypes.api_key
      description: "api key name of the request"
      type: String
    description: returns the status of the User Event request
  - name: kmsat-user-event-statuses-list
    arguments:
    - name: processed
      description: The date and time the API request was processed.
    - name: page
      required: true
      description: Page Number
    - name: per_page
      description: Per Page Amount
    description: returns the status of the User Event request
  runonce: false
  script: "-"
  type: python
  subtype: python3
  dockerimage: demisto/python3:3.10.10.48392
fromversion: 6.5.0
tests:
- No tests (auto formatted)