Skip to content

Get Started with the Notifications API🔗

Important

Before proceeding, complete the API Authentication steps in order to obtain a working client_id and client_secret.

Regions

The URL to access XDR APIs may differ according to the region your environment is deployed in:

  • 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

The examples in this XDR API documentation use https://api.ctpx.secureworks.com throughout. If you are in a different region substitute appropriately.

Updating Notification Preferences of Other Users🔗

The updateUserNotificationPreference mutation is used to update the email preferences of other users who belong to the same tenant.

Only users with the Tenant Admin role, in addition to Secureworks roles, are eligible to perform this operation.

Request headers to be passed:

  • X-Tenant-Context : < tenant_id_of_the_user_to_be_updated >
  • access_token : XDR access token obtained by following the API Authentication steps
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 is the email address of the user whose preference needs to be updated
  • preferences is the list of updated preference items; see Sample Preference Items
  • global is set to true to update the preferences across all environments, otherwise set to false

Sample Preference Items🔗

The following are sample preference items:

  • {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"}