コンテンツにスキップ

通知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
  • EU1— https://api.echo.taegis.secureworks.com
  • EU2— https://api.golf.taegis.secureworks.com

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

他ユーザーの通知設定の更新🔗

updateUserNotificationPreferenceミューテーションは、同じテナントに所属する他ユーザーのメール通知設定を更新するために使用します。

この操作を実行できるのは、テナント管理者ロールを持つユーザー、またはSecureworksロールを持つユーザーのみです。

リクエストヘッダーに指定する内容：

  • X-Tenant-Context : < 更新対象ユーザーのテナントID >
  • access_token : API認証の手順で取得したXDRアクセストークン
mutation {updateUserNotificationPreference(updateUserNotificationPreferenceInput:{userEmail:"user_email_address",preferences:[{
       key: "preference_key",
       value: "preference_value"
     },],global:false}){
         user_id
         user_notification_preference{
             environment
             id
             preference_items {key value}
             created_at
             updated_at 
             taegis_user_id
             key
         }
         taegis_user_id
}
}
  • user_email_addressは、設定を更新する対象ユーザーのメールアドレスです
  • preferencesは、更新する設定項目のリストです。詳細はサンプル設定項目を参照してください
  • globalは、すべての環境で設定を更新する場合はtrue、そうでない場合はfalseに設定します

サンプル設定項目🔗

以下はサンプルの設定項目です：

  • {key: "group_awaiting_action", value: "false"}
  • {key: "group_mention", value: "false"}
  • {key: "mention", value: "false"}
  • {key: "awaiting_action", value: "false"}
  • {key: "collector_health_status", value: "false"}
  • {key: "log_source_health_status", value: "false"}
  • {key: "endpoint_integration_health_status", value: "false"}
  • {key: "unhealthy_assets", value: "false"}
  • {key: "collector_endpoint_certificate_expiration_alert", value: "false"}
  • {key: "exports_csv_ready", value: "false"}
  • {key: "reports_pdf_ready", value: "false"}
  • {key: "automation_investigation_notify", value: "false"}
  • {key: "automation_alert_notify", value: "false"}
  • {key: "playbooks_excessive_executions", value: "false"}
  • {key: "publication_tips", value: "false"}
  • {key: "publication_ta", value: "false"}
  • {key: "publication_advisories", value: "false"}
  • {key: "automatic_investigations_updates", value: "false"}
  • {key: "collector_scheduled_maintenance", value: "false"}
  • {key: "email_notification_language", value: "false"}