KnowBe4のレポートAPI（アプリケーションプログラミングインターフェース）機能は、プラチナおよびダイヤモンドレベルのサブスクリプションを契約されているお客様のみが利用でき、レポートを作成するためにKSATコンソールからデータを取得できるようにします。現在、この機能はフィッシング、トレーニング、ユーザー、グループデータをリクエストするためにのみ使用できます。このAPIを使用する場合には、アカウント固有のキーを使ってAPIに認証する必要があります。

レポートAPIの詳細およびサンプルのリクエストについては、「レポートAPIの開発者向けドキュメント」を参照してください。KnowBe4のAPIは、REST APIです。KnowBe4のAPIを使用することにより、利用規約に同意したものとみなされます。

レポートAPIトークンの作成

レポートAPIトークンを作成するには、以下のステップに従って操作します。

1. KSATコンソールのページの右上隅のメールアドレスをクリックし、[アカウント設定]を選択します。
2. [アカウント統合] > [API]に移動します。
3. [レポートAPI]の下にある[レポートAPIアクセスを有効化]トグルボタンを選択します。
4. [レポートAPI]をクリックします。[レポートAPI]サブタブが開きます。
5. [レポートAPI]サブタブの右上にある[+ APIトークンの新規作成]をクリックします。
6. [APIトークンの新規作成]ページのフィールドに情報を入力します。詳細については、以下のスクリーンショットとリストを参照してください。
   1. [名前]：このフィールドに、このAPIトークンをわかりやすく説明する名前を入力します。
   2. [ステータス]：APIトークンを有効または無効にします。
   
7. [トークンの作成]をクリックします。[レポートAPIトークン]ポップアップウィンドウが開きます。
8. レポートAPIトークンをクリックして、トークンをコピーします。コピーしたAPIトークンは、簡単にアクセスできる場所に保存してください。このウィンドウを閉じると、このトークンを再度表示することはできません。
9. [OK]をクリックします。

コピーが完了したら、このAPIトークンを使用して、KSATコンソールからデータを取得してレポートを作成できます。

レポートAPIトークンの管理

レポートAPIトークンを作成すると、[レポートAPI]サブタブでトークンを管理できます。このサブタブは、[アカウント設定]ページの[アカウント統合]セクションからアクセスできます。

このサブタブで利用できるオプションの詳細については、以下を参照してください。

1. [キー]：この列には、組織のKSATコンソールに関連付けられたAPIリクエストを認証するために使用される一意の識別子が表示されます。
2. [名前]：この列には、APIトークンを作成した際に割り当てたカスタム名が表示されます。
3. [生成したユーザー]：この列には、APIトークンを生成したユーザーに関連付けられているメールアドレスが表示されます。
4. [生成日時]：この列には、レポートAPI トークンが生成された日付が表示されます。
5. [ステータス]：この列には、APIトークンのステータスが表示されます。ステータスは有効または無効になります。
6. [アクション]：右端の列のドロップダウン矢印をクリックすると、レポートAPIトークンで利用可能なアクションが表示されます。表示されるアクションは以下の通りです。
   • 編集：[編集]をクリックすると、[レポートAPIトークンの編集]ページが開きます。このページは、[APIトークンの新規作成]ページに似ています。必要に応じてオプションを編集し、[トークンのアップデート]をクリックして変更を保存します。
   • [削除]：[削除]をクリックすると、レポートAPI トークンが永久に削除されます。