Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70685,11 +70685,20 @@ components:
properties:
baselineUserLocations:
$ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations"
baselineUserLocationsDuration:
$ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocationsDuration"
type: object
SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations:
description: "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access."
example: true
type: boolean
SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocationsDuration:
description: The duration in days during which Datadog learns the user's regular access locations. After this period, signals are generated for accesses from unknown locations.
format: int32
maximum: 30
minimum: 1
nullable: true
type: integer
SecurityMonitoringRuleInstantaneousBaseline:
description: When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.
example: false
Expand Down Expand Up @@ -143305,6 +143314,7 @@ paths:
hardcodedEvaluatorType: log4shell
impossibleTravelOptions:
baselineUserLocations: true
baselineUserLocationsDuration: 7
newValueOptions:
instantaneousBaseline: false
learningMethod: duration
Expand Down Expand Up @@ -144061,6 +144071,7 @@ paths:
hardcodedEvaluatorType: log4shell
impossibleTravelOptions:
baselineUserLocations: true
baselineUserLocationsDuration: 7
keepAlive: 3600
maxSignalDuration: 86400
newValueOptions:
Expand Down Expand Up @@ -144162,6 +144173,7 @@ paths:
hardcodedEvaluatorType: log4shell
impossibleTravelOptions:
baselineUserLocations: true
baselineUserLocationsDuration: 7
keepAlive: 0
maxSignalDuration: 0
newValueOptions:
Expand Down Expand Up @@ -144275,6 +144287,7 @@ paths:
hardcodedEvaluatorType: log4shell
impossibleTravelOptions:
baselineUserLocations: true
baselineUserLocationsDuration: 7
keepAlive: 1800
maxSignalDuration: 1800
newValueOptions:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2026-05-20T15:12:27.397Z

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Create a detection rule with type 'impossible_travel' and baselineUserLocationsDuration returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new

body = DatadogAPIClient::V2::SecurityMonitoringStandardRuleCreatePayload.new({
queries: [
DatadogAPIClient::V2::SecurityMonitoringStandardRuleQuery.new({
aggregation: DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation::GEO_DATA,
group_by_fields: [
"@usr.id",
],
distinct_fields: [],
metric: "@network.client.geoip",
query: "*",
}),
],
cases: [
DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({
name: "",
status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO,
notifications: [],
}),
],
has_extended_title: true,
message: "test",
is_enabled: true,
options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new({
max_signal_duration: DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration::ONE_DAY,
evaluation_window: DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow::FIFTEEN_MINUTES,
keep_alive: DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive::ONE_HOUR,
detection_method: DatadogAPIClient::V2::SecurityMonitoringRuleDetectionMethod::IMPOSSIBLE_TRAVEL,
impossible_travel_options: DatadogAPIClient::V2::SecurityMonitoringRuleImpossibleTravelOptions.new({
baseline_user_locations: true,
baseline_user_locations_duration: 7,
}),
}),
name: "Example-Security-Monitoring",
type: DatadogAPIClient::V2::SecurityMonitoringRuleTypeCreate::LOG_DETECTION,
tags: [],
filters: [],
})
p api_instance.create_security_monitoring_rule(body)
13 changes: 13 additions & 0 deletions features/v2/security_monitoring.feature
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,19 @@ Feature: Security Monitoring
And the response "type" is equal to "application_security"
And the response "message" is equal to "Test rule"

@skip-validation @team:DataDog/k9-cloud-siem
Scenario: Create a detection rule with type 'impossible_travel' and baselineUserLocationsDuration returns "OK" response
Given new "CreateSecurityMonitoringRule" request
And body with value {"queries":[{"aggregation":"geo_data","groupByFields":["@usr.id"],"distinctFields":[],"metric":"@network.client.geoip","query":"*"}],"cases":[{"name":"","status":"info","notifications":[]}],"hasExtendedTitle":true,"message":"test","isEnabled":true,"options":{"maxSignalDuration":86400,"evaluationWindow":900,"keepAlive":3600,"detectionMethod":"impossible_travel","impossibleTravelOptions":{"baselineUserLocations":true,"baselineUserLocationsDuration":7}},"name":"{{ unique }}","type":"log_detection","tags":[],"filters":[]}
When the request is sent
Then the response status is 200 OK
And the response "name" is equal to "{{ unique }}"
And the response "type" is equal to "log_detection"
And the response "message" is equal to "test"
And the response "options.detectionMethod" is equal to "impossible_travel"
And the response "options.impossibleTravelOptions.baselineUserLocations" is equal to true
And the response "options.impossibleTravelOptions.baselineUserLocationsDuration" is equal to 7

@skip-validation @team:DataDog/k9-cloud-siem
Scenario: Create a detection rule with type 'impossible_travel' returns "OK" response
Given new "CreateSecurityMonitoringRule" request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,37 @@ class SecurityMonitoringRuleImpossibleTravelOptions
# access locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.
attr_accessor :baseline_user_locations

# The duration in days during which Datadog learns the user's regular access locations. After this period, signals are generated for accesses from unknown locations.
attr_reader :baseline_user_locations_duration

attr_accessor :additional_properties

# Attribute mapping from ruby-style variable name to JSON key.
# @!visibility private
def self.attribute_map
{
:'baseline_user_locations' => :'baselineUserLocations'
:'baseline_user_locations' => :'baselineUserLocations',
:'baseline_user_locations_duration' => :'baselineUserLocationsDuration'
}
end

# Attribute type mapping.
# @!visibility private
def self.openapi_types
{
:'baseline_user_locations' => :'Boolean'
:'baseline_user_locations' => :'Boolean',
:'baseline_user_locations_duration' => :'Integer'
}
end

# List of attributes with nullable: true
# @!visibility private
def self.openapi_nullable
Set.new([
:'baseline_user_locations_duration',
])
end

# Initializes the object
# @param attributes [Hash] Model attributes in the form of hash
# @!visibility private
Expand All @@ -64,6 +77,32 @@ def initialize(attributes = {})
if attributes.key?(:'baseline_user_locations')
self.baseline_user_locations = attributes[:'baseline_user_locations']
end

if attributes.key?(:'baseline_user_locations_duration')
self.baseline_user_locations_duration = attributes[:'baseline_user_locations_duration']
end
end

# Check to see if the all the properties in the model are valid
# @return true if the model is valid
# @!visibility private
def valid?
return false if !@baseline_user_locations_duration.nil? && @baseline_user_locations_duration > 30
return false if !@baseline_user_locations_duration.nil? && @baseline_user_locations_duration < 1
true
end

# Custom attribute writer method with validation
# @param baseline_user_locations_duration [Object] Object to be assigned
# @!visibility private
def baseline_user_locations_duration=(baseline_user_locations_duration)
if !baseline_user_locations_duration.nil? && baseline_user_locations_duration > 30
fail ArgumentError, 'invalid value for "baseline_user_locations_duration", must be smaller than or equal to 30.'
end
if !baseline_user_locations_duration.nil? && baseline_user_locations_duration < 1
fail ArgumentError, 'invalid value for "baseline_user_locations_duration", must be greater than or equal to 1.'
end
@baseline_user_locations_duration = baseline_user_locations_duration
end

# Returns the object in the form of hash, with additionalProperties support.
Expand Down Expand Up @@ -93,14 +132,15 @@ def ==(o)
return true if self.equal?(o)
self.class == o.class &&
baseline_user_locations == o.baseline_user_locations &&
baseline_user_locations_duration == o.baseline_user_locations_duration &&
additional_properties == o.additional_properties
end

# Calculates hash code according to all attributes.
# @return [Integer] Hash code
# @!visibility private
def hash
[baseline_user_locations, additional_properties].hash
[baseline_user_locations, baseline_user_locations_duration, additional_properties].hash
end
end
end
Loading