コンテンツにスキップ

Taegis で関数を定義する🔗

コネクター定義は、プレイブックタスクとして呼び出せる関数を公開します。以下のフィールドは、コネクター関数を作成する際に使用されます。例については、Secureworks® Taegis™ XDR のライブラリからコネクターをエクスポートすることで確認できます。

ヒント

コネクターを構築する際、コネクター作成をより便利にするためにいくつかのデフォルトコネクタ変数を利用できます：

  • ${TDR.API} — Taegis のAPI URL。
  • ${TDR.URL} — Taegis のポータルURL。
  • ${TDR.tenant} — コネクター実行時のテナントID。
  • ${TDR.user} — コネクター/アクションをトリガーしたユーザーID。
  • ${body} — レスポンスボディ。これは出力でのみ使用可能です。
  • ${headers} — レスポンスヘッダーのリスト。これは出力でのみ使用可能です。
  • ${status.code} — レスポンスステータス（HTTP）コード。これは出力でのみ使用可能です。
  • ${status.message} — レスポンスメッセージ。これは出力でのみ使用可能です。

name🔗

関数の名前を定義します。コネクター内で一意である必要があります。関数名にはスペースやアンダースコア（_）およびピリオド（.）以外の特殊文字を含めないでください。

デフォルト値— 該当なし

データ型— string

このフィールドはコネクタービルダーで公開されます。

description🔗

関数の説明に使用します。これはドキュメント用のフィールドではなく、関数の目的を明確に示す1～2文の短い説明です。

推奨値— 関数の目的を明確に示す1～2文

データ型— string

このフィールドはコネクタービルダーで公開されます。

inputs🔗

関数が動作するために必要な入力をコネクター作成者が定義できます。値は入力の構造を定義するJSONスキーマです。プレイブック作成者としては、ここで定義された入力がプレイブックのステップとしてこの関数を追加する際に表示されます。

デフォルト値— 該当なし

データ型— string（JSONスキーマ）

このフィールドはコネクタービルダーで公開されます。

outputs🔗

関数が生成する出力をコネクター作成者が定義できます。フォーマットは出力の構造を定義するJSONスキーマです。プレイブック作成者としては、ここで定義された出力がプレイブックのステップとしてこの関数を追加する際に表示されます。

デフォルト値— 該当なし

データ型— string（JSONスキーマ）

このフィールドはコネクタービルダーで公開されます。

config🔗

関数の設定を含むオブジェクトです。

デフォルト値— 該当なし

データ型— object/map

config自体はコネクタービルダーで公開されませんが、以下に示す個々の設定フィールドは公開されます：

contentType🔗

リクエストのHTTPコンテンツタイプ値。

デフォルト値— application/json

データ型— string

このフィールドはコネクタービルダーで公開されます。

method🔗

リクエストのHTTPメソッド値。

デフォルト値— GET, POST, DELETE, PUT, または PATCH

データ型— string

このフィールドはコネクタービルダーで公開されます。

body🔗

リクエストのHTTPボディ値。queryフィールドが定義されている場合はこのフィールドを設定しないでください。

デフォルト値— 該当なし

データ型— object/map

このフィールドはコネクタービルダーで公開されます。

outputs🔗

関数の出力値をコネクター作成者が定義できます。出力の構造は関数で定義されたJSONスキーマと一致する必要があります。

デフォルト値— outputsのJSONスキーマと一致する必要あり

データ型— object/map

このフィールドはコネクタービルダーで公開されます。

url🔗

HTTPリクエストのフルURL。

デフォルト値— 該当なし

データ型— string

このフィールドはコネクタービルダーで公開されます。

query🔗

リクエストのgraphqlクエリ/ミューテーション。

デフォルト値— 該当なし

データ型— string

このフィールドはコネクタービルダーで公開されません。

headers🔗

リクエストのHTTPヘッダー値。

デフォルト値— nameとvalueキーで名前/値のペアを設定するオブジェクトのリスト

データ型— array

このフィールドはコネクタービルダーで公開されます。

error🔗

関数が失敗した場合にエラーを定義できます。nullまたは空値の場合、オートメーションエンジンは関数が成功したとみなします。null以外/空でない値の場合、関数は失敗し、指定した値がエラーとして表示されます。

デフォルト値— 該当なし

データ型— string

このフィールドはコネクタービルダーで公開されます。

variables🔗

graphqlクエリ/ミューテーション用の変数をコネクター作成者が設定できます。変数はキー/値のペアとして定義します。このフィールドはqueryフィールドが定義されている場合のみ設定してください。

デフォルト値— 該当なし

データ型— object/map

このフィールドはコネクタービルダーで公開されません。