コンテンツにスキップ

Automation GraphQL APIの利用開始🔗

重要

先に、API認証の手順を完了し、動作するclient_idおよびclient_secretを取得してください。

地域

XDR APIにアクセスするためのURLは、お客様の環境が展開されているリージョンによって異なる場合があります。

  • US1— https://api.ctpx.secureworks.com
  • US2— https://api.delta.taegis.secureworks.com
  • US3— https://api.foxtrot.taegis.secureworks.com
  • EU— https://api.echo.taegis.secureworks.com

このXDR APIドキュメントの例では、https://api.ctpx.secureworks.com を使用しています。別のリージョンをご利用の場合は、適切なURLに置き換えてください。

重要

2023年5月15日より、自動化で使用されるIPアドレス範囲が 216.9.204.0/22 に変更されます。

5月15日以前は、統合された製品APIへの接続にランダムなAWS Elastic IPアドレス（eIP）が使用されていました。

この変更は、コネクター認証のために指定された送信元IP範囲を使用するために行われます。

この変更はお客様に影響を与えない可能性が高いですが、ファイアウォールルールや許可リスト、またはAWS eIPを指定しているその他のアプリケーション設定を構成している場合は、設定の更新が必要です。

ご不明な点がございましたら、Taegis™ XDRの担当者までお問い合わせください。

コネクター🔗

Connectors GraphQL APIは、サードパーティサービスへの利用可能なコネクターのカタログ、その設定方法に関するメタデータ、およびテナントごとに設定されたインスタンス（接続）を管理します。これにより、すべてのSecureworks® Taegis™ XDR自動化コネクターに対して一貫した設定APIを提供します。

ConnectorInterface/ConnectorAction🔗

インターフェースは、コネクターの利用者（プレイブック/UI）と、必要な動作の実装との間の契約を定義します。動作は、block IPやdisable userなどの一連のアクションと、それに対応する入出力データ要件によって定義されます。コネクターインターフェースは、golangやjavaなどのプログラミング言語におけるインターフェースに類似しており、利用者は実装を意識せずに指定された動作に従って記述できます。

Connector/ConnectorActionDefinition🔗

コネクターは、1つ以上のConnectorInterfaceを実装するために必要な設定を保存します。一方、ConnectorActionDefinitionは、コネクターが実装する各アクションの設定を保持します。例えば、ServiceNowインテグレーション用のコネクターを作成し、_チケットの作成_アクションを持たせることができます。_チケットの作成_のConnectorActionDefinitionは、ServiceNow APIに接続するために必要な設定（URL、HTTPメソッド、POSTボディなど）を保存します。コネクターは、サービスエンドポイントやサポートされる認証方法など、エンドユーザーが提供する必要がある追加の設定パラメータも指定します。

Connection🔗

オブジェクト指向の用語で言うと、_Connection_はコネクターのインスタンスです。お客様のアカウントでコネクションを作成し、特定の環境に合わせてコネクターを設定できます。前述のServiceNowの例では、お客様のServiceNowインスタンスのベースURLやアクセス用の認証情報を指定する必要があります。

プレイブック🔗

Playbook GraphQL APIは、利用可能な自動化プレイブックのカタログと、テナントごとに実行するよう設定されたプレイブックのインスタンスを管理します。

Playbook/PlaybookVersion🔗

プレイブックは、外部イベントに対応して実行すべき一連の動作を、アクションのセットとして実行可能なワークフローにコード化することで定義します。プレイブックはドメイン固有言語（DSL）で定義されます。

プレイブックは、その構造や設定の変更を追跡するためにバージョン管理されます。プレイブックに変更が加えられるたびに新しいバージョンが生成され、_head_ポインタが現在のバージョンを指すように更新されます。複数のバージョンのプレイブックが同時に実行されることもあります。

PlaybookInstance/PlaybookExecution🔗

PlaybookInstanceを作成することで、アカウント内でプレイブックを実行するよう設定できます。インスタンスは実行するPlaybookVersion（デフォルトはhead）を指定し、入力パラメータを設定し、トリガー条件を定義します。プレイブックが実行されると、PlaybookExecutionのインスタンスが作成され、プレイブック実行の状態を追跡し、出力を記録します。

PlaybookTriggerType/PlaybookTrigger🔗

プレイブックインスタンスは、プラットフォーム内または外部でイベントが発生した際に、オプションでトリガーされることがあります。PlatformTriggerTypeはサポートされるトリガーを定義し、PlatformTriggerはその特定タイプのインスタンスを定義します。