{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"KnowBe4 Security Awareness Provider Configuration Guide","siteUrl":"https://docs.synqly.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":0},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["KnowBe4 Security Awareness Training (KSAT) is a security awareness training platform designed to train and test employees through simulated social engineering attacks such as phishing. This guide walks you through the steps to gather the necessary information and configure your KSAT account for the purpose of creating a security awareness integration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin, ensure that you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to the KnowBe4 console."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to a KnowBe4 user account with administrator permissions for the account you are integrating."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Knowledge of the region hosting your KnowBe4 instance."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-api-token-permissions","__idx":2},"children":["Required API Token Permissions"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Due to restrictions on the KnowBe4 KSAT Graph API, a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["KnowBe4 Diamond or SAT Advanced subscription type is required to create a security awareness integration"]},"."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Product"},"children":["Product"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scopes"},"children":["Scopes"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["KSAT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read Only"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read data about phishing campaigns, phishing simulation tests, and users"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"generating-api-credentials","__idx":3},"children":["Generating API Credentials"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to the KnowBe4 console with a user account that has administrator permissions for the account you are integrating."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on your email address on the top right of the page, then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account Integrations > API"]}," from the sidebar on the left."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the section titled ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Product API"]},", ensure that the slider titled ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["KSAT Graph API Access"]}," is enabled. Click on the slider if it is not enabled."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the link titled ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Product API"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the tab titled ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Product API"]},", click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+ Create New API Token"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fill in the field titled ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Name"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the field titled ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Products"]},", select the required products and scopes listed under ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#required-api-token-permissions"},"children":["Required API Token Permissions"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the field titled ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Expiration Date"]},", select an expiration date for this token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the dropdown titled ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["User"]},", select the user responsible for managing this API token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Token"]},", take note of the value displayed, and store it in a safe location."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OK"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have now created a new KnowBe4 Product API Token. Proceed to the next section, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#configuring-the-integration"},"children":["Configuring the Integration"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on creating and managing KnowBe4 Product API Tokens, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://support.knowbe4.com/hc/en-us/articles/10495383627155-Product-API-Overview"},"children":["KnowBe4 Product API Overview"]}," knowledge base article."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuring-the-integration","__idx":4},"children":["Configuring the Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To configure a new KnowBe4 Security Awareness Training (KSAT) Security Awareness integration, provide each of the values as defined below:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Integration Parameter"},"children":["Integration Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Secret"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This is the Product API Token value generated in the steps above."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Region"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The region hosting your KnowBe4 instance. This value can be determined by the URL you use to log in. For help determining the proper region to select, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://support.knowbe4.com/hc/en-us/articles/360043196354-Learner-Support-KnowBe4-s-Training-Instances-and-Login-Links"},"children":["KnowBe4 Learner Support Troubleshooting"]}," knowledge base article."]}]}]}]}]}]},"headings":[{"value":"Introduction","id":"introduction","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Required API Token Permissions","id":"required-api-token-permissions","depth":2},{"value":"Generating API Credentials","id":"generating-api-credentials","depth":2},{"value":"Configuring the Integration","id":"configuring-the-integration","depth":2}],"frontmatter":{"slug":"guides/provider-configuration/knowbe4-securityawareness-setup","seo":{"title":"KnowBe4 Security Awareness Provider Configuration Guide"}},"lastModified":"2026-09-09T19:13:02.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/provider-configuration/knowbe4-securityawareness-setup","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}