Skip to content

Commit e7aace5

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit d70d778 of spec repo
1 parent 8e84a09 commit e7aace5

20 files changed

Lines changed: 2077 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 281 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21475,6 +21475,162 @@ components:
2147521475
data:
2147621476
$ref: "#/components/schemas/DatasetResponse"
2147721477
type: object
21478+
DatasetRestrictionOwnershipMode:
21479+
description: |-
21480+
Controls how dataset ownership is determined. `disabled` turns off ownership-based access
21481+
entirely. `team_tag_based` assigns dataset ownership based on the team tags applied to the
21482+
data, allowing team members to see their own team's datasets.
21483+
enum:
21484+
- disabled
21485+
- team_tag_based
21486+
example: "team_tag_based"
21487+
type: string
21488+
x-enum-varnames:
21489+
- DISABLED
21490+
- TEAM_TAG_BASED
21491+
DatasetRestrictionPrincipal:
21492+
description: |-
21493+
A user or role that is exempt from dataset restrictions and retains unrestricted
21494+
access to all datasets for the product type.
21495+
properties:
21496+
id:
21497+
description: The unique identifier of the principal (a user UUID or role ID).
21498+
example: "abc123"
21499+
type: string
21500+
name:
21501+
description: The human-readable display name of the principal as shown in the Datadog UI.
21502+
example: "Datadog Admin Role"
21503+
type: string
21504+
type:
21505+
description: |-
21506+
The kind of principal, such as `user` for an individual user account or `role`
21507+
for a Datadog role.
21508+
example: "role"
21509+
type: string
21510+
required:
21511+
- type
21512+
- id
21513+
- name
21514+
type: object
21515+
DatasetRestrictionResponse:
21516+
description: Response containing the updated dataset restriction.
21517+
properties:
21518+
data:
21519+
$ref: "#/components/schemas/DatasetRestrictionResponseData"
21520+
required:
21521+
- data
21522+
type: object
21523+
DatasetRestrictionResponseAttributes:
21524+
description: |-
21525+
The current configuration of a dataset restriction, including restriction mode,
21526+
ownership mode, and exempt principals.
21527+
properties:
21528+
ownership_mode:
21529+
$ref: "#/components/schemas/DatasetRestrictionOwnershipMode"
21530+
restriction_key:
21531+
description: Internal key used by the restriction enforcement system to identify this restriction rule.
21532+
type: string
21533+
restriction_mode:
21534+
$ref: "#/components/schemas/DatasetRestrictionRestrictionMode"
21535+
unrestricted_principals:
21536+
description: |-
21537+
Principals (users or roles) that are exempt from this restriction and retain
21538+
full data access regardless of the restriction mode.
21539+
items:
21540+
$ref: "#/components/schemas/DatasetRestrictionPrincipal"
21541+
type: array
21542+
required:
21543+
- restriction_mode
21544+
type: object
21545+
DatasetRestrictionResponseData:
21546+
description: A single dataset restriction configuration for one product type.
21547+
properties:
21548+
attributes:
21549+
$ref: "#/components/schemas/DatasetRestrictionResponseAttributes"
21550+
id:
21551+
description: The Datadog product type this restriction applies to (for example, `rum`, `apm`, or `logs`).
21552+
example: "rum"
21553+
type: string
21554+
type:
21555+
$ref: "#/components/schemas/DatasetRestrictionsType"
21556+
required:
21557+
- type
21558+
- id
21559+
- attributes
21560+
type: object
21561+
DatasetRestrictionRestrictionMode:
21562+
description: |-
21563+
Controls the default data visibility for the product type. `standard` makes data visible
21564+
to all users with appropriate product access. `default_hide` hides data by default and
21565+
requires explicit grants for each dataset.
21566+
enum:
21567+
- standard
21568+
- default_hide
21569+
example: "default_hide"
21570+
type: string
21571+
x-enum-varnames:
21572+
- STANDARD
21573+
- DEFAULT_HIDE
21574+
DatasetRestrictionUpdateRequest:
21575+
description: Payload for updating a dataset restriction configuration.
21576+
properties:
21577+
data:
21578+
$ref: "#/components/schemas/DatasetRestrictionUpdateRequestData"
21579+
required:
21580+
- data
21581+
type: object
21582+
DatasetRestrictionUpdateRequestAttributes:
21583+
description: |-
21584+
Editable attributes of a dataset restriction. Only `restriction_mode` is required;
21585+
omitted optional fields retain their current values.
21586+
properties:
21587+
ownership_mode:
21588+
$ref: "#/components/schemas/DatasetRestrictionOwnershipMode"
21589+
restriction_mode:
21590+
$ref: "#/components/schemas/DatasetRestrictionRestrictionMode"
21591+
unrestricted_principals:
21592+
description: |-
21593+
Principal identifiers (users or roles) that are exempt from the restriction and
21594+
can always access all datasets for this product type.
21595+
items:
21596+
description: A unique identifier of a user or role principal.
21597+
type: string
21598+
type: array
21599+
required:
21600+
- restriction_mode
21601+
type: object
21602+
DatasetRestrictionUpdateRequestData:
21603+
description: Data object for a dataset restriction update.
21604+
properties:
21605+
attributes:
21606+
$ref: "#/components/schemas/DatasetRestrictionUpdateRequestAttributes"
21607+
type:
21608+
$ref: "#/components/schemas/DatasetRestrictionsType"
21609+
required:
21610+
- type
21611+
- attributes
21612+
type: object
21613+
DatasetRestrictionsListResponse:
21614+
description: |-
21615+
Response containing the list of all dataset restriction configurations for the
21616+
organization, one per product type.
21617+
properties:
21618+
data:
21619+
description: An array of dataset restriction objects, one for each configured product type.
21620+
items:
21621+
$ref: "#/components/schemas/DatasetRestrictionResponseData"
21622+
type: array
21623+
required:
21624+
- data
21625+
type: object
21626+
DatasetRestrictionsType:
21627+
description: JSON:API resource type for dataset restrictions.
21628+
enum:
21629+
- dataset_restrictions
21630+
example: "dataset_restrictions"
21631+
type: string
21632+
x-enum-varnames:
21633+
- DATASET_RESTRICTIONS
2147821634
DatasetType:
2147921635
default: dataset
2148021636
description: Resource type, always set to `dataset`.
@@ -97293,6 +97449,126 @@ paths:
9729397449
x-unstable: |-
9729497450
**Note**: This endpoint is in preview and is subject to change.
9729597451
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
97452+
/api/v2/dataset_restrictions:
97453+
get:
97454+
description: |-
97455+
Retrieve all dataset restriction configurations for the organization.
97456+
Returns one restriction object per configured product type (for example, RUM, APM, or Logs),
97457+
including the current restriction mode, ownership mode, and any unrestricted principals.
97458+
Requires the `user_access_read` permission.
97459+
operationId: ListDatasetRestrictions
97460+
responses:
97461+
"200":
97462+
content:
97463+
application/json:
97464+
examples:
97465+
default:
97466+
value:
97467+
data:
97468+
- attributes:
97469+
restriction_mode: "standard"
97470+
id: "rum"
97471+
type: "dataset_restrictions"
97472+
- attributes:
97473+
ownership_mode: "team_tag_based"
97474+
restriction_mode: "default_hide"
97475+
id: "apm"
97476+
type: "dataset_restrictions"
97477+
schema:
97478+
$ref: "#/components/schemas/DatasetRestrictionsListResponse"
97479+
description: OK
97480+
"403":
97481+
content:
97482+
application/json:
97483+
schema:
97484+
$ref: "#/components/schemas/JSONAPIErrorResponse"
97485+
description: Forbidden
97486+
"404":
97487+
content:
97488+
application/json:
97489+
schema:
97490+
$ref: "#/components/schemas/JSONAPIErrorResponse"
97491+
description: Not Found
97492+
"429":
97493+
$ref: "#/components/responses/TooManyRequestsResponse"
97494+
summary: List dataset restrictions
97495+
tags:
97496+
- Dataset Restrictions
97497+
x-unstable: |-
97498+
**Note**: This endpoint is in preview and is subject to change.
97499+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
97500+
/api/v2/dataset_restrictions/{product_type}:
97501+
post:
97502+
description: |-
97503+
Update the dataset restriction configuration for a specific product type.
97504+
Sets the restriction mode, optional ownership mode, and the list of principals
97505+
that are exempt from restrictions. Requires the `user_access_manage` permission.
97506+
Changes are audited and take effect immediately.
97507+
operationId: UpdateDatasetRestriction
97508+
parameters:
97509+
- description: The Datadog product type to configure restrictions for (for example, `rum`, `apm`, or `logs`).
97510+
example: "rum"
97511+
in: path
97512+
name: product_type
97513+
required: true
97514+
schema:
97515+
type: string
97516+
requestBody:
97517+
content:
97518+
application/json:
97519+
examples:
97520+
default:
97521+
value:
97522+
data:
97523+
attributes:
97524+
ownership_mode: "team_tag_based"
97525+
restriction_mode: "default_hide"
97526+
type: "dataset_restrictions"
97527+
schema:
97528+
$ref: "#/components/schemas/DatasetRestrictionUpdateRequest"
97529+
required: true
97530+
responses:
97531+
"200":
97532+
content:
97533+
application/json:
97534+
examples:
97535+
default:
97536+
value:
97537+
data:
97538+
attributes:
97539+
ownership_mode: "team_tag_based"
97540+
restriction_mode: "default_hide"
97541+
id: "rum"
97542+
type: "dataset_restrictions"
97543+
schema:
97544+
$ref: "#/components/schemas/DatasetRestrictionResponse"
97545+
description: OK
97546+
"400":
97547+
content:
97548+
application/json:
97549+
schema:
97550+
$ref: "#/components/schemas/JSONAPIErrorResponse"
97551+
description: Bad Request
97552+
"403":
97553+
content:
97554+
application/json:
97555+
schema:
97556+
$ref: "#/components/schemas/JSONAPIErrorResponse"
97557+
description: Forbidden
97558+
"404":
97559+
content:
97560+
application/json:
97561+
schema:
97562+
$ref: "#/components/schemas/JSONAPIErrorResponse"
97563+
description: Not Found
97564+
"429":
97565+
$ref: "#/components/responses/TooManyRequestsResponse"
97566+
summary: Update a dataset restriction
97567+
tags:
97568+
- Dataset Restrictions
97569+
x-unstable: |-
97570+
**Note**: This endpoint is in preview and is subject to change.
97571+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
9729697572
/api/v2/datasets:
9729797573
get:
9729897574
description: Get all datasets that have been configured for an organization.
@@ -145632,6 +145908,11 @@ tags:
145632145908
- description: |-
145633145909
The Data Deletion API allows the user to target and delete data from the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data` and `rum_delete_data` permissions respectively.
145634145910
name: Data Deletion
145911+
- description: |-
145912+
Configure dataset-level access restrictions per Datadog product type. Dataset restrictions
145913+
control whether data is visible by default or hidden until explicitly granted, and how
145914+
ownership-based access is determined.
145915+
name: Dataset Restrictions
145635145916
- description: |-
145636145917
Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate
145637145918
access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can

api/datadog/configuration.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -762,6 +762,8 @@ func NewConfiguration() *Configuration {
762762
"v2.DeleteDashboardSecureEmbed": false,
763763
"v2.GetDashboardSecureEmbed": false,
764764
"v2.UpdateDashboardSecureEmbed": false,
765+
"v2.ListDatasetRestrictions": false,
766+
"v2.UpdateDatasetRestriction": false,
765767
"v2.CreateDataset": false,
766768
"v2.DeleteDataset": false,
767769
"v2.GetAllDatasets": false,

0 commit comments

Comments
 (0)