使用 KnowBe4 的报告 Application Programming Interface (API) 功能(仅限铂金级和钻石级客户),您可从 KSAT 控制台中提取数据以作报告之用。目前,此功能仅用于对网络钓鱼、培训、用户和群组数据提出请求。使用此 API 时,您必须使用账户特定密钥对 API 进行身份验证。
有关报告 API 以及示例请求的完整详情,请访问文档报告 API 开发者。KnowBe4 的 API 属于 REST API。使用 KnowBe4 的 API,即表示您同意我们的使用条款。
注意:如果您启用了启用报告 API 中的风险得分 v2 复选框,您的风险得分端点将采用新计算所得的数据。有关更多信息,请参阅账户设置指南。
创建报告 API 令牌
要创建报告 API 令牌,请按照以下步骤操作:
- 登录您的 KSAT 控制台,单击页面右上角的电子邮件地址并选择账户设置。
- 前往帐户集成 > API。
- 在报告 API 下方,选择启用报告 API 访问权限切换开关。
- 单击报告 API。打开报告 API 子选项卡。
- 在报告 API 子选项卡的右上角,单击 + 新建 API 令牌。
- 填写新建 API 令牌页面中的字段。有关更多信息,请查看以下截图和列表:
- 名称:在此字段中,为此 API 令牌输入描述性名称。
- 状态:启用或禁用 API 令牌。
- 单击创建令牌。打开报告 API 令牌弹出窗口。
- 单击报告 API 令牌,可复制该令牌。务必将已复制的 API 令牌保存在易于访问的位置。一旦关闭该窗口,则无法再次查看该令牌。
- 单击确定。
复制完后,即可使用 API 令牌从 KSAT 控制台中提取数据以作报告之用。
管理报告 API 令牌
创建完报告 API 令牌后,即可在报告 API 子选项卡上管理该令牌。前往账户设置页面的账户集成部分,即可访问该子选项卡。
注意:创建完报告 API 令牌后,您只能查看这些令牌的最后 10 位数字。如果丢失令牌,则须创建一个新的令牌。
- 密钥:此列会显示一个唯一标识符,用于对与 KSAT 控制台关联的 API 请求进行身份验证
- 名称:此列会显示您在创建 API 令牌时所指定的自定义名称。
- 生成者:此列会显示与生成 API 令牌的用户关联的电子邮件地址。
- 生成时间:此列会显示报告 API 令牌生成的日期。
- 状态:此列会显示 API 令牌的状态。可以启用或禁用该状态。
-
操作:单击最右一列的下拉箭头,查看报告 API 令牌的可用操作。这些操作包括:
- 编辑:单击编辑,可打开编辑报告 API 令牌页面,该页面与新建 API 令牌页面相似。根据需要编辑各个选项,然后单击更新令牌并保存更改。
- 删除:单击删除,可永久删除报告 API 令牌。