Skip to content

Commit a633078

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add OpenAPI for entity risk score api (#3399)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 0e2520d commit a633078

15 files changed

+2793
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 377 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48914,6 +48914,263 @@ components:
4891448914
type: string
4891548915
x-enum-varnames:
4891648916
- SECRET_RULE
48917+
SecurityEntityConfigRisks:
48918+
description: Configuration risks associated with the entity
48919+
properties:
48920+
hasIdentityRisk:
48921+
description: Whether the entity has identity risks
48922+
example: false
48923+
type: boolean
48924+
hasMisconfiguration:
48925+
description: Whether the entity has misconfigurations
48926+
example: true
48927+
type: boolean
48928+
hasPrivilegedRole:
48929+
description: Whether the entity has privileged roles
48930+
example: true
48931+
type: boolean
48932+
isPrivileged:
48933+
description: Whether the entity has privileged access
48934+
example: false
48935+
type: boolean
48936+
isProduction:
48937+
description: Whether the entity is in a production environment
48938+
example: true
48939+
type: boolean
48940+
isPubliclyAccessible:
48941+
description: Whether the entity is publicly accessible
48942+
example: true
48943+
type: boolean
48944+
required:
48945+
- hasMisconfiguration
48946+
- hasIdentityRisk
48947+
- isPubliclyAccessible
48948+
- isProduction
48949+
- hasPrivilegedRole
48950+
- isPrivileged
48951+
type: object
48952+
SecurityEntityMetadata:
48953+
description: Metadata about the entity from cloud providers
48954+
properties:
48955+
accountID:
48956+
description: Cloud account ID (AWS)
48957+
example: '123456789012'
48958+
type: string
48959+
environments:
48960+
description: Environment tags associated with the entity
48961+
example:
48962+
- production
48963+
- us-east-1
48964+
items:
48965+
type: string
48966+
type: array
48967+
mitreTactics:
48968+
description: MITRE ATT&CK tactics detected
48969+
example:
48970+
- Credential Access
48971+
- Privilege Escalation
48972+
items:
48973+
type: string
48974+
type: array
48975+
mitreTechniques:
48976+
description: MITRE ATT&CK techniques detected
48977+
example:
48978+
- T1078
48979+
- T1098
48980+
items:
48981+
type: string
48982+
type: array
48983+
projectID:
48984+
description: Cloud project ID (GCP)
48985+
example: my-gcp-project
48986+
type: string
48987+
services:
48988+
description: Services associated with the entity
48989+
example:
48990+
- api-gateway
48991+
- lambda
48992+
items:
48993+
type: string
48994+
type: array
48995+
sources:
48996+
description: Data sources that detected this entity
48997+
example:
48998+
- cloudtrail
48999+
- cloud-security-posture-management
49000+
items:
49001+
type: string
49002+
type: array
49003+
subscriptionID:
49004+
description: Cloud subscription ID (Azure)
49005+
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
49006+
type: string
49007+
required:
49008+
- sources
49009+
- environments
49010+
- services
49011+
- mitreTactics
49012+
- mitreTechniques
49013+
type: object
49014+
SecurityEntityRiskScore:
49015+
description: An entity risk score containing security risk assessment information
49016+
properties:
49017+
attributes:
49018+
$ref: '#/components/schemas/SecurityEntityRiskScoreAttributes'
49019+
id:
49020+
description: Unique identifier for the entity
49021+
example: arn:aws:iam::123456789012:user/john.doe
49022+
type: string
49023+
type:
49024+
$ref: '#/components/schemas/SecurityEntityRiskScoreType'
49025+
required:
49026+
- id
49027+
- type
49028+
- attributes
49029+
type: object
49030+
SecurityEntityRiskScoreAttributes:
49031+
description: Attributes of an entity risk score
49032+
properties:
49033+
configRisks:
49034+
$ref: '#/components/schemas/SecurityEntityConfigRisks'
49035+
entityID:
49036+
description: Unique identifier for the entity
49037+
example: arn:aws:iam::123456789012:user/john.doe
49038+
type: string
49039+
entityMetadata:
49040+
$ref: '#/components/schemas/SecurityEntityMetadata'
49041+
entityName:
49042+
description: Human-readable name of the entity
49043+
example: john.doe
49044+
type: string
49045+
entityProviders:
49046+
description: Cloud providers associated with the entity
49047+
example:
49048+
- aws
49049+
items:
49050+
type: string
49051+
type: array
49052+
entityRoles:
49053+
description: Roles associated with the entity
49054+
example:
49055+
- Admin
49056+
- Developer
49057+
items:
49058+
type: string
49059+
type: array
49060+
entityType:
49061+
description: Type of the entity (e.g., aws_iam_user, aws_ec2_instance)
49062+
example: aws_iam_user
49063+
type: string
49064+
firstDetected:
49065+
description: Timestamp when the entity was first detected (Unix milliseconds)
49066+
example: 1704067200000
49067+
format: int64
49068+
type: integer
49069+
lastActivityTitle:
49070+
description: Title of the most recent signal detected for this entity
49071+
example: Suspicious API call detected
49072+
type: string
49073+
lastDetected:
49074+
description: Timestamp when the entity was last detected (Unix milliseconds)
49075+
example: 1705276800000
49076+
format: int64
49077+
type: integer
49078+
riskScore:
49079+
description: Current risk score for the entity
49080+
example: 85.5
49081+
format: double
49082+
type: number
49083+
riskScoreEvolution:
49084+
description: Change in risk score compared to previous period
49085+
example: 12.3
49086+
format: double
49087+
type: number
49088+
severity:
49089+
$ref: '#/components/schemas/SecurityEntityRiskScoreAttributesSeverity'
49090+
signalsDetected:
49091+
description: Number of security signals detected for this entity
49092+
example: 15
49093+
format: int64
49094+
type: integer
49095+
required:
49096+
- entityID
49097+
- entityType
49098+
- entityProviders
49099+
- riskScore
49100+
- riskScoreEvolution
49101+
- severity
49102+
- firstDetected
49103+
- lastDetected
49104+
- lastActivityTitle
49105+
- signalsDetected
49106+
- configRisks
49107+
- entityMetadata
49108+
type: object
49109+
SecurityEntityRiskScoreAttributesSeverity:
49110+
description: Severity level based on risk score
49111+
enum:
49112+
- critical
49113+
- high
49114+
- medium
49115+
- low
49116+
- info
49117+
example: critical
49118+
type: string
49119+
x-enum-varnames:
49120+
- CRITICAL
49121+
- HIGH
49122+
- MEDIUM
49123+
- LOW
49124+
- INFO
49125+
SecurityEntityRiskScoreType:
49126+
description: Resource type
49127+
enum:
49128+
- security_entity_risk_score
49129+
example: security_entity_risk_score
49130+
type: string
49131+
x-enum-varnames:
49132+
- SECURITY_ENTITY_RISK_SCORE
49133+
SecurityEntityRiskScoresMeta:
49134+
description: Metadata for pagination
49135+
properties:
49136+
pageNumber:
49137+
description: Current page number (1-indexed)
49138+
example: 1
49139+
format: int64
49140+
type: integer
49141+
pageSize:
49142+
description: Number of items per page
49143+
example: 10
49144+
format: int64
49145+
type: integer
49146+
queryId:
49147+
description: Query ID for pagination consistency
49148+
example: abc123def456
49149+
type: string
49150+
totalRowCount:
49151+
description: Total number of entities matching the query
49152+
example: 150
49153+
format: int64
49154+
type: integer
49155+
required:
49156+
- queryId
49157+
- totalRowCount
49158+
- pageSize
49159+
- pageNumber
49160+
type: object
49161+
SecurityEntityRiskScoresResponse:
49162+
description: Response containing a list of entity risk scores
49163+
properties:
49164+
data:
49165+
items:
49166+
$ref: '#/components/schemas/SecurityEntityRiskScore'
49167+
type: array
49168+
meta:
49169+
$ref: '#/components/schemas/SecurityEntityRiskScoresMeta'
49170+
required:
49171+
- data
49172+
- meta
49173+
type: object
4891749174
SecurityFilter:
4891849175
description: The security filter's properties.
4891949176
properties:
@@ -84052,6 +84309,124 @@ paths:
8405284309
x-codegen-request-body-name: body
8405384310
x-unstable: '**Note**: This endpoint is in public beta.
8405484311

84312+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
84313+
/api/v2/security-entities/risk-scores:
84314+
get:
84315+
description: Get a list of entity risk scores for your organization. Entity
84316+
risk scores provide security risk assessment for entities like cloud resources,
84317+
identities, or services based on detected signals, misconfigurations, and
84318+
identity risks.
84319+
operationId: ListEntityRiskScores
84320+
parameters:
84321+
- description: Start time for the query in Unix timestamp (milliseconds). Defaults
84322+
to 2 weeks ago.
84323+
in: query
84324+
name: from
84325+
required: false
84326+
schema:
84327+
example: 1704067200000
84328+
format: int64
84329+
type: integer
84330+
- description: End time for the query in Unix timestamp (milliseconds). Defaults
84331+
to now.
84332+
in: query
84333+
name: to
84334+
required: false
84335+
schema:
84336+
example: 1705276800000
84337+
format: int64
84338+
type: integer
84339+
- description: Size of the page to return. Maximum is 1000.
84340+
in: query
84341+
name: page[size]
84342+
required: false
84343+
schema:
84344+
default: 10
84345+
example: 10
84346+
type: integer
84347+
- description: Page number to return (1-indexed).
84348+
in: query
84349+
name: page[number]
84350+
required: false
84351+
schema:
84352+
default: 1
84353+
example: 1
84354+
type: integer
84355+
- description: Query ID for pagination consistency.
84356+
in: query
84357+
name: page[queryId]
84358+
required: false
84359+
schema:
84360+
example: abc123def456
84361+
type: string
84362+
- description: 'Sort order for results. Format: `field:direction` where direction
84363+
is `asc` or `desc`.
84364+
84365+
Supported fields: `riskScore`, `lastDetected`, `firstDetected`, `entityName`,
84366+
`signalsDetected`.'
84367+
in: query
84368+
name: filter[sort]
84369+
required: false
84370+
schema:
84371+
example: riskScore:desc
84372+
type: string
84373+
- description: 'Supports filtering by entity attributes, risk scores, severity,
84374+
and more.
84375+
84376+
Example: `severity:critical AND entityType:aws_iam_user`'
84377+
in: query
84378+
name: filter[query]
84379+
required: false
84380+
schema:
84381+
example: severity:critical
84382+
type: string
84383+
- description: Filter by entity type(s). Can specify multiple values.
84384+
explode: true
84385+
in: query
84386+
name: entityType
84387+
required: false
84388+
schema:
84389+
example:
84390+
- aws_iam_user
84391+
- aws_ec2_instance
84392+
items:
84393+
example: aws_iam_user
84394+
type: string
84395+
type: array
84396+
style: form
84397+
responses:
84398+
'200':
84399+
content:
84400+
application/json:
84401+
schema:
84402+
$ref: '#/components/schemas/SecurityEntityRiskScoresResponse'
84403+
description: OK
84404+
'400':
84405+
content:
84406+
application/json:
84407+
schema:
84408+
$ref: '#/components/schemas/JSONAPIErrorResponse'
84409+
description: Bad Request
84410+
'401':
84411+
content:
84412+
application/json:
84413+
schema:
84414+
$ref: '#/components/schemas/JSONAPIErrorResponse'
84415+
description: Unauthorized
84416+
'403':
84417+
content:
84418+
application/json:
84419+
schema:
84420+
$ref: '#/components/schemas/JSONAPIErrorResponse'
84421+
description: Forbidden
84422+
'429':
84423+
$ref: '#/components/responses/TooManyRequestsResponse'
84424+
summary: List Entity Risk Scores
84425+
tags:
84426+
- Entity Risk Scores
84427+
x-unstable: '**Note**: This endpoint is in public beta and it''s subject to
84428+
change.
84429+
8405584430
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8405684431
/api/v2/security/cloud_workload/policy/download:
8405784432
get:
@@ -93070,6 +93445,8 @@ tags:
9307093445

9307193446
end times, prevent all alerting related to specified Datadog tags.'
9307293447
name: Downtimes
93448+
- description: Retrieves security risk scores for entities in your organization.
93449+
name: Entity Risk Scores
9307393450
- description: View and manage issues within Error Tracking. See the [Error Tracking
9307493451
page](https://docs.datadoghq.com/error_tracking/) for more information.
9307593452
name: Error Tracking

0 commit comments

Comments
 (0)