Skip to content

Commit d9f34a2

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ae70501 of spec repo
1 parent db50fbc commit d9f34a2

12 files changed

+853
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59138,6 +59138,17 @@ components:
5913859138
required:
5913959139
- data
5914059140
type: object
59141+
SecurityMonitoringSignalInvestigationQueryTemplateVariables:
59142+
additionalProperties:
59143+
items:
59144+
description: A value for this template variable extracted from the signal.
59145+
type: string
59146+
type: array
59147+
description: Template variables applied to the investigation log query, mapping attribute paths to values extracted from the signal.
59148+
example:
59149+
"@userIdentity.arn":
59150+
- foo
59151+
type: object
5914159152
SecurityMonitoringSignalListRequest:
5914259153
description: The request for a security signal list.
5914359154
properties:
@@ -59523,6 +59534,82 @@ components:
5952359534
required:
5952459535
- data
5952559536
type: object
59537+
SecurityMonitoringSignalSuggestedAction:
59538+
description: A suggested action for a security signal.
59539+
properties:
59540+
attributes:
59541+
$ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionAttributes"
59542+
id:
59543+
description: The unique ID of the suggested action.
59544+
example: w00-t10-992
59545+
type: string
59546+
type:
59547+
$ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionType"
59548+
required:
59549+
- id
59550+
- type
59551+
- attributes
59552+
type: object
59553+
SecurityMonitoringSignalSuggestedActionAttributes:
59554+
description: Attributes of a suggested action for a security signal. The available fields depend on the action type.
59555+
properties:
59556+
name:
59557+
description: The name of the investigation log query.
59558+
example: Cloudtrail events for user ARN
59559+
type: string
59560+
query_filter:
59561+
description: The log query filter for the investigation.
59562+
example: 'source:cloudtrail @userIdentity.arn:"foo"'
59563+
type: string
59564+
template_variables:
59565+
$ref: "#/components/schemas/SecurityMonitoringSignalInvestigationQueryTemplateVariables"
59566+
title:
59567+
description: The title of the recommended blog post.
59568+
example: Monitor Okta logs to track system access and unusual activity
59569+
type: string
59570+
url:
59571+
description: The URL of the suggested action.
59572+
example: /logs?query=source%3Acloudtrail+%40userIdentity.arn%3A%22foo%22
59573+
type: string
59574+
type: object
59575+
SecurityMonitoringSignalSuggestedActionList:
59576+
description: List of suggested actions for a security signal.
59577+
example:
59578+
- attributes:
59579+
name: Cloudtrail events for user ARN
59580+
query_filter: 'source:cloudtrail @userIdentity.arn:"foo"'
59581+
template_variables:
59582+
"@userIdentity.arn":
59583+
- foo
59584+
url: /logs?query=source%3Acloudtrail+%40userIdentity.arn%3A%22foo%22
59585+
id: w00-t10-992
59586+
type: investigation_log_queries
59587+
- attributes:
59588+
title: Monitor Okta logs to track system access and unusual activity
59589+
url: https://www.datadoghq.com/blog/monitor-activity-with-okta/
59590+
id: bxy-o8v-i1a
59591+
type: recommended_blog_posts
59592+
items:
59593+
$ref: "#/components/schemas/SecurityMonitoringSignalSuggestedAction"
59594+
type: array
59595+
SecurityMonitoringSignalSuggestedActionType:
59596+
description: The type of the suggested action resource.
59597+
enum:
59598+
- investigation_log_queries
59599+
- recommended_blog_posts
59600+
example: investigation_log_queries
59601+
type: string
59602+
x-enum-varnames:
59603+
- INVESTIGATION_LOG_QUERIES
59604+
- RECOMMENDED_BLOG_POSTS
59605+
SecurityMonitoringSignalSuggestedActionsResponse:
59606+
description: Response with suggested actions for a security signal.
59607+
properties:
59608+
data:
59609+
$ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionList"
59610+
required:
59611+
- data
59612+
type: object
5952659613
SecurityMonitoringSignalTriageAttributes:
5952759614
description: Attributes describing a triage state update operation over a security signal.
5952859615
properties:
@@ -105894,6 +105981,56 @@ paths:
105894105981
operator: OR
105895105982
permissions:
105896105983
- security_monitoring_signals_write
105984+
/api/v2/security_monitoring/signals/{signal_id}/investigation_queries:
105985+
get:
105986+
description: Get the list of investigation log queries available for a given security signal.
105987+
operationId: GetInvestigationLogQueriesMatchingSignal
105988+
parameters:
105989+
- $ref: "#/components/parameters/SignalID"
105990+
responses:
105991+
"200":
105992+
content:
105993+
application/json:
105994+
examples:
105995+
default:
105996+
value:
105997+
data:
105998+
- attributes:
105999+
name: Cloudtrail events for user ARN
106000+
query_filter: 'source:cloudtrail @userIdentity.arn:"foo"'
106001+
template_variables:
106002+
"@userIdentity.arn":
106003+
- foo
106004+
url: /logs?query=source%3Acloudtrail+%40userIdentity.arn%3A%22foo%22
106005+
id: w00-t10-992
106006+
type: investigation_log_queries
106007+
- attributes:
106008+
title: Monitor Okta logs to track system access and unusual activity
106009+
url: https://www.datadoghq.com/blog/monitor-activity-with-okta/
106010+
id: bxy-o8v-i1a
106011+
type: recommended_blog_posts
106012+
schema:
106013+
$ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionsResponse"
106014+
description: OK
106015+
"403":
106016+
$ref: "#/components/responses/NotAuthorizedResponse"
106017+
"404":
106018+
$ref: "#/components/responses/NotFoundResponse"
106019+
"429":
106020+
$ref: "#/components/responses/TooManyRequestsResponse"
106021+
security:
106022+
- apiKeyAuth: []
106023+
appKeyAuth: []
106024+
- AuthZ:
106025+
- security_monitoring_rules_read
106026+
- security_monitoring_signals_read
106027+
summary: Get investigation queries for a signal
106028+
tags: ["Security Monitoring"]
106029+
x-permission:
106030+
operator: AND
106031+
permissions:
106032+
- security_monitoring_rules_read
106033+
- security_monitoring_signals_read
105897106034
/api/v2/security_monitoring/signals/{signal_id}/state:
105898106035
patch:
105899106036
description: |-
@@ -105934,6 +106071,56 @@ paths:
105934106071
operator: OR
105935106072
permissions:
105936106073
- security_monitoring_signals_write
106074+
/api/v2/security_monitoring/signals/{signal_id}/suggested_actions:
106075+
get:
106076+
description: Get the list of suggested actions for a given security signal.
106077+
operationId: GetSuggestedActionsMatchingSignal
106078+
parameters:
106079+
- $ref: "#/components/parameters/SignalID"
106080+
responses:
106081+
"200":
106082+
content:
106083+
application/json:
106084+
examples:
106085+
default:
106086+
value:
106087+
data:
106088+
- attributes:
106089+
name: Cloudtrail events for user ARN
106090+
query_filter: 'source:cloudtrail @userIdentity.arn:"foo"'
106091+
template_variables:
106092+
"@userIdentity.arn":
106093+
- foo
106094+
url: /logs?query=source%3Acloudtrail+%40userIdentity.arn%3A%22foo%22
106095+
id: w00-t10-992
106096+
type: investigation_log_queries
106097+
- attributes:
106098+
title: Monitor Okta logs to track system access and unusual activity
106099+
url: https://www.datadoghq.com/blog/monitor-activity-with-okta/
106100+
id: bxy-o8v-i1a
106101+
type: recommended_blog_posts
106102+
schema:
106103+
$ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionsResponse"
106104+
description: OK
106105+
"403":
106106+
$ref: "#/components/responses/NotAuthorizedResponse"
106107+
"404":
106108+
$ref: "#/components/responses/NotFoundResponse"
106109+
"429":
106110+
$ref: "#/components/responses/TooManyRequestsResponse"
106111+
security:
106112+
- apiKeyAuth: []
106113+
appKeyAuth: []
106114+
- AuthZ:
106115+
- security_monitoring_rules_read
106116+
- security_monitoring_signals_read
106117+
summary: Get suggested actions for a signal
106118+
tags: ["Security Monitoring"]
106119+
x-permission:
106120+
operator: AND
106121+
permissions:
106122+
- security_monitoring_rules_read
106123+
- security_monitoring_signals_read
105937106124
/api/v2/sensitive-data-scanner/config:
105938106125
get:
105939106126
description: List all the Scanning groups in your organization.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Get investigation queries for a signal returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
5+
p api_instance.get_investigation_log_queries_matching_signal("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE")
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Get suggested actions for a signal returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
5+
p api_instance.get_suggested_actions_matching_signal("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE")

features/scenarios_model_mapping.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1761,10 +1761,16 @@
17611761
"signal_id" => "String",
17621762
"body" => "SecurityMonitoringSignalIncidentsUpdateRequest",
17631763
},
1764+
"v2.GetInvestigationLogQueriesMatchingSignal" => {
1765+
"signal_id" => "String",
1766+
},
17641767
"v2.EditSecurityMonitoringSignalState" => {
17651768
"signal_id" => "String",
17661769
"body" => "SecurityMonitoringSignalStateUpdateRequest",
17671770
},
1771+
"v2.GetSuggestedActionsMatchingSignal" => {
1772+
"signal_id" => "String",
1773+
},
17681774
"v2.ListSecurityMonitoringHistsignals" => {
17691775
"filter_query" => "String",
17701776
"filter_from" => "Time",

features/v2/security_monitoring.feature

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1371,6 +1371,25 @@ Feature: Security Monitoring
13711371
When the request is sent
13721372
Then the response status is 200 Notification rule details.
13731373

1374+
@generated @skip @team:DataDog/k9-cloud-siem
1375+
Scenario: Get investigation queries for a signal returns "Not Found" response
1376+
Given new "GetInvestigationLogQueriesMatchingSignal" request
1377+
And request contains "signal_id" parameter from "REPLACE.ME"
1378+
When the request is sent
1379+
Then the response status is 404 Not Found
1380+
1381+
@skip @team:DataDog/k9-cloud-siem
1382+
Scenario: Get investigation queries for a signal returns "OK" response
1383+
Given new "GetInvestigationLogQueriesMatchingSignal" request
1384+
And request contains "signal_id" parameter with value "AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE"
1385+
When the request is sent
1386+
Then the response status is 200 OK
1387+
And the response "data[0].type" is equal to "investigation_log_queries"
1388+
And the response "data[0]" has field "id"
1389+
And the response "data[0].attributes" has field "name"
1390+
And the response "data[0].attributes" has field "query_filter"
1391+
And the response "data[0].attributes" has field "url"
1392+
13741393
@skip-go @skip-java @skip-ruby @team:DataDog/k9-cloud-siem
13751394
Scenario: Get rule version history returns "OK" response
13761395
Given operation "GetRuleVersionHistory" enabled
@@ -1384,6 +1403,29 @@ Feature: Security Monitoring
13841403
And the response "data.attributes.count" is equal to 1
13851404
And the response "data.attributes.data[1].rule.name" has the same value as "security_rule.name"
13861405

1406+
@generated @skip @team:DataDog/k9-cloud-siem
1407+
Scenario: Get suggested actions for a signal returns "Not Found" response
1408+
Given new "GetSuggestedActionsMatchingSignal" request
1409+
And request contains "signal_id" parameter from "REPLACE.ME"
1410+
When the request is sent
1411+
Then the response status is 404 Not Found
1412+
1413+
@skip @team:DataDog/k9-cloud-siem
1414+
Scenario: Get suggested actions for a signal returns "OK" response
1415+
Given new "GetSuggestedActionsMatchingSignal" request
1416+
And request contains "signal_id" parameter with value "AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE"
1417+
When the request is sent
1418+
Then the response status is 200 OK
1419+
And the response "data[0].type" is equal to "investigation_log_queries"
1420+
And the response "data[0]" has field "id"
1421+
And the response "data[0].attributes" has field "name"
1422+
And the response "data[0].attributes" has field "query_filter"
1423+
And the response "data[0].attributes" has field "url"
1424+
And the response "data[1].type" is equal to "recommended_blog_posts"
1425+
And the response "data[1]" has field "id"
1426+
And the response "data[1].attributes" has field "title"
1427+
And the response "data[1].attributes" has field "url"
1428+
13871429
@team:DataDog/k9-cloud-siem
13881430
Scenario: Get suppressions affecting a specific rule returns "Not Found" response
13891431
Given new "GetSuppressionsAffectingRule" request

features/v2/undo.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5338,12 +5338,24 @@
53385338
"type": "idempotent"
53395339
}
53405340
},
5341+
"GetInvestigationLogQueriesMatchingSignal": {
5342+
"tag": "Security Monitoring",
5343+
"undo": {
5344+
"type": "safe"
5345+
}
5346+
},
53415347
"EditSecurityMonitoringSignalState": {
53425348
"tag": "Security Monitoring",
53435349
"undo": {
53445350
"type": "idempotent"
53455351
}
53465352
},
5353+
"GetSuggestedActionsMatchingSignal": {
5354+
"tag": "Security Monitoring",
5355+
"undo": {
5356+
"type": "safe"
5357+
}
5358+
},
53475359
"ListScanningGroups": {
53485360
"tag": "Sensitive Data Scanner",
53495361
"undo": {

lib/datadog_api_client/inflector.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4856,6 +4856,10 @@ def overrides
48564856
"v2.security_monitoring_signal_state_update_attributes" => "SecurityMonitoringSignalStateUpdateAttributes",
48574857
"v2.security_monitoring_signal_state_update_data" => "SecurityMonitoringSignalStateUpdateData",
48584858
"v2.security_monitoring_signal_state_update_request" => "SecurityMonitoringSignalStateUpdateRequest",
4859+
"v2.security_monitoring_signal_suggested_action" => "SecurityMonitoringSignalSuggestedAction",
4860+
"v2.security_monitoring_signal_suggested_action_attributes" => "SecurityMonitoringSignalSuggestedActionAttributes",
4861+
"v2.security_monitoring_signal_suggested_actions_response" => "SecurityMonitoringSignalSuggestedActionsResponse",
4862+
"v2.security_monitoring_signal_suggested_action_type" => "SecurityMonitoringSignalSuggestedActionType",
48594863
"v2.security_monitoring_signal_triage_attributes" => "SecurityMonitoringSignalTriageAttributes",
48604864
"v2.security_monitoring_signal_triage_update_data" => "SecurityMonitoringSignalTriageUpdateData",
48614865
"v2.security_monitoring_signal_triage_update_response" => "SecurityMonitoringSignalTriageUpdateResponse",

0 commit comments

Comments
 (0)