Skip to content
Open
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
622 changes: 622 additions & 0 deletions .generator/schemas/v2/openapi.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
"""
Add an allowed outreach domain returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.bits_security_analyst_api import BitsSecurityAnalystApi
from datadog_api_client.v2.model.security_agent_outreach_domain_add_request import SecurityAgentOutreachDomainAddRequest
from datadog_api_client.v2.model.security_agent_outreach_domain_add_request_data import (
SecurityAgentOutreachDomainAddRequestData,
)
from datadog_api_client.v2.model.security_agent_outreach_domain_add_request_data_attributes import (
SecurityAgentOutreachDomainAddRequestDataAttributes,
)
from datadog_api_client.v2.model.security_agent_outreach_domain_add_type import SecurityAgentOutreachDomainAddType

body = SecurityAgentOutreachDomainAddRequest(
data=SecurityAgentOutreachDomainAddRequestData(
attributes=SecurityAgentOutreachDomainAddRequestDataAttributes(
domain="acme.com",
),
type=SecurityAgentOutreachDomainAddType.OUTREACH_POLICY_DOMAIN_ADD,
),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["add_security_agent_outreach_policy_domain"] = True
with ApiClient(configuration) as api_client:
api_instance = BitsSecurityAnalystApi(api_client)
response = api_instance.add_security_agent_outreach_policy_domain(body=body)

print(response)
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get the user outreach policy returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.bits_security_analyst_api import BitsSecurityAnalystApi

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["get_security_agent_outreach_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = BitsSecurityAnalystApi(api_client)
response = api_instance.get_security_agent_outreach_policy()

print(response)
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Remove an allowed outreach domain returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.bits_security_analyst_api import BitsSecurityAnalystApi

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["remove_security_agent_outreach_policy_domain"] = True
with ApiClient(configuration) as api_client:
api_instance = BitsSecurityAnalystApi(api_client)
response = api_instance.remove_security_agent_outreach_policy_domain(
domain="acme.com",
)

print(response)
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
"""
Update the outreach mode returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.bits_security_analyst_api import BitsSecurityAnalystApi
from datadog_api_client.v2.model.security_agent_outreach_mode import SecurityAgentOutreachMode
from datadog_api_client.v2.model.security_agent_outreach_mode_attributes import SecurityAgentOutreachModeAttributes
from datadog_api_client.v2.model.security_agent_outreach_mode_update_data import SecurityAgentOutreachModeUpdateData
from datadog_api_client.v2.model.security_agent_outreach_mode_update_request import (
SecurityAgentOutreachModeUpdateRequest,
)
from datadog_api_client.v2.model.security_agent_outreach_policy_type import SecurityAgentOutreachPolicyType

body = SecurityAgentOutreachModeUpdateRequest(
data=SecurityAgentOutreachModeUpdateData(
attributes=SecurityAgentOutreachModeAttributes(
mode=SecurityAgentOutreachMode.AUTOMATED,
),
type=SecurityAgentOutreachPolicyType.OUTREACH_POLICY,
),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["update_security_agent_outreach_mode"] = True
with ApiClient(configuration) as api_client:
api_instance = BitsSecurityAnalystApi(api_client)
response = api_instance.update_security_agent_outreach_mode(body=body)

print(response)
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
"""
Update outreach policy rules returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.bits_security_analyst_api import BitsSecurityAnalystApi
from datadog_api_client.v2.model.security_agent_outreach_rule_update import SecurityAgentOutreachRuleUpdate
from datadog_api_client.v2.model.security_agent_outreach_rules_update_attributes import (
SecurityAgentOutreachRulesUpdateAttributes,
)
from datadog_api_client.v2.model.security_agent_outreach_rules_update_request import (
SecurityAgentOutreachRulesUpdateRequest,
)
from datadog_api_client.v2.model.security_agent_outreach_rules_update_request_data import (
SecurityAgentOutreachRulesUpdateRequestData,
)
from datadog_api_client.v2.model.security_agent_outreach_rules_update_type import SecurityAgentOutreachRulesUpdateType

body = SecurityAgentOutreachRulesUpdateRequest(
data=SecurityAgentOutreachRulesUpdateRequestData(
attributes=SecurityAgentOutreachRulesUpdateAttributes(
rules=[
SecurityAgentOutreachRuleUpdate(
is_enabled=True,
rule_id="abc-def-ghi",
),
],
),
type=SecurityAgentOutreachRulesUpdateType.OUTREACH_POLICY_RULES_UPDATE,
),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["update_security_agent_outreach_policy_rules"] = True
with ApiClient(configuration) as api_client:
api_instance = BitsSecurityAnalystApi(api_client)
response = api_instance.update_security_agent_outreach_policy_rules(body=body)

print(response)
5 changes: 5 additions & 0 deletions src/datadog_api_client/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -909,9 +909,14 @@ def __init__(
"v2.get_entity_risk_score": False,
"v2.list_entity_risk_scores": False,
"v2.add_stix_threat_intel": False,
"v2.add_security_agent_outreach_policy_domain": False,
"v2.count_security_agent_investigations": False,
"v2.get_security_agent_investigation": False,
"v2.get_security_agent_outreach_policy": False,
"v2.list_security_agent_investigations": False,
"v2.remove_security_agent_outreach_policy_domain": False,
"v2.update_security_agent_outreach_mode": False,
"v2.update_security_agent_outreach_policy_rules": False,
"v2.create_slo_report_job": False,
"v2.get_slo_report": False,
"v2.get_slo_report_job_status": False,
Expand Down
196 changes: 196 additions & 0 deletions src/datadog_api_client/v2/api/bits_security_analyst_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@
from datadog_api_client.v2.model.security_agent_investigation_count_field import SecurityAgentInvestigationCountField
from datadog_api_client.v2.model.security_agent_investigation_response import SecurityAgentInvestigationResponse
from datadog_api_client.v2.model.security_agent_investigation_field import SecurityAgentInvestigationField
from datadog_api_client.v2.model.security_agent_outreach_policy_response import SecurityAgentOutreachPolicyResponse
from datadog_api_client.v2.model.security_agent_outreach_mode_response import SecurityAgentOutreachModeResponse
from datadog_api_client.v2.model.security_agent_outreach_mode_update_request import (
SecurityAgentOutreachModeUpdateRequest,
)
from datadog_api_client.v2.model.security_agent_outreach_domain_add_request import SecurityAgentOutreachDomainAddRequest
from datadog_api_client.v2.model.security_agent_outreach_rules_update_request import (
SecurityAgentOutreachRulesUpdateRequest,
)


class BitsSecurityAnalystApi:
Expand All @@ -33,6 +42,26 @@ def __init__(self, api_client=None):
api_client = ApiClient(Configuration())
self.api_client = api_client

self._add_security_agent_outreach_policy_domain_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentOutreachPolicyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/security_monitoring/security_agent/outreach_policy/allowed_domains",
"operation_id": "add_security_agent_outreach_policy_domain",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (SecurityAgentOutreachDomainAddRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)

self._count_security_agent_investigations_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentInvestigationCountsResponse,),
Expand Down Expand Up @@ -135,6 +164,22 @@ def __init__(self, api_client=None):
api_client=api_client,
)

self._get_security_agent_outreach_policy_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentOutreachPolicyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/security_monitoring/security_agent/outreach_policy",
"operation_id": "get_security_agent_outreach_policy",
"http_method": "GET",
"version": "v2",
},
params_map={},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)

self._list_security_agent_investigations_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentInvestigationsListResponse,),
Expand Down Expand Up @@ -234,6 +279,88 @@ def __init__(self, api_client=None):
api_client=api_client,
)

self._remove_security_agent_outreach_policy_domain_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentOutreachPolicyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/security_monitoring/security_agent/outreach_policy/allowed_domains/{domain}",
"operation_id": "remove_security_agent_outreach_policy_domain",
"http_method": "DELETE",
"version": "v2",
},
params_map={
"domain": {
"required": True,
"openapi_types": (str,),
"attribute": "domain",
"location": "path",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)

self._update_security_agent_outreach_mode_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentOutreachModeResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/security_monitoring/security_agent/outreach_policy",
"operation_id": "update_security_agent_outreach_mode",
"http_method": "PUT",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (SecurityAgentOutreachModeUpdateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)

self._update_security_agent_outreach_policy_rules_endpoint = _Endpoint(
settings={
"response_type": (SecurityAgentOutreachPolicyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/security_monitoring/security_agent/outreach_policy/rules",
"operation_id": "update_security_agent_outreach_policy_rules",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (SecurityAgentOutreachRulesUpdateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)

def add_security_agent_outreach_policy_domain(
self,
body: SecurityAgentOutreachDomainAddRequest,
) -> SecurityAgentOutreachPolicyResponse:
"""Add an allowed outreach domain.

Add one allowed email domain. User outreach is only sent to users whose email domain is allowed. The
domain must be a fully qualified domain name, like ``example.com`` ; it is lowercased before being stored.
An organization can allow at most 20 domains.

:param body: The email domain to allow.
:type body: SecurityAgentOutreachDomainAddRequest
:rtype: SecurityAgentOutreachPolicyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

return self._add_security_agent_outreach_policy_domain_endpoint.call_with_http_info(**kwargs)

def count_security_agent_investigations(
self,
field: SecurityAgentInvestigationCountField,
Expand Down Expand Up @@ -347,6 +474,20 @@ def get_security_agent_investigation(

return self._get_security_agent_investigation_endpoint.call_with_http_info(**kwargs)

def get_security_agent_outreach_policy(
self,
) -> SecurityAgentOutreachPolicyResponse:
"""Get the user outreach policy.

Get the organization's user outreach policy for Bits Security Analyst: the outreach mode, the per-rule
automation state, the allowed email domains that user outreach can be sent to, and, for the caller, domains
that could be allowed next.

:rtype: SecurityAgentOutreachPolicyResponse
"""
kwargs: Dict[str, Any] = {}
return self._get_security_agent_outreach_policy_endpoint.call_with_http_info(**kwargs)

def list_security_agent_investigations(
self,
*,
Expand Down Expand Up @@ -466,3 +607,58 @@ def list_security_agent_investigations(
kwargs["page_size"] = page_size

return self._list_security_agent_investigations_endpoint.call_with_http_info(**kwargs)

def remove_security_agent_outreach_policy_domain(
self,
domain: str,
) -> SecurityAgentOutreachPolicyResponse:
"""Remove an allowed outreach domain.

Remove one allowed email domain, by its name.

:param domain: The allowed email domain to remove, for example ``example.com``. Case-insensitive.
:type domain: str
:rtype: SecurityAgentOutreachPolicyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["domain"] = domain

return self._remove_security_agent_outreach_policy_domain_endpoint.call_with_http_info(**kwargs)

def update_security_agent_outreach_mode(
self,
body: SecurityAgentOutreachModeUpdateRequest,
) -> SecurityAgentOutreachModeResponse:
"""Update the outreach mode.

Set the organization's outreach mode: ``off`` (no user outreach), ``manual`` (outreach is only sent when an
analyst triggers it), or ``automated`` (rules with outreach enabled auto-send automated interviews to users
whose email domain is allowed).

:param body: The new outreach mode.
:type body: SecurityAgentOutreachModeUpdateRequest
:rtype: SecurityAgentOutreachModeResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

return self._update_security_agent_outreach_mode_endpoint.call_with_http_info(**kwargs)

def update_security_agent_outreach_policy_rules(
self,
body: SecurityAgentOutreachRulesUpdateRequest,
) -> SecurityAgentOutreachPolicyResponse:
"""Update outreach policy rules.

Upsert the outreach automation state of detection rules. Each rule in the request gets the given state;
rules not in the request keep their state. A rule with ``is_enabled: true`` auto-sends automated interviews
in ``automated`` mode.

:param body: The rules to upsert.
:type body: SecurityAgentOutreachRulesUpdateRequest
:rtype: SecurityAgentOutreachPolicyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

return self._update_security_agent_outreach_policy_rules_endpoint.call_with_http_info(**kwargs)
Loading
Loading