Custom API Action

Trend Micro Accounts APIに対して認証済みHTTPリクエストを行います。

オプション

フィールド 定義 タイプ 必須
Request Type（リクエストタイプ）

［Request Type（リクエストタイプ）］（ドロップダウン）：カスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です（「HTTPリクエストメソッド」を参照）。

  • GET - パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージを受信します。

  • POST - パラメーターに基づいてWebサーバーにデータを送信します（例えば、ファイルのアップロード）。複数のPOSTリクエストは1つのPOSTと異なる結果になる場合があるため、意図せずに複数のPOSTリクエストを送信することについて注意が必要です。リクエストが成功した場合、200 (OK)レスポンスメッセージを受信します。

  • PUT - パラメーターに基づいてWebサーバーの特定の場所に格納されるデータを送信します（例えば、ファイルのアップロード）。PUTおよびPOSTリクエストの違いはPUTが冪等であるということです。つまり、リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)、201 (Created)、または204 (No Content)レスポンスメッセージを受信します。

  • PATCH - パラメーターに基づいてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。つまり、複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200（OK）または204（No Content）レスポンスメッセージが返されます。

  • DELETE - パラメーターに基づいてWebサーバーから指定されたリソースを削除します（リソースが存在する場合）。DELETEが成功した場合、200 (OK)レスポンスメッセージを受信します。

 ドロップダウン TRUE

入力

フィールド 定義 タイプ 必須
Request（リクエスト）
Relative URL（相対URL）

呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。

「?」を使用して相対URL内にクエリパラメーターを指定したり、［Query（クエリ）］入力内のキーと値のペアとしてクエリパラメーターを指定したりすることができます。

Accounts APIのみが許可されます。一般的なパスのプレフィックス/v3.0/iamの後にパスを入力します。

例えば、Trend Micro Accounts API Endpoint /v3.0/iam/accountsの場合、［Relative URL（相対URL）］の入力は/accountsとなります。

 テキスト TRUE
Headers（ヘッダー）

すでにコネクターが対応しているAuthorizationまたはContent-Type以外の必要なヘッダーを指定します。

例：{ "TMV1-Filter": "status eq 'enabled'" }

 オブジェクト FALSE
Query（クエリ）

含める追加のクエリパラメーターをオブジェクト形式でキー/値ペアとして指定します。

例：{ "top": 50 }

 オブジェクト FALSE
Body（本文）

リクエストボディーをJSON形式で指定します。GETリクエストには使用できません。

 オブジェクト FALSE

出力

フィールド 定義 タイプ

Response （レスポンス）

Status Code（ステータスコード）

操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例：

  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

 数値

Headers（ヘッダー）

出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。

 オブジェクト

Body（本文）

選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

 オブジェクト