In your KSAT console, you can create Product application programming interface (API) tokens for other KnowBe4 products. These API tokens allow you to connect KSAT with your other tools or platforms, such as PhishER. For example, when KSAT and PhishER are connected, you can authenticate your KnowBe4 account when you make an API request.
Creating a Product API Token
To create a Product API token, follow the steps below:
- From your KSAT console, click your email address at the top-right corner of the page and select Account Settings.
- Navigate to Account Integrations > API.
- Under Product API, click Product API. The Product API subtab will open.
- At the top-right corner of the Product API subtab, click + Create New API Token.
- Fill out the fields on the Create New API Token page. For more information, see the screenshot and list below:
- Name: In this field, enter a descriptive name for this API token.
- Products: Select the product you'll use for this API token.
- Scopes: This field will only appear if you select KSAT or SecurityCoach. Select whether you want your users to have Read Only access, or the ability to make edits with the Read/Write permission.
- Expiration Date: Select the date when the API token should expire. When this token expires, KSAT will not be able to send data to the product. To continue sending data to the product, you’ll need to create a new API token.
- User: In this drop-down menu, select the user responsible for managing this API token. For example, you could select a user who has administrator access to the product.
- Status: Enable or disable the API token.
- Click Create Token. The Product API Token pop-up window will open.
- Click the Product API token to copy the token. Make sure to save your copied API token somewhere that you can easily access. After you close this window, you will not be able to view this token again.
- Click OK.
Once copied, you can use the API token to set up a connection in your other KnowBe4 products. For more information, see the articles listed below:
- How to Integrate KnowBe4's KSAT Console with KCM GRC
- KnowBe4 Graph API Overview
- Password IQ Product Manual
Managing Product API Tokens
Once you have created a Product API token, you can manage the token on the Product API subtab. You can access this subtab from the Account Integrations section of your Account Settings page.
To learn more about the options available on this subtab, see below:
- Key: This column displays a unique identifier used to authenticate an API request associated with your KSAT console.
- Name: This column displays the custom name you assigned to your API token when it was created.
- Product: This column displays the product that can be connected to the KSAT console using your API token.
- User: This column displays the user assigned to manage this API token.
- Expiration Date: This column displays the date your API token will expire. When this token expires, KSAT will not be able to send data to the product. To continue sending data to the product, you’ll need to create a new API token.
- Status: This column displays the API token’s status. The status can be enabled or disabled.
-
Actions: Click the drop-down arrow in the rightmost column to view the available actions for a Product API token. These actions include:
- Edit: Click Edit to open the Edit Product API Token page, which is similar to the Create New API Token page. Edit options as needed, then click Update Token to save your changes.
- Delete: Click Delete to permanently delete a Product API token.