Custom API Action
KnowBe4 APIに対して認証済みHTTPリクエストを行います。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request Type(リクエストタイプ) |
カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです(「HTTPリクエストメソッド」を参照)。
|
ドロップダウン |
正 |
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request(リクエスト) |
|||
Relative URL(相対URL) |
呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。 「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。 たとえば、KnowBe4レポートAPIエンドポイントがhttps://{region}.api.knowbe4.com/v1/users/{user_id}であれば、/v1/users/{user_id}が相対URLです。 |
テキスト |
TRUE |
Query(クエリ) |
含める追加のクエリパラメーターをオブジェクト形式(キーと値のペア)で指定します。 例:{"name":"something-urgent"} |
オブジェクト |
誤 |
Headers(ヘッダー) |
承認またはコンテンツタイプ(これらはすでにコネクターが対応しています)以外に必要な任意のヘッダーを指定します。 例:{"Content-type":"application/json"} |
オブジェクト |
誤 |
Body(本文) |
リクエストボディーをJSON形式で指定します。 このフィールドはGETリクエストタイプには使用できません。 |
オブジェクト |
誤 |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) |
||
Status Code(ステータスコード) |
操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
Headers(ヘッダー) |
出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 |
オブジェクト |
Body(本文) |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
オブジェクト |