Skip to content

[DOCS-12652] Note auto-added permissions on Create Role #3747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[DOCS-12652] Note auto-added permissions on Create Role #3747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 8 additions & 9 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112740,7 +112740,11 @@ paths:
permissions:
- user_access_read
post:
description: Create a new role for your organization.
description: >-
Create a new role for your organization.


**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.
operationId: CreateRole
requestBody:
content:
Expand Down Expand Up @@ -129945,15 +129949,10 @@ tags:
organize, find, and share all of your dashboards with your team and
organization.
name: Dashboard Lists
- description: |-
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.
- description: >-
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.

**Requirements:**
- **Embed** sharing must be enabled under **Organization Settings** > **Public Sharing** > **Shared Dashboards**.
- You need [an API key and an application key](https://docs.datadoghq.com/account_management/api-app-keys/) to interact with these endpoints.
**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.
name: Dashboard Secure Embed
- description: |-
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.
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/RolesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,11 @@ public CompletableFuture<RoleCreateResponse> createRoleAsync(RoleCreateRequest b
/**
* Create a new role for your organization.
*
* <p><strong>Note</strong>: 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.
*
* @param body (required)
* @return ApiResponse&lt;RoleCreateResponse&gt;
* @throws ApiException if fails to make API call
Expand Down
10 changes: 5 additions & 5 deletions src/test/resources/com/datadog/api/client/v2/api/dashboard_secure_embed.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Feature: Dashboard Secure Embed
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. **Requirements:** - **Embed**
sharing must be enabled under **Organization Settings** > **Public
Sharing** > **Shared Dashboards**. - You need [an API key and an
application key](https://docs.datadoghq.com/account_management/api-app-
keys/) to interact with these endpoints.
embeds provide programmatic access control. **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.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
Loading