コネクター定義言語🔗
コネクター定義はYAMLで記述され、コネクターのプロパティ、関数マッピング、およびドキュメントを記述します。定義には、コネクターに必要なすべての詳細（メタデータ、入力、アクション）が含まれます。
現在サポートされているフィールドは以下の通りです。
注意
薄いグレーで表示されている項目はコネクタービルダーでは表示されませんが、YAML内で自動的に入力され、プラットフォーム外でエクスポートした定義を編集する際には表示され、必須となります。
apiVersion🔗
このフィールドは、Secureworksがこの定義をサポートする最初のAPIバージョンを示すためにのみ使用します。
デフォルト値— v0.0.1
データ型— string
このフィールドはコネクタービルダーでは表示されません。Secureworks専用です。
kind🔗
定義ファイルの種類を定義します。コネクターの場合、この値は常に Connector である必要があります。
デフォルト値— Connector
データ型— string
このフィールドはコネクタービルダーでは表示されません。Secureworks専用です。
name🔗
コネクターの名前を定義します。コネクター名は、特定のテナント内で一意でなければなりません。Taegis プレフィックスで始まるコネクター名はグローバルであり、Secureworksのみが追加できます。コネクター名にはスペースやアンダースコア（_）およびピリオド（.）以外の特殊文字を含めないでください。
値— ベンダー/製品/サービスの名前をタイトルケースで使用してください。
データ型— string
このフィールドはコネクタービルダーで利用可能です。
title🔗
コネクターをXDRで表示する際に表示される値を定義します。このフィールドにはスペースやその他の特殊文字を含めることができます。
デフォルト値— 市場や公開ウェブサイトで一般的に使用されているベンダー/製品/サービスの名前を使用してください。
データ型— string
このフィールドはコネクタービルダーで利用可能です。
description🔗
コネクターを説明します。これはドキュメント用のフィールドではなく、コネクターの目的を明確に示す1～2文の短い説明です。
推奨値— コネクターの目的を明確に示す1～2文。
データ型— string
このフィールドはコネクタービルダーで利用可能です。
tags🔗
コネクターに関連付けられたラベルのリストです。タグは現在、XDRで表示または検索できません。
データ型— 文字列の配列
このフィールドはコネクタービルダーでは表示されません。Secureworks専用です。
Categories🔗
コネクターに関連付けられた事前定義済みカテゴリのリストです。カテゴリは現在、XDRで表示または検索できません。
データ型— 文字列の配列
このフィールドはコネクタービルダーでは表示されません。Secureworks専用です。
method🔗
製品やサービスへの接続に使用されるメソッドを定義します。現在サポートされているメソッドはHTTP RESTです。
デフォルト値— HTTP
データ型— string
このフィールドはコネクタービルダーでは表示されません。Secureworks専用です。
version🔗
コネクター定義のバージョンを設定するために使用します。コネクター定義のバージョニングは major.minor.patch バージョンスキーマに従います。メジャーバージョンの変更は、接続の再設定が必要となる破壊的な変更を伝えるために使用してください。メジャーおよびパッチは作成者の裁量で使用できます。
注意
バージョンは特定のテナント/コネクターごとに一意でなければならず、変更またはインポートのたびにバージョンを増やす必要があります。
デフォルト値— 1.0.0
データ型— string
このフィールドはコネクタービルダーで利用可能です。
parameters🔗
コネクター作成者が接続に必要な入力を定義できます。パラメーター値は、入力の構造を定義するJSONスキーマとしてフォーマットされます。
重要
このフィールドを使用してパスワード、OAuthトークンなどを収集しないでください。
デフォルト値— n/a
データ型— JSON string（JSONスキーマ）
このフィールドはコネクタービルダーで利用可能です。
functions🔗
コネクターがサポートする各関数の定義を含みます。各関数には、Taegisでの関数定義で詳しく説明されている一連のフィールドが含まれます。
デフォルト値— n/a
データ型— array
actionsフィールドはコネクタービルダーでは表示されませんが、個々のアクションは表示されます。アクションの詳細については、Taegisでの関数定義を参照してください。
特殊なアクション🔗
いくつかの特殊なアクションがあります。
validate🔗
XDRに「テスト」ボタンを表示し、validateアクションを直接実行します。これにより、接続が正しく動作しているか（認証、アクセスなど）を検証できます。
authenticate🔗
他のアクションの前に実行され、カスタム認証を処理します。
authTypes🔗
このフィールドは、コネクターでサポートされる認証タイプを定義します。1つ以上の認証タイプを設定できます。サポートされている認証タイプには以下が含まれます。
- None
- Platform
- Raw
- Basic
- APIKey
- OAuthClientCredentials
- OAuthPassword
- OAuthAuthCode
- Custom
注意
XDRは、接続作成時に指定された認証タイプに必要な入力を自動的に提供します。コネクターで認証入力を収集・定義する必要はありません。
デフォルト値— n/a
データ型— string
このフィールドはコネクタービルダーで利用可能です。