Skip to content

Commit 53e031c

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit abca8f3 of spec repo
1 parent 6b433f2 commit 53e031c

4 files changed

Lines changed: 17 additions & 23 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112740,7 +112740,11 @@ paths:
112740112740
permissions:
112741112741
- user_access_read
112742112742
post:
112743-
description: Create a new role for your organization.
112743+
description: >-
112744+
Create a new role for your organization.
112745+
112746+
112747+
**Note**: When a role is created, the following permissions are automatically added, regardless of whether they are included in the request: Dashboards Read, Notebooks Read, Monitors Read, APM Read, Vulnerability Management Read, RUM Apps Read, Incidents Read, SLOs Read, CI Visibility Read, and CD Visibility Read.
112744112748
operationId: CreateRole
112745112749
requestBody:
112746112750
content:
@@ -129945,15 +129949,10 @@ tags:
129945129949
organize, find, and share all of your dashboards with your team and
129946129950
organization.
129947129951
name: Dashboard Lists
129948-
- description: |-
129949-
Manage securely embedded Datadog dashboards. Secure embeds use HMAC-SHA256 signed sessions
129950-
for authentication, enabling customers to embed dashboards in their own applications with
129951-
server-side auth control. Unlike public dashboards (open URL) or invite dashboards
129952-
(email-based access), secure embeds provide programmatic access control.
129952+
- description: >-
129953+
Manage securely embedded Datadog dashboards. Secure embeds use HMAC-SHA256 signed sessions for authentication, enabling customers to embed dashboards in their own applications with server-side auth control. Unlike public dashboards (open URL) or invite dashboards (email-based access), secure embeds provide programmatic access control.
129953129954

129954-
**Requirements:**
129955-
- **Embed** sharing must be enabled under **Organization Settings** > **Public Sharing** > **Shared Dashboards**.
129956-
- You need [an API key and an application key](https://docs.datadoghq.com/account_management/api-app-keys/) to interact with these endpoints.
129955+
**Requirements:** - Org setting: SharedDashboards > Embed sharing must be enabled. - AuthN: Datadog API key and application key. - Read operations require `dashboards_read` permission. - Write operations require `dashboards_embed_share` permission.
129957129956
name: Dashboard Secure Embed
129958129957
- description: |-
129959129958
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.

src/datadog_api_client/v2/api/dashboard_secure_embed_api.py

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,8 @@
1616

1717
class DashboardSecureEmbedApi:
1818
"""
19-
Manage securely embedded Datadog dashboards. Secure embeds use HMAC-SHA256 signed sessions
20-
for authentication, enabling customers to embed dashboards in their own applications with
21-
server-side auth control. Unlike public dashboards (open URL) or invite dashboards
22-
(email-based access), secure embeds provide programmatic access control.
23-
24-
**Requirements:**
25-
26-
* **Embed** sharing must be enabled under **Organization Settings** > **Public Sharing** > **Shared Dashboards**.
27-
* You need `an API key and an application key <https://docs.datadoghq.com/account_management/api-app-keys/>`_ to interact with these endpoints.
19+
Manage securely embedded Datadog dashboards. Secure embeds use HMAC-SHA256 signed sessions for authentication, enabling customers to embed dashboards in their own applications with server-side auth control. Unlike public dashboards (open URL) or invite dashboards (email-based access), secure embeds provide programmatic access control.
20+
**Requirements:** - Org setting: SharedDashboards > Embed sharing must be enabled. - AuthN: Datadog API key and application key. - Read operations require ``dashboards_read`` permission. - Write operations require ``dashboards_embed_share`` permission.
2821
"""
2922

3023
def __init__(self, api_client=None):

src/datadog_api_client/v2/api/roles_api.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -479,6 +479,8 @@ def create_role(
479479
480480
Create a new role for your organization.
481481
482+
**Note** : When a role is created, the following permissions are automatically added, regardless of whether they are included in the request: Dashboards Read, Notebooks Read, Monitors Read, APM Read, Vulnerability Management Read, RUM Apps Read, Incidents Read, SLOs Read, CI Visibility Read, and CD Visibility Read.
483+
482484
:type body: RoleCreateRequest
483485
:rtype: RoleCreateResponse
484486
"""

tests/v2/features/dashboard_secure_embed.feature

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Feature: Dashboard Secure Embed
44
signed sessions for authentication, enabling customers to embed dashboards
55
in their own applications with server-side auth control. Unlike public
66
dashboards (open URL) or invite dashboards (email-based access), secure
7-
embeds provide programmatic access control. **Requirements:** - **Embed**
8-
sharing must be enabled under **Organization Settings** > **Public
9-
Sharing** > **Shared Dashboards**. - You need [an API key and an
10-
application key](https://docs.datadoghq.com/account_management/api-app-
11-
keys/) to interact with these endpoints.
7+
embeds provide programmatic access control. **Requirements:** - Org
8+
setting: SharedDashboards > Embed sharing must be enabled. - AuthN:
9+
Datadog API key and application key. - Read operations require
10+
`dashboards_read` permission. - Write operations require
11+
`dashboards_embed_share` permission.
1212

1313
Background:
1414
Given a valid "apiKeyAuth" key in the system

0 commit comments

Comments
 (0)